Files
event-audio-recorder/README.md
T

64 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Branding und Farbschema
Die Web-UIs können ohne eigenes Docker-Image an eine Veranstaltung oder Organisation angepasst werden.
## Umgebungsvariablen
```yaml
environment:
SITE_NAME: "Meine Veranstaltung"
SITE_SUBTITLE: "Vorträge und Aufzeichnungen"
PAGE_TITLE: "Meine Veranstaltung – Aufnahmen"
PAGE_HEADING: "Meine Veranstaltung – Aufnahmen"
THEME_FILE: "/config/theme.json"
LOGO_FILE: "/config/logo.svg"
FAVICON_FILE: "/config/favicon.svg"
```
Beim Editor stehen zusätzlich zur Verfügung:
```yaml
EDIT_PAGE_TITLE: "Meine Veranstaltung – Aufnahme bearbeiten"
EDIT_PAGE_HEADING: "Aufnahme bearbeiten"
```
`LOGO_FILE` und `FAVICON_FILE` sind optional. Werden sie nicht gesetzt, werden weder Logo noch Favicon eingeblendet.
## Theme
`theme.json.example` kann nach `theme.json` kopiert und angepasst werden. Die Farben sind semantisch benannt; dadurch muss die Anwendung selbst nicht geändert werden, wenn das Farbschema angepasst wird.
Beispiel:
```json
{
"colors": {
"background": "#111",
"surface": "#181818",
"surface_alt": "#222",
"text": "#eee",
"text_secondary": "#ccc",
"text_muted": "#aaa",
"primary": "#1769aa",
"primary_hover": "#1f7fc2",
"accent": "#ffcc33",
"success": "#173d24",
"warning": "#6b4e00",
"danger": "#8b0000"
}
}
```
Nicht angegebene Farben verwenden automatisch die eingebauten Standardwerte.
## Docker
Die Konfiguration sollte als read-only Verzeichnis eingebunden werden:
```yaml
volumes:
- /opt/event-audio-recorder/config:/config:ro
```
Das gleiche Konfigurationsverzeichnis kann für Recorder und Editor verwendet werden.