summaryrefslogtreecommitdiff
path: root/docs/getting_started/index.md
AgeCommit message (Collapse)AuthorFiles
2024-11-05[docs] add zh docs (#3507)Libravatar CDN1
* [docs] add zh docs * [docs] add lang dropdown * [docs] update mkdocs zh config * [docs] migrate assets * [docs] update overrides dir in mkdocs zh config * [docs] exclude locales director in main mkdocs config * [docs] rename assets to public to avoid conflicting with template * [docs] extra_css change followup * [docs] add theme.palette.toggle.icon back into mkdocs zh config * [docs] fix zh readme reference + migrate language-specific repo markdown to docs * [docs] translate remaining repo docs + update reference * [docs] update zh index.md reference * [docs/zh] wording alignment
2024-09-28[docs] Don't run SQLite on networked storage (#3369)Libravatar Daenney1
* [docs] Don't run SQLite on networked storage This updates our documentation to include warnings against running SQLite on networked storage. It also slightly reorganises and consolidates some admonitions on the Getting Started page because it was getting a bit too busy with repeated information. * [docs] Reword a few things
2024-09-23[chore/docs] More little tweaks (#3336)Libravatar tobi1
* [chore/docs] More little tweaks * width * rule between theme figures (looks better on gh) * weee
2024-07-31[docs] Update system requirements, move things around a bit (#3157)Libravatar tobi1
2024-04-10[docs] update deployment considerations docs with latest findings (#2821)Libravatar tobi1
* [docs] update deployment considerations docs with latest findings * simplify single-board computer section
2024-01-21[docs] Updates for DB, swap and HTTP/2 on nginx (#2547)Libravatar Daenney1
* [docs] Add warning about DBs on network storage * [docs] Mention tuning swappiness on Linux * [docs] Mention enabling HTTP/2 on nginx
2023-11-27[docs] Add docs about memory requirements and swap (#2385)Libravatar Daenney1
2023-09-20[docs] Add a note on cluster support (#2214)Libravatar Daenney1
* [docs] Callout no cluster/multi-node support Though we have a GitHub issue for this, we don't mention it anywhere in the docs. This adds it to the deployment considerations so hopefully folks will see it when standing up their own instance. * [docs] Add daenney as a developer
2023-07-07[docs] Rework backups a bit (#1942)Libravatar Daenney1
* [docs] Rework backups a bit This changes the existing backup documentation to: * Push a bit harder on people to perform backups, it's not really just a nice to have * Removes the language about migrating to/from GoToSocial and a different ActivityPub server since that's really not supported * Adds a section about using backup software and provides an example on how to do this using Borgmatic * [docs] Remove too much info in db section * [docs] Add docs on how to backup local media This adds documentation pointing people at the media list-local command in order to determine what media files they need to include as part of their backups. Provides a Python script that people can use to transform the media listing from the CLI into Borg patterns. It also includes a Borgmatic config.yaml in the repository so people can easily fetch it instead of copy-pasting from the docs. * [bugfix] Ensure we emit an absolute path prefix It works either way, as a pattern like data/files/<ID> would match a file on /data/files/<ID>. But it would potentially also match any path that happens to include data/files/<ID> but not rooted at the storage-local-base-path. * [docs] Add more links to media list CLI reference
2023-06-13[docs] Add certificates and firewalling to advanced (#1888)Libravatar Daenney1
* [docs] Add a certificates guide in Advanced This adds some documentation about the process of getting certificates through ACME in general. It also provides a number of links to alternative clients and certbot deployment guides that are up to date. Slightly restructure the NGINX and Apache reverse proxy documentation and insert mentions to the Provisioning TLS certificates advanced documentation in them. * [docs] Add firewall section in Advanced * [docs] Add new guides to section indexes * [docs] Fix spelling issue * [docs] Fix a few typos
2023-06-10[docs] Revamp the installation guide (#1877)Libravatar Daenney1
This tries to revamp/restructure the installation guide. It's renamed to "Getting Started" as it now contains a few more things than just the installation, especially the deployment considerations which we didn't use to spell out as much ahead of time. Installation is now a section with the guides on their own. I've removed a bit of redundancy like the user creation. I also removed the rogue reverse proxy section in the Docker guide and lifted that into the reverse proxy section.