mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-12-24 07:27:30 +01:00
1652633d93
* Enable the 'admonitions' Markdown extension for Mkdocs.
The admonitions extension to Python-Markdown allows you to include
rST-style "admonitions" to Markdown documents, for instance,
!!! note
Here's an important note to keep in mind!
In general, the current documentation uses bold text to try to achieve
the same effect, which is a bit harder to notice and makes it difficult
to differentiate between "here's something useful to know" versus "here
there be dragons".
* Add AppArmor profile and documentation for LSM-related sandboxing
This commit adds an AppArmor profile for gotosocial in
examples/apparmor/gotosocial. This will (hopefully) serve as a helpful
security mitigation for people are planning on deploying GTS on a
Debian-family Linux distribution.
I've also updates the documentation to include some information about
deploying GTS with either AppArmor or SELinux (moving the documentation
for the former out of the "binary installation guide" docs).
64 lines
1.8 KiB
YAML
64 lines
1.8 KiB
YAML
site_name: GoToSocial Documentation
|
|
theme: readthedocs
|
|
repo_url: https://github.com/superseriousbusiness/gotosocial
|
|
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
|
|
plugins:
|
|
- render_swagger
|
|
|
|
markdown_extensions:
|
|
- markdown.extensions.admonition
|
|
|
|
extra_javascript:
|
|
- assets/js/swagger-ui-bundle.js
|
|
|
|
extra_css:
|
|
- assets/css/swagger-ui.css
|
|
|
|
nav:
|
|
- "Home": "index.md"
|
|
- "FAQ": "faq.md"
|
|
- "User Guide":
|
|
- "user_guide/posts.md"
|
|
- "user_guide/user_panel.md"
|
|
- "user_guide/custom_css.md"
|
|
- "user_guide/password_management.md"
|
|
- "user_guide/rss.md"
|
|
- "Installation Guide":
|
|
- "installation_guide/index.md"
|
|
- "installation_guide/binary.md"
|
|
- "installation_guide/docker.md"
|
|
- "installation_guide/nginx.md"
|
|
- "installation_guide/apache-httpd.md"
|
|
- "installation_guide/caddy.md"
|
|
- "installation_guide/third_party.md"
|
|
- "installation_guide/websocket.md"
|
|
- "installation_guide/advanced.md"
|
|
- "Configuration":
|
|
- "configuration/index.md"
|
|
- "configuration/general.md"
|
|
- "configuration/database.md"
|
|
- "configuration/web.md"
|
|
- "configuration/instance.md"
|
|
- "configuration/accounts.md"
|
|
- "configuration/media.md"
|
|
- "configuration/storage.md"
|
|
- "configuration/statuses.md"
|
|
- "configuration/letsencrypt.md"
|
|
- "configuration/oidc.md"
|
|
- "configuration/smtp.md"
|
|
- "configuration/syslog.md"
|
|
- "configuration/advanced.md"
|
|
- "Admin":
|
|
- "admin/admin_panel.md"
|
|
- "admin/cli.md"
|
|
- "admin/backup_and_restore.md"
|
|
- "Federation":
|
|
- "federation/index.md"
|
|
- "federation/glossary.md"
|
|
- "federation/security.md"
|
|
- "federation/behaviors/outbox.md"
|
|
- "federation/behaviors/conversation_threads.md"
|
|
- "API Documentation":
|
|
- "api/swagger.md"
|
|
- "api/ratelimiting.md"
|