Skip to content

Commit

Permalink
Merge branch 'update-docs' into 'main'
Browse files Browse the repository at this point in the history
Update docs dependencies

See merge request reportcreator/reportcreator!777
  • Loading branch information
MWedl committed Nov 26, 2024
2 parents c7866df + 6ff1816 commit 82a7072
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/docs/insights/vulnerabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/setup/webserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
9 changes: 6 additions & 3 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ plugins:
- social:
enabled: !ENV [CI, false]
cards: !ENV [CI, false]
cards_font: "Noto Sans"
cards_layout_options:
background_color: "#818b06"
color: "#FFFFFF"
Expand Down Expand Up @@ -150,8 +149,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
Expand Down Expand Up @@ -182,4 +181,8 @@ extra:
link: https://at.linkedin.com/showcase/sysreptor
generator: false

validation:
links:
absolute_links: relative_to_docs

copyright: '<a href="https://www.syslifters.com/" target="_blank">Our Website</a> | <a href="/notice">Third Party Software</a> | <a href="https://www.syslifters.com/impressum" target="_blank">Imprint</a> | <a href="/data-privacy">Data Privacy</a> | <a href="/contact-us" target="blank">Contact</a><br><br>The FFG is the central national funding organization and strengthens Austria''s innovative power.<br>This project is funded by the <a href="https://www.ffg.at" target="_blank">FFG</a>.<br>'
10 changes: 5 additions & 5 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
mkdocs==1.5.3
git+https://${MKDOCS_MATERIAL_GIT_USERNAME}:${MKDOCS_MATERIAL_GIT_TOKEN}@gitlab.internal.syslifters.com/docs/[email protected].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/[email protected].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
Expand Down

0 comments on commit 82a7072

Please sign in to comment.