qugalet/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-22 19:56:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
gotosocial/mkdocs.yml

56 lines
1.6 KiB
YAML
Raw Normal View History

Oidc (#109) * add oidc config * inching forward with oidc idp * lil webfingy fix * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * add oidc config * inching forward with oidc idp * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * document * docs + comments
2021-07-23 08:36:28 +00:00
site_name: GoToSocial Documentation
theme: readthedocs
repo_url: https://github.com/superseriousbusiness/gotosocial
Extend license notices to 2022 (#354)
2021-12-20 17:42:19 +00:00
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
Swagger (#124) * start experimenting with swagger documentation * further adventures in swagger * do a few more api paths * account paths documented * go fmt * fix up some models * bit o lintin'
2021-07-31 15:49:59 +00:00
plugins:
- render_swagger
extra_javascript:
- assets/js/swagger-ui-bundle.js
extra_css:
- assets/css/swagger-ui.css
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
nav:
- "Home": "index.md"
[docs] Add user settings panel docs, other small updates (#768) * add more links to markdown section * update password management * add user settings panel documentation * move the user guide higher up in the docs
2022-08-26 15:40:54 +00:00
- "User Guide":
- "user_guide/posts.md"
- "user_guide/user_panel.md"
- "user_guide/password_management.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Installation Guide":
- "installation_guide/index.md"
- "installation_guide/binary.md"
- "installation_guide/docker.md"
[documentation] Add section for systemd service and nginx to installation guide (#353) * add nginx and systemd section * fix typso * fix mkdoc and dots in config guide * specify port * Update nginx.md * add section about configuring gts to nginx docs * Update nginx.md Co-authored-by: zoe <z8V54gHftevp7LeRVyys$8@DosKq^FeQKUWU!WGpTyiLaxGojNdgnWkaWiv673Twg$aPm&hU>
2021-12-26 12:58:15 +00:00
- "installation_guide/nginx.md"
[docs] unify nginx explainers and add apache httpd (#455) * docs: unify nginx explainers and add apache httpd there are two places where nginx + certbot is explained, unify that into one place. Add apache httpd, following the same steps, but using mod_md for LetsEncrypt add a note about #453 in both guides. Link to both, and call the section reverse proxy, instead of NGINX * restore full nginx.conf from docker.md * add installation_guide/apache-httpd.md to mkdocs
2022-04-18 15:45:43 +00:00
- "installation_guide/apache-httpd.md"
[docs] Add Caddy instructions to the documentation (#594) * Add instructions for working with Caddy 2 Add instructions for working with Caddy 2. Some texts are duplicated from the NGINX part (mainly the configuration part, about systemctl). * Add new Caddy docs to mkdocs.yml Adds the new Caddy document to the document tree * Remove up and downstream headers from configuration Removed the header statements for the proxy, as proxying those are transparant. Kept the flush_interval directive, disabling the response buffer completely so we can write without delays. * Update caddy.md Corrects the opening link * Apply comments mentioned in PR @igalic mentioned a few comments to improve these docs. I've processed those in this PR.
2022-05-23 09:45:55 +00:00
- "installation_guide/caddy.md"
[documentation] Add third-party packaging to documentation (#443)
2022-03-29 13:36:04 +00:00
- "installation_guide/third_party.md"
[documentation] Add WebSocket protocol documentation (#470)
2022-04-22 11:35:19 +00:00
- "installation_guide/websocket.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Configuration":
- "configuration/index.md"
- "configuration/general.md"
- "configuration/database.md"
Add `Accept` header negotiation to relevant API endpoints (#337) * start centralizing negotiation logic for API * swagger document nodeinfo endpoint * go fmt * document negotiate function * use content negotiation * tidy up negotiation logic * negotiate content throughout client api * swagger * remove attachment on Content * add accept header to test requests
2021-12-11 16:50:00 +00:00
- "configuration/web.md"
[feature] Implement `/api/v1/instance/peers` endpoint (#660) * add missing license headers * start adding instance peers get * rename domainblock.go * embed domain in domainblock so it can be reused * update swagger docs * add test instances to db * update tests * add/update instancepeersget * update domain model * add getinstancepeers to db * instance-expose-peers, instance-expose-suspended * add auth checks for both current filters * attach endpoint to router * include public comment * obfuscate domain if required * go mod tidy * update swagger docs * remove unnecessary comment * return 'flat' peerlist if no query params provided
2022-06-23 14:54:54 +00:00
- "configuration/instance.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "configuration/accounts.md"
- "configuration/media.md"
- "configuration/storage.md"
- "configuration/statuses.md"
- "configuration/letsencrypt.md"
- "configuration/oidc.md"
- "configuration/smtp.md"
Add optional syslog logrus hook (#343) * add optional syslog logrus hook * document syslog
2021-12-12 17:00:20 +00:00
- "configuration/syslog.md"
[feature] Start adding advanced configuration options, starting with `samesite` (#628) * fix incorrect port being used for db * start adding advanced config flags * use samesite lax by default
2022-06-03 13:40:38 +00:00
- "configuration/advanced.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Admin":
- "admin/admin_panel.md"
- "admin/cli.md"
- "admin/backup_and_restore.md"
- "Federation":
- "federation/index.md"
[Documentation] Update glossary, expand entry for dereferencing (#542) * Update glossary, expand entry for dereferencing * Add glossary as separate file
2022-05-04 12:33:24 +00:00
- "federation/glossary.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "federation/security.md"
- "federation/behaviors/outbox.md"
- "federation/behaviors/conversation_threads.md"
- "API Documentation":
- "api/swagger.md"
Reference in a new issue Copy permalink