From 6ff18167daa196d5fdf208d03481c3d68081c6da Mon Sep 17 00:00:00 2001 From: Michael Wedl Date: Mon, 25 Nov 2024 15:16:34 +0100 Subject: [PATCH] Update docs dependencies --- docs/docs/insights/vulnerabilities.md | 2 +- docs/docs/setup/webserver.md | 2 +- docs/mkdocs.yml | 9 ++++++--- docs/requirements.txt | 10 +++++----- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/docs/insights/vulnerabilities.md b/docs/docs/insights/vulnerabilities.md index 7cec7c55c..e5f1d3d29 100644 --- a/docs/docs/insights/vulnerabilities.md +++ b/docs/docs/insights/vulnerabilities.md @@ -14,7 +14,7 @@ Find more information in our [advisory](https://github.com/Syslifters/sysreptor/ **CVSSv3.1:** High (7.8; CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:H/A:H) **Fixed in 2024.29** (on 17 April 2024) -**Workaround:** Use a reverse proxy (like [Caddy](../setup/webserver.md#caddy-recommended) or [nginx](../setup/webserver.md#nginx)). +**Workaround:** Use a reverse proxy (like [Caddy](../setup/webserver.md#caddy) or [nginx](../setup/webserver.md#nginx)). If you don't use a reverse proxy (like Caddy or nginx) for SysReptor and expose the SysReptor port (TCP 8000 by default) directly, you are probably vulnerable to HTTP Request Smuggling attacks. diff --git a/docs/docs/setup/webserver.md b/docs/docs/setup/webserver.md index 34d94e815..d5747334d 100644 --- a/docs/docs/setup/webserver.md +++ b/docs/docs/setup/webserver.md @@ -5,7 +5,7 @@ The Django webserver is not recommended due to missing transport encryption, missing performance and security tests. We recommend a webserver like Caddy, nginx or Apache and to enable https. -## Easy setup with Caddy (recommended) +## Easy setup with Caddy (recommended) {#caddy} You can run `setup.sh` in `deploy/caddy` to set up an additional Docker container with Caddy as a webserver. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c4c6d5d7e..3cb2569c6 100755 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -119,7 +119,6 @@ plugins: - social: enabled: !ENV [CI, false] cards: !ENV [CI, false] - cards_font: "Noto Sans" cards_layout_options: background_color: "#818b06" color: "#FFFFFF" @@ -149,8 +148,8 @@ markdown_extensions: - attr_list - pymdownx.details - pymdownx.emoji: - emoji_generator: !!python/name:materialx.emoji.to_svg - emoji_index: !!python/name:materialx.emoji.twemoji + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.magiclink - pymdownx.highlight: use_pygments: true @@ -181,4 +180,8 @@ extra: link: https://at.linkedin.com/showcase/sysreptor generator: false +validation: + links: + absolute_links: relative_to_docs + copyright: 'Our Website | Third Party Software | Imprint | Data Privacy | Contact

The FFG is the central national funding organization and strengthens Austria''s innovative power.
This project is funded by the FFG.
' diff --git a/docs/requirements.txt b/docs/requirements.txt index 0cf8a1543..66c9778d2 100755 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,10 +1,10 @@ -mkdocs==1.5.3 -git+https://${MKDOCS_MATERIAL_GIT_USERNAME}:${MKDOCS_MATERIAL_GIT_TOKEN}@gitlab.internal.syslifters.com/docs/mkdocs-material-insiders.git@9.5.17-insiders-4.53.6#egg=mkdocs-material -mkdocs-jupyter==0.24.6 +mkdocs==1.6.1 +git+https://${MKDOCS_MATERIAL_GIT_USERNAME}:${MKDOCS_MATERIAL_GIT_TOKEN}@gitlab.internal.syslifters.com/docs/mkdocs-material-insiders.git@9.5.46-insiders-4.53.14#egg=mkdocs-material +mkdocs-jupyter==0.25.1 mkdocs-simple-hooks==0.1.5 mkdocs-tooltips==0.1.0 -mkdocs-redirects==1.2.1 -pymdown-extensions==10.7.1 +mkdocs-redirects==1.2.2 +pymdown-extensions==10.12 pillow>=10.2.0 cairosvg==2.7.1 requests>=2.31.0