Setup, Struktur, Kommandos und SigV4-Kram kurz dokumentiert, damit nicht jeder wieder von vorne den Code durchwühlen muss.
5.1 KiB
r9t Frontend
Web-UI für unseren S3-kompatiblen Object Storage (r9t). Rein clientseitiges Nuxt/Vue-Frontend, das Buckets und Objekte auflistet, Objekte anzeigt/hochlädt/löscht und dafür Requests direkt per AWS SigV4 signiert.
Tech-Stack
- Nuxt 4 (Vue 3, TypeScript)
- Tailwind CSS 4 (via
@tailwindcss/vite) - Kein State-Management-Framework, kein Backend-Code hier — nur UI + ein schlanker S3-Client
Setup
Voraussetzung: Node.js (siehe Dockerfile, dort läuft node:22.9.0-alpine).
npm install
.env aus der Vorlage anlegen:
cp .env.example .env
Relevante Variablen (siehe nuxt.config.ts → runtimeConfig.public):
| Variable | Zweck | Default (Beispiel) |
|---|---|---|
NUXT_PUBLIC_S3_ACCESS_KEY |
Access Key für SigV4-Signierung der Requests | devkey |
NUXT_PUBLIC_S3_SECRET_KEY |
Secret Key für SigV4-Signierung | devsecret |
Wichtig: Diese Keys landen im Public Runtime Config, sind also im Client-Bundle sichtbar. Für den Dev-Betrieb gegen einen lokalen/Test-Storage okay, für produktive Zugangsdaten nicht geeignet — das müsste über einen Backend-Proxy laufen, der Requests serverseitig signiert.
Entwicklung
npm run dev
Läuft auf http://localhost:3000. Requests an /api/* werden per Vite-Dev-Proxy (siehe nuxt.config.ts) an http://localhost:8080 weitergeleitet und dort landet der eigentliche S3-Server. Heißt: Für lokale Entwicklung muss der Storage-Server separat auf Port 8080 laufen.
Build & Produktion
npm run build # Produktions-Build (.output/)
npm run preview # lokal den Produktions-Build testen
npm run generate # statischer Export, falls mal gebraucht
Docker
docker build --build-arg VERSION=<version> -t r9t-frontend .
docker run -p 3000:3000 r9t-frontend
Das Dockerfile baut mit npx nuxi build und startet den Nitro-Server via node .output/server/index.mjs.
CI/CD
Jenkinsfile baut das Image, pusht es nach harbor.dinauer.dev/r9t/frontend:<BUILD_NUMBER> und räumt danach den lokalen Build-Agent wieder auf. Kein automatischer Deploy-Schritt enthalten — Image landet nur in der Registry.
Projektstruktur
app/
├── app.vue # Root-Komponente, App-Layout, State-Orchestrierung
├── assets/css/main.css # Tailwind-Einstieg
├── components/
│ ├── BucketList.vue # Sidebar mit Bucket-Auswahl
│ ├── ObjectTable.vue # Objektliste im gewählten Bucket
│ ├── ObjectDetail.vue # Detail-/Aktions-Panel für ein Objekt
│ ├── PathBreadcrumb.vue
│ ├── SortHeader.vue
│ ├── ChunkBar.vue
│ ├── CopyField.vue
│ ├── FieldLabel.vue
│ ├── FileTypeBadge.vue
│ ├── AppToast.vue # Toast-Benachrichtigungen
│ └── popup/
│ ├── PopupSlot.vue # Rendert die aktuell offene Popup-Instanz
│ ├── ConfirmPopup.vue
│ ├── UploadPopup.vue
│ └── TextPreviewPopup.vue
├── composables/
│ ├── useS3Client.ts # High-Level S3-Operationen (list/get/put/delete)
│ └── usePopup.ts # Globaler Popup-Store
└── utils/
├── sigv4.ts # AWS SigV4 Request-Signierung (browserseitig, WebCrypto)
├── s3xml.ts # Parsen der S3 List-XML-Responses
├── popup.ts # Popup-Klasse/Config-Typen
└── format.ts # Formatierungs-Helper (Größen, Daten, o.ä.)
Sonstige relevante Dateien:
nuxt.config.ts— Runtime-Config, Tailwind-Plugin, Dev-Proxy nach/apiDockerfile— Produktions-ImageJenkinsfile— Build-Pipeline (Image bauen + nach Harbor pushen).env.example— Vorlage für lokale Env-Variablen
Funktionsweise (Kurzfassung)
app.vuelädt beim Mount die Bucket-Liste (useS3Client().listBuckets()).- Bei Bucket-Auswahl werden die Objekte geladen (
listObjects), gefiltert per Suchfeld (Client-seitig, kein Server-Filter). - Jeder Request wird vorher in
sigv4.tsper AWS4-HMAC-SHA256 signiert (Access/Secret Key aus der Runtime-Config) und läuft über den/api-Proxy zum eigentlichen S3-Server. - Objekt-Aktionen (Download, Upload, Löschen, Text-Vorschau) laufen über Popups (
usePopup/PopupSlot), die dynamisch eine Vue-Komponente rendern. - Bucket-Erstellung ist aktuell nur gemockt (
mockActioninapp.vue) — das UI unterstützt bislang keinen echten Bucket-Create/Delete.
Bekannte Einschränkungen
- Keine Authentifizierung im UI selbst — Access/Secret Key liegen statisch in der Config.
- Kein serverseitiger Proxy für die Signierung, SigV4 läuft komplett im Browser.
- Bucket-Erstellung ist nicht implementiert, nur ein Platzhalter-Toast.
- Kein automatisierter Test-Runner im Repo vorhanden (kein
test-Script inpackage.json).