2021-07-23 09:36:28 +01:00
|
|
|
site_name: GoToSocial Documentation
|
2023-02-21 08:01:10 +00:00
|
|
|
site_url: https://docs.gotosocial.org
|
2023-02-20 22:09:17 +00:00
|
|
|
theme:
|
|
|
|
name: material
|
|
|
|
language: en
|
|
|
|
font: false
|
|
|
|
features:
|
|
|
|
- header.autohide
|
2023-05-23 10:51:43 +01:00
|
|
|
- content.code.copy
|
2023-07-09 17:25:14 +01:00
|
|
|
- content.action.edit
|
2023-02-20 22:09:17 +00:00
|
|
|
palette:
|
|
|
|
- scheme: slate
|
|
|
|
toggle:
|
|
|
|
icon: material/brightness-7
|
|
|
|
name: Switch to light mode
|
|
|
|
- scheme: default
|
|
|
|
toggle:
|
|
|
|
icon: material/brightness-4
|
|
|
|
name: Switch to dark mode
|
2021-07-23 09:36:28 +01:00
|
|
|
repo_url: https://github.com/superseriousbusiness/gotosocial
|
2023-01-04 09:39:26 +00:00
|
|
|
edit_uri: edit/main/docs/
|
2024-01-13 15:33:53 +00:00
|
|
|
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) GoToSocial Authors admin@gotosocial.org
|
2021-07-31 16:49:59 +01:00
|
|
|
plugins:
|
2023-02-20 22:09:17 +00:00
|
|
|
- search:
|
|
|
|
lang: en
|
|
|
|
- social:
|
|
|
|
cards: true
|
2024-02-12 11:05:35 +00:00
|
|
|
cards_layout_options:
|
|
|
|
background_color: "#fd6a00"
|
|
|
|
color: "#fafaff"
|
2023-02-20 22:09:17 +00:00
|
|
|
- swagger-ui-tag:
|
|
|
|
supportedSubmitMethods: []
|
|
|
|
syntaxHighlightTheme: obsidian
|
2021-07-31 16:49:59 +01:00
|
|
|
|
|
|
|
extra_css:
|
2023-02-20 22:09:17 +00:00
|
|
|
- assets/css/colours.css
|
|
|
|
|
|
|
|
markdown_extensions:
|
|
|
|
- admonition
|
2024-02-12 11:05:35 +00:00
|
|
|
- pymdownx.details
|
2023-05-23 16:04:00 +01:00
|
|
|
- pymdownx.highlight:
|
|
|
|
anchor_linenums: true
|
|
|
|
line_spans: __span
|
2024-02-12 11:05:35 +00:00
|
|
|
linenums_style: pymdownx-inline
|
2023-05-23 16:04:00 +01:00
|
|
|
pygments_lang_class: true
|
2024-02-12 11:05:35 +00:00
|
|
|
linenums: true
|
2023-05-23 16:04:00 +01:00
|
|
|
- pymdownx.inlinehilite
|
|
|
|
- pymdownx.snippets
|
|
|
|
- pymdownx.superfences
|
2024-02-12 11:05:35 +00:00
|
|
|
- pymdownx.smartsymbols
|
|
|
|
- pymdownx.caret
|
|
|
|
- pymdownx.keys
|
|
|
|
- pymdownx.mark
|
|
|
|
- pymdownx.tilde
|
|
|
|
- pymdownx.tabbed:
|
|
|
|
alternate_style: true
|
2021-11-14 15:54:23 +00:00
|
|
|
|
|
|
|
nav:
|
|
|
|
- "Home": "index.md"
|
2022-11-21 12:19:51 +00:00
|
|
|
- "FAQ": "faq.md"
|
2022-08-26 16:40:54 +01:00
|
|
|
- "User Guide":
|
2023-02-13 11:40:24 +00:00
|
|
|
- "user_guide/posts.md"
|
|
|
|
- "user_guide/settings.md"
|
|
|
|
- "user_guide/custom_css.md"
|
|
|
|
- "user_guide/password_management.md"
|
|
|
|
- "user_guide/rss.md"
|
2023-06-10 10:13:04 +01:00
|
|
|
- "Getting Started":
|
|
|
|
- "getting_started/index.md"
|
|
|
|
- "getting_started/releases.md"
|
|
|
|
- "Installation":
|
|
|
|
- "getting_started/installation/index.md"
|
|
|
|
- "getting_started/installation/metal.md"
|
|
|
|
- "getting_started/installation/container.md"
|
|
|
|
- "Reverse Proxy":
|
|
|
|
- "getting_started/reverse_proxy/index.md"
|
|
|
|
- "getting_started/reverse_proxy/nginx.md"
|
|
|
|
- "getting_started/reverse_proxy/apache-httpd.md"
|
|
|
|
- "getting_started/reverse_proxy/caddy.md"
|
|
|
|
- "getting_started/reverse_proxy/websocket.md"
|
|
|
|
- "getting_started/user_creation.md"
|
2021-11-14 15:54:23 +00:00
|
|
|
- "Configuration":
|
2023-02-13 11:40:24 +00:00
|
|
|
- "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"
|
2023-03-04 17:24:02 +00:00
|
|
|
- "configuration/tls.md"
|
2023-02-13 11:40:24 +00:00
|
|
|
- "configuration/oidc.md"
|
|
|
|
- "configuration/smtp.md"
|
|
|
|
- "configuration/syslog.md"
|
2023-07-07 15:17:39 +01:00
|
|
|
- "configuration/httpclient.md"
|
2023-02-13 11:40:24 +00:00
|
|
|
- "configuration/advanced.md"
|
2023-02-17 11:02:29 +00:00
|
|
|
- "configuration/observability.md"
|
2023-06-12 14:38:53 +01:00
|
|
|
- "Advanced":
|
|
|
|
- "advanced/index.md"
|
|
|
|
- "advanced/host-account-domain.md"
|
|
|
|
- "advanced/outgoing-proxy.md"
|
|
|
|
- "Caching":
|
|
|
|
- "advanced/caching/index.md"
|
|
|
|
- "advanced/caching/api.md"
|
|
|
|
- "advanced/caching/assets-media.md"
|
2023-06-13 15:30:09 +01:00
|
|
|
- "advanced/certificates.md"
|
2023-06-12 14:38:53 +01:00
|
|
|
- "Enhanced security":
|
|
|
|
- "advanced/security/index.md"
|
|
|
|
- "advanced/security/sandboxing.md"
|
2023-06-13 15:30:09 +01:00
|
|
|
- "advanced/security/firewall.md"
|
2024-03-25 17:05:14 +00:00
|
|
|
- "advanced/healthchecks.md"
|
2023-06-12 14:38:53 +01:00
|
|
|
- "advanced/tracing.md"
|
2023-11-20 15:43:55 +00:00
|
|
|
- "advanced/metrics.md"
|
2023-06-12 14:38:53 +01:00
|
|
|
|
2021-11-14 15:54:23 +00:00
|
|
|
- "Admin":
|
2023-02-13 11:40:24 +00:00
|
|
|
- "admin/settings.md"
|
2023-09-21 11:12:04 +01:00
|
|
|
- "admin/federation_modes.md"
|
|
|
|
- "admin/domain_blocks.md"
|
2023-02-13 11:40:24 +00:00
|
|
|
- "admin/cli.md"
|
|
|
|
- "admin/backup_and_restore.md"
|
2023-10-30 17:35:11 +00:00
|
|
|
- "admin/media_caching.md"
|
2024-02-27 12:22:05 +00:00
|
|
|
- "admin/spam.md"
|
2024-03-14 17:40:36 +00:00
|
|
|
- "admin/database_maintenance.md"
|
2021-11-14 15:54:23 +00:00
|
|
|
- "Federation":
|
2023-02-13 11:40:24 +00:00
|
|
|
- "federation/index.md"
|
|
|
|
- "federation/glossary.md"
|
2023-02-13 17:34:44 +00:00
|
|
|
- "federation/federating_with_gotosocial.md"
|
2024-02-27 14:39:22 +00:00
|
|
|
- "Client API Docs":
|
2024-02-24 08:41:38 +00:00
|
|
|
- "api/authentication.md"
|
2024-02-27 14:39:22 +00:00
|
|
|
- "api/swagger.md"
|
2023-02-13 11:40:24 +00:00
|
|
|
- "api/ratelimiting.md"
|
|
|
|
- "api/throttling.md"
|