Skip to content

Dokumentation ​

Quickstart ​

  1. Gehe zum Dashboard
  2. Logge dich mit deinem HTWK Login an
  3. Erstelle ein neues Projekt
  4. Lade deine Dateien hoch
  5. Dein Projekt ist jetzt sichtbar unter /<Login Kürzel>/<Projektname>/
  • Jedes Projekt folgt der /<Login Kürzel>/<Projektname>/ Struktur
  • Du kannst unendlich viele Projekte erstellen, solange der gesamte benötigte Speicherplatz deiner Projekte unter der 1GB Grenze bleibt

ACHTUNG

Es besteht kein Anspruch auf das Hosting. Es findet keine Datensicherung statt.
Einzelne Seiten oder der gesamte Service können jederzeit offline genommen werden.

Projekt erstellen ​

Im Projektnamen sind folgende Zeichen erlaubt:

  • a-z (nur Kleinbuchstaben)
  • 0-9
  • - und _

Leerzeichen werden automatisch zu _ konvertiert. Großbuchstaben werden automatisch zu Kleinbuchstaben konvertiert.

API Token verwalten ​

  • Jeder API Token ist einem Projekt zugeordnet und kann nur für dieses Projekt verwendet werden
  • Ein Projekt kann viele API Token haben
  • API Token können automatisch ablaufen oder für immer gültig sein
    • Den Token zu rotieren ändert nichts am Ablaufdatum
  • API Token können nur für den Dateiupload verwendet werden. Alle anderen Aktionen müssen über das Web UI vorgenommen werden.

API Zugang ​

Die API kann genutzt werden, um eine oder mehrere Dateien hochzuladen. Es wird eine multipart Datenstruktur erwartet.

Um die Datei helloworld.txt im Projekt beispielprojekt hochzuladen (bspw. in der CI):

sh
curl -X PUT "https://dashboard.pages.fsr.imn.htwk-leipzig.de/api/beispielprojekt/upload" \
  -H "Authorization: api-key <api-token>" \
  -F "file=@./helloworld.txt;filename=helloworld.txt"
ts
const file = new File(); // your file
const formData = new FormData();
formData.append('file', file, 'helloworld.txt'); // path where your file should be saved

await fetch(`https://dashboard.pages.fsr.imn.htwk-leipzig.de/api/beispielprojekt/upload`, {
  method: 'PUT',
  header: {
    Authorization: "api-key <api-token>"
  }
  body: formData,
});

Der filename der multipart Struktur kann verwendet werden, um einen relativen Pfad (inklusive Dateiname) anzugeben, unter dem die Datei gespeichert werden soll. Dieser Pfad wird automatisch basierend auf der /userId/projectName/ URL-Struktur berechnet.