diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 8b731b6f..ba136aac 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -20,5 +20,5 @@ jobs: run: "python3 -m pip install -r requirements.txt" working-directory: "docs" - name: "Build documentation" - run: "zensical build --clean" + run: "zensical build --clean --strict" # strict exits with code 1 if there are any warnings working-directory: "docs" diff --git a/docs/README.md b/docs/README.md index ba869c23..e8835f7b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ ## turnierplan.NET · Documentation -This directory contains the turnierplan.NET documentation. The content files use an extended markdown format and are build into static HTML using [zensical](https://zensical.org). The documentation is hosted at [docs.turnierplan.net](https://docs.turnierplan.net). +This directory contains the turnierplan.NET documentation. The content files use an extended Markdown format and are build into static HTML using [zensical](https://zensical.org). The documentation is hosted at [docs.turnierplan.net](https://docs.turnierplan.net). In order to build the documentation locally, you must first install Python and `zensical`: @@ -8,7 +8,7 @@ In order to build the documentation locally, you must first install Python and ` pip install -r requirements.txt ``` -Next, you can either view the rendered documentation using the zensical built-in server or you can generate the static website files: +Next, you can either view the rendered documentation using the Zensical built-in server or you can generate the static website files: ``` python3 -m zensical serve # starts a local web server on port 8000 diff --git a/docs/pages/installation/docker-compose.md b/docs/pages/installation/docker-compose.md index d38d533c..a8a87dbb 100644 --- a/docs/pages/installation/docker-compose.md +++ b/docs/pages/installation/docker-compose.md @@ -80,7 +80,7 @@ Nachfolgend beschrieben sind Fehler, welche bei einer Neuinstallation auftreten ### Verbindung per HTTP -Beim Zugriff auf einen nicht-lokalen turnierplan.NET-Server via HTTP sollte standardmäßig ein Fehler *401 Unauthorized* erscheinen. Dies liegt daran, dass turnierplan.NET für die Authentifizierung nach dem Login Cookies verwendet, welche standardmäßig als *secure* ausgestellt werden. Dies hat zur Folge, dass Browser den Cookie nur bei lokalen Verbindungen oder über HTTPS mitschicken. Um turnierplan.NET dennoch verwenden zu können, muss die `Identity__UseInsecureCookies` auf `true` gesetzt werden. Siehe auch [Konfiguration der Authentifizierung](configuration.md#authentifizierung). +Beim Zugriff auf einen nicht-lokalen turnierplan.NET-Server via HTTP sollte standardmäßig ein Fehler *401 Unauthorized* erscheinen. Dies liegt daran, dass turnierplan.NET für die Authentifizierung nach dem Login Cookies verwendet, welche standardmäßig als *secure* ausgestellt werden. Dies hat zur Folge, dass Browser den Cookie nur bei lokalen Verbindungen oder über HTTPS mitschicken. Um turnierplan.NET dennoch verwenden zu können, muss die `Identity__UseInsecureCookies` auf `true` gesetzt werden. Siehe auch [Konfiguration der Authentifizierung](../configuration/index.md#authentifizierung). !!! warning Die Verwendung von HTTP-Verbindungen über das Internet ist **absolut nicht empfohlen**, da persönliche Daten und Passwörter somit unverschlüsselt übertragen werden würden. Zudem ist nicht ausgeschlossen, dass Teile der Webanwendung nicht korrekt funktionieren, falls diese HTTPS-exklusive Browser-APIs verwenden (bspw. Zwischenablage oder *crypto*). diff --git a/docs/requirements.txt b/docs/requirements.txt index 4a51f3fd..7d592798 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -zensical==0.0.33 +zensical==0.0.60