SuperSeriousBusiness
/
GoToSocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
GoToSocial/mkdocs.yml

67 lines
1.9 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 10:36:28 +02:00
site_name: GoToSocial Documentation
theme: readthedocs
repo_url: https://github.com/superseriousbusiness/gotosocial
[docs] Fix documentation edit link (#1298)
2023-01-04 10:39:26 +01:00
edit_uri: edit/main/docs/
[chore] Update/add license headers for 2023 (#1304)
2023-01-05 12:43:00 +01:00
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2021-2023 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 17:49:59 +02:00
plugins:
- render_swagger
[docs] Add AppArmor profile for Debian and Ubuntu installations (#1183) * 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).
2022-11-30 23:09:26 +01:00
markdown_extensions:
- markdown.extensions.admonition
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 17:49:59 +02:00
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 16:54:23 +01:00
nav:
- "Home": "index.md"
[docs] Add first draft of FAQ (#1086) * Clarify that gotosocial doesn't use recommendation algorithms It uses lots of algorithms. ~/src/gotosocial $ rgrep algorithm . | wc 856 8971 143395 * Add first draft of the FAQ. * Suggested FAQ changes. Mention backfill of posts as not yet being implemented; link to FAQ from readme/index. Mention that GtS does serve up some UI; just not most interaction.
2022-11-21 13:19:51 +01:00
- "FAQ": "faq.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 17:40:54 +02:00
- "User Guide":
- "user_guide/posts.md"
- "user_guide/user_panel.md"
[feature] Allow users to set custom css for their profiles + threads (#808) * add custom css account property + db func to fetch * allow account to get/set custom css * serve custom css for an account * go fmt * use monospace for customcss, add link * add custom css to account cache * fix broken field * add custom css docs to user guide * add `accounts-allow-custom-css` config flag * add allow custom css to /api/v1/instance response * only show/set custom css if allowed to do so * only set/serve custom account css if enabled * update swagger docs * chain promise * make bool a bit clearer * use cache for GetAccountCustomCSSByUsername
2022-09-12 13:14:29 +02:00
- "user_guide/custom_css.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 17:40:54 +02:00
- "user_guide/password_management.md"
[feature] Add opt-in RSS feed for account's latest Public posts (#897) * start adding rss functionality * add gorilla/feeds dependency * first bash at building rss feed still needs work, this is an interim commit * tidy up a bit * add publicOnly option to GetAccountLastPosted * implement rss endpoint * fix test * add initial user docs for rss * update rss logo * docs update * add rssFeed to frontend * feed -> feed.rss * enableRSS * increase rss logo size a lil bit * add rss toggle * move emojify to text package * fiddle with rss feed formatting * add Text field to test statuses * move status to rss item to typeconverter * update bun schema for enablerss * simplify 304 checking * assume account not rss * update tests * update swagger docs * allow more characters in title, trim nicer * update last posted to be more consistent
2022-10-08 14:00:39 +02:00
- "user_guide/rss.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 13:58:15 +01: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 17:45:43 +02: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 11:45:55 +02:00
- "installation_guide/caddy.md"
[documentation] Add third-party packaging to documentation (#443)
2022-03-29 15:36:04 +02:00
- "installation_guide/third_party.md"
[documentation] Add WebSocket protocol documentation (#470)
2022-04-22 13:35:19 +02:00
- "installation_guide/websocket.md"
[docs] add account domain documentation (#1065) * [docs] add account domain documentation * add note about parent/subdomain
2022-11-17 15:04:35 +01:00
- "installation_guide/advanced.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 17:50:00 +01: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 16:54:54 +02:00
- "configuration/instance.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 18:00:20 +01: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 15:40:38 +02:00
- "configuration/advanced.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 14:33:24 +02:00
- "federation/glossary.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01:00
- "federation/security.md"
- "federation/behaviors/outbox.md"
- "federation/behaviors/conversation_threads.md"
[feature] HTTP request throttling middleware (#1297) * [feature] Add throttling middleware to AP endpoints * refactor a lil bit * use config setting, start updating docs * doc updates * use relative links in faq doc * small docs fixes * return code 503 instead of 429 when throttled * throttle other endpoints too * simplify token channel prefills
2023-01-04 11:57:59 +01:00
- "federation/behaviors/request_throttling.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01:00
- "API Documentation":
- "api/swagger.md"
[feature] Make rate limit requests amount configurable (#966) * update rate limit documentation * regenerate landingpage config helpers * make rate limit rate configurable
2022-11-06 10:47:48 +01:00
- "api/ratelimiting.md"
[feature] HTTP request throttling middleware (#1297) * [feature] Add throttling middleware to AP endpoints * refactor a lil bit * use config setting, start updating docs * doc updates * use relative links in faq doc * small docs fixes * return code 503 instead of 429 when throttled * throttle other endpoints too * simplify token channel prefills
2023-01-04 11:57:59 +01:00
- "api/throttling.md"