summaryrefslogtreecommitdiff
path: root/docs/getting_started
AgeCommit message (Collapse)AuthorFiles
2025-01-23[feature] Add warning about `trusted-proxies` to make config easier (#3675)Libravatar tobi1
* [feature] Add warning about `trusted-proxies` to make config easier * thank you linter, hugs and kisses to you
2024-12-02[chore] Replace Semaphore recommendation with Pinafore. (#3586)Libravatar Phil Hagelberg1
Neither Semaphore nor Pinafore are under active development, but Semaphore has archived its repository while Pinafore still gets occasional minor maintenance. Enafore has newer features, but it has accessibility bugs affecting screen readers that prevent it from being recommended at this time.
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-11-03[docs] Fix typos (#3498)Libravatar Jim Tittsler1
2024-10-14[chore] Clarify supported platforms, add notes + docs (#3427)Libravatar tobi1
* [chore] Don't build for OpenBSD, add support level notes + tips * tweak a bit * add supported platforms matrix
2024-10-13[chore/docs] Add `/gotosocial/.cache` to Docker container, document ↵Libravatar tobi1
`GTS_WAZERO_COMPILATION_CACHE` (#3425) * [chore/docs] Add `/gotosocial/.cache` to Docker container, document `GTS_WAZERO_COMPILATION_CACHE` * update wazero artifact size guesstimate
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-07-03[docs] Update how to enable http2 on nginx (#3066)Libravatar Daenney1
Since 1.25.1 the newer 'http2 on;' syntax should be used. The previous syntax still works, but throws warnings when testing the configuration with 'nginx -t'. This also updates the certbot template to match what's currently generated. It removes ipv6only=on as that's the default on a listen directive binding on a wildcard IPv6 address.
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-04-02[feature] Add `enable` command to mirror existing `disable` command; update ↵Libravatar tobi1
docs (#2792) * [feature] add `enable` CLI command to mirror existing `disable` command * update docs
2024-03-08[docs] Add note about privileged ports (#2735)Libravatar tobi1
2024-02-12[docs] Fix a few things in the bare metal install (#2624)Libravatar Daenney1
* [docs] Fix a few things in the bare metal install Fixes #2454 * [chore] Fix shell variable interpolation
2024-02-12[docs] Enable some new features (#2623)Libravatar Daenney1
* [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-01-21[docs] Updates for DB, swap and HTTP/2 on nginx (#2547)Libravatar Daenney2
* [docs] Add warning about DBs on network storage * [docs] Mention tuning swappiness on Linux * [docs] Mention enabling HTTP/2 on nginx
2023-12-05[docs] Change configuration creation instructions (#2408)Libravatar Daenney2
* [docs] Change configuration creation instructions This changes the wording to push people towards creating their own configuration, without copying the whole example configuration. This makes it much easier to reconcile necessary configruation changes on upgrades. * [docs] Reword container version section This changes the wording in the Version section to make it more clear what the risks of a moving tag are. It pushes people to use an explicit release tag instead.
2023-11-27[docs] Add docs about memory requirements and swap (#2385)Libravatar Daenney1
2023-11-17[feature] Set/show instance language(s); show post language on frontend (#2362)Libravatar tobi2
* update go text, include text/display * [feature] Set instance langs, show post lang on frontend * go fmt * WebGet * set language for whole article, don't use FA icon * mention instance languages + other optional config vars * little tweak * put languages in config properly * warn log language parse * change some naming around * tidy up validate a bit * lint * rename LanguageTmpl in template
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-08-15[feature] Add snapshot binary builds + uploads (#2119)Libravatar tobi2
* [feature] Add snapshot binary builds + uploads * Update docs to include info on snapshot builds * review comments * little tweaks
2023-08-11[feature] Set Content-Security-Policy header (#2095)Libravatar Daenney1
This adds the CSP header with a policy of only loading from the same domain. We don't make use of external media, CSS, JS, fonts, so we don't ever need external data loaded in our context. When building a DEBUG build, the policy gets extended to include localhost:*, i.e localhost on any port. This keeps the live-reloading flow for JS development working. localhost and 127.0.0.1 are considered to be the same so mixing and matching those doesn't result in a CSP violation.
2023-08-08[chore] Add Feditext as recommended client (#2081)Libravatar Daenney1
With Feditext now accepting beta users, this adds it as the third client to recommend so we have web and the dominant mobile platforms covered. This also removes the screenshots from the README, because it became a mess trying to add a third one. Either the cells become very narrow, or the table doubles in height. As the UI may also change over time, it might be better to point folks at the apps instead who'll hopefully have up to date screenshots in their storefronts.
2023-08-01[feature] Set timezone in Docker using TZ env variable (#2050)Libravatar tobi1
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-20[docs] Disambiguate docker version, don't recommend opening localhost (#1913)Libravatar tobi1
2023-06-13[docs] Add certificates and firewalling to advanced (#1888)Libravatar Daenney3
* [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-12[docs] Made Advanced its own section (#1883)Libravatar Daenney3
* [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-10[docs] Revamp the installation guide (#1877)Libravatar Daenney13
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.