Branding

Die Weboberfläche des Audiominer kann leicht an das Look-and-Feel der jeweiligen Organisation angepasst werden.

Bei der Weboberfläche handelt es sich um eine statische Seite, die mit dem web-service Backend über Websocket und REST kommuniziert.

Die Textbestandteile der Hauptseite können über eine angepasste config.json Datei den notwendigen Bedürfnissen angepasst werden. Zusätzlich benötigte Seiten können als HTML zusätzlich angebunden werden (z. B. Datenschutz und/oder Impressum).

Übersteuern im Docker Image

Im web-service Docker Image liegt die statische UI unter /app/ui.

Ersetzen Sie die config.json durch Ihre eigenen Daten und/oder fügen Sie bei Bedarf zusätzliche HTML-Seiten hinzu.

Zusätzliche Seiten

Falls zusätzliche Seiten benötigt werden, können diese als HTML-Dateien im Ordner /app/ui/pages/ gespeichert werden. Die Dateien müssen mit dem Namen der Seite (z. B. datenschutz.html) benannt werden und in der config.json unter pages angegeben werden.

  ...

  web-service:
    image: ${REGISTRY:-}audiominer/web-service:${TAG:-dev}-${ARCH:-amd64}
    restart: no
    volumes:
      - type: bind
        source: /audiominer/web-service/data
        target: /data
      - ./web-service.default.yml:/app/web-service.default.yml
      # Übersteuern der config.json Datei
      - ./config.custom.json:/app/ui/config.json
      # Übersteuern der HTML Seiten
      - ./pages:/app/ui/pages
    links:
      - db

  ...

Beispiel der config.json

{
  "label": "Audiominer", 
  "logo_url": "BPA_2017_WebSVG_de.svg",
  "copyright": "Presse- und Informationsamt der Bundesregierung",
  "transcribe_info": "Laden Sie hier Ihre Datei hoch. Die Verarbeitungsdauer ist abhängig von der Dateigröße und der Größe der Warteschlange (gelbe Uhr).",
  "mail_placeholder": "ihr-name@bpa.bund.de",
  "mail_domain_check": "bpa.bund.de",
  "mail_help_txt": "Falls Sie Ihre Transkription per E-Mail erhalten möchten, tragen Sie hier eine BPA-E-Mailadresse ein.",
  "pages": [
    {
      "label": "ANLEITUNG",
      "path": "anleitung",
      "file": "Anleitung"
    }
  ]
}

Erläuterung der Felder

Feld	Beschreibung
label	Der Name der Anwendung, der in der Kopfzeile angezeigt wird.
logo_url	Dateiname oder URL des Logos (sollte im Image unter /app/ui/ liegen oder als vollständige URL erreichbar sein).
copyright	Copyright-Hinweis in der Fußzeile.
transcribe_info	Infotext, der auf der Upload-Seite angezeigt wird.
mail_placeholder	Beispiel-E-Mail-Adresse, die im E-Mail-Feld als Platzhalter angezeigt wird.
mail_domain_check	Erlaubte E-Mail-Domain für den Versand von Transkriptionen (Validierung).
mail_help_txt	Hilfetext unter dem E-Mail-Eingabefeld.
pages	Liste von zusätzlichen HTML-Seiten.
pages[].label	Name der Seite im Menü.
pages[].path	URL-Pfad für die Seite (z.B. /anleitung).
pages[].file	Dateiname der HTML-Datei (ohne Endung) im Ordner /app/ui/pages/.