summaryrefslogtreecommitdiff
path: root/docs/installation_guide
AgeCommit message (Collapse)AuthorFiles
2023-06-10[docs] Revamp the installation guide (#1877)Libravatar Daenney10
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.
2023-06-09[docs] Add example tracing infrastructure (#1866)Libravatar Daenney1
This adds an example on how to get Grafana Tempo up to receive spans as well as Grafana itself to view them. I've added this as a separate Tracing doc in the installation guide as the Advanced one was starting to get rather full. Fixes: #1791
2023-06-04[bugfix/docs] AppArmor profile for SQLite (#1864)Libravatar Daenney1
Our default configuration places the SQLite DB in /gotosocial/, but the AppArmor profile doesn't allow us to write there. Instead of making the whole directory writable, add a writable area in /gotosocial/db/ instead and advise in the docs to move the DB there.
2023-06-04[docs] Add Repology stats (#1859)Libravatar Daenney1
Instead of a manually curated list of distribution packages, this adds the Repology[1] widget instead. This also separates out the distribution packages from the self-hosting/deployment options into their own sections. [1]: https://repology.org/project/gotosocial/versions
2023-05-21[chore] Replace pinafore with semaphore (#1801)Libravatar Julian-Samuel Gebühr2
* Replace pinafore with semaphore * Typo
2023-05-15[bugfix] Fix proxy_pass in named location (#1794)Libravatar Daenney1
A proxy_pass in a named location, @name, should not include a trailing slash.
2023-05-15[docs] remove nginx trailing slash (#1789)Libravatar tobi1
2023-03-31[docs] Add MASH as 3rd party packaging (#1654)Libravatar Julian-Samuel Gebühr1
2023-03-16[docs] Update docs on how to login (#1626)Libravatar Daenney1
This adds a section to the docs instructing how to ensure apps will be able to successfully login to an instance when host- and account-domain differ. Resolves #1609
2023-03-09[feature] Provide .well-known/host-meta endpoint (#1604)Libravatar Daenney1
* [feature] Provide .well-known/host-meta endpoint This adds the host-meta endpoint as Mastodon clients use this to discover the API domain to use when the host and account domains aren't the same. * Address review comments
2023-03-04[feature] Allow loading TLS certs from disk (#1586)Libravatar Daenney1
Currently, GtS only supports using the built-in LE client directly for TLS. However, admins may still want to use GtS directly (so without a reverse proxy) but with certificates provided through some other mechanism. They may have some centralised way of provisioning these things themselves, or simply prefer to use LE but with a different challenge like DNS-01 which is not supported by autocert. This adds support for loading a public/private keypair from disk instead of using LE and reconfigures the server to use a TLS listener if we succeed in doing so. Additionally, being able to load TLS keypair from disk opens up the path to using a custom CA for testing purposes avoinding the need for a constellation of containers and something like Pebble or Step CA to provide LE APIs.
2023-02-15[docs] Fix nginx fileserver caching example (#1506)Libravatar Daenney1
* [bug] Fix nginx fileserver caching example This updates the example to ensure the nginx proxies the request on to GTS if the file is not found on disk. This can happen due to media pruning. * [chore] Set cache-control in nginx to private This makes the header match with the backend. For things from the fileserver it may not be appropriate for anything other than a private cache (i.e the client) to cache things.
2023-02-08[chore/bugfix] Serve + throttle publickey separately from rest of ↵Libravatar tobi1
ActivityPub API (#1461) * serve publickey separately from AP, don't throttle it * update nginx cache documentation, cache main-key too * throttle public key, but separately from other endpoints
2023-01-30[docs] Add an example on how to setup redirect with Traefik (#1395)Libravatar ketan-vijayvargiya1
2023-01-30[docs] Simplify Apache httpd proxy documentation (#1396)Libravatar Mina Galić1
since 2.4.47 (released April 22nd 2021), Apache httpd can ProxyPass to websockets on the same URL, without mod_rewrite (and, without mod_proxy_wstunnel).
2023-01-03[docs] Add troubleshooting section for Apache (#1291)Libravatar Alex Schroeder1
2022-12-15[docs] Update Apache docs to use 127.0.0.1 instead of localhost (#1266)Libravatar EchedeyLR1
* Update Apache docs to use 127.0.0.1 instead * Update apache-httpd.md
2022-12-14[docs] Update nginx docs to use 127.0.0.1 instead of localhost (#1264)Libravatar tobi1
Lots of these were appearing: ``` *459 connect() failed (111: Connection refused) while connecting to upstream ``` This change resolves it, see https://stackoverflow.com/a/52550758
2022-12-11[docs] Serve static assets with nginx (#1251)Libravatar Daniele Sluijters2
* [docs] Serve static assets with nginx This explains how to use nginx to serve static assets and offload GTS from that responsibility. It also shows how to have nginx add caching headers to indicate to clients how long they may cache an asset. * [docs] Move additional nginx config to advanced This moves a bunch of additional nginx configuration into the Advanced page instead. It declutters the nginx configuration page.
2022-12-11[docs] Caching webfinger with nginx (#1242)Libravatar Daniele Sluijters1
This explains how nginx can be used to cache webfinger responses and potentially serve stale responses in case GTS is down. This can be useful to do in order to ensure webfinger keeps working even if you're doing some maintenance.
2022-12-07[docs] encourage using loopback bind address (#1166)Libravatar Andrea3
2022-12-05[docs] Remove filesystem logging directives from example systemd unit config ↵v0.6.0Libravatar f0x521
(#1206) * remove filesystem logging directives from example systemd unit config * [docs] Update docs to reflect new systemd config Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>
2022-11-30[docs] Add AppArmor profile for Debian and Ubuntu installations (#1183)Libravatar kernelmethod2
* 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-25[docs] Explain that before 0.6.0, account confirm was necessary. (#1149)Libravatar Phil Hagelberg2
Since the documentation site only shows the latest version of the docs, we need the docs to explain how to use the latest stable release, not just the latest git version.
2022-11-25[bugfix] Change emailVerified to true for admin account create (#1140)Libravatar Phil Hagelberg2
The NewSignup method was already being called with requireApproval=false, but it had emailVerified=false as well, which meant that it was required to use the `admin account confirm` command to verify the email before the newly-created user could log in. I think that was probably an oversight; effectively it did require approval anyway. Changing emailVerified to true allows you to just create the account and log in immediately, reducing the opportunity for manual error to sneak in. Also updated the docs to remove the mention of needing to confirm new accounts. However, I've left the confirmation command alone because I think once we have web signups, it will be needed in that context.
2022-11-23[docs] Clarify that reverse proxy setups need trusted-proxies (#1127)Libravatar dx4
* [docs] Clarify that reverse proxy setups need trusted-proxies * Remove the jq usage
2022-11-22[docs] Document http/s/socks5 proxy use (#1118)Libravatar tobi1
2022-11-19[docs] Move and document logs (#1076)Libravatar Leonora Tindall1
Rather than a single access log and no error logging, put the logs in /var/log/gotosocial/, and document creating and owning that directory
2022-11-19[docs] Remove trailing / from proxy_pass for nginx (#1077)Libravatar Leonora Tindall1
The trailing / can break relative URLs.
2022-11-17[docs] Add AUR Reference (#1054)Libravatar Jelle van der Waa1
The AUR is the Arch unofficial repository, where users can upload PKGBUILD's for Arch Linux users to build a package.
2022-11-17[docs] add account domain documentation (#1065)Libravatar tobi2
* [docs] add account domain documentation * add note about parent/subdomain
2022-11-17[docs] Update docker.md with docker tag / version stuff (#1067)Libravatar tobi1
2022-11-10[docs] Replace old references to the previous streaming with websockets (#1015)Libravatar EchedeyLR1
2022-11-08[docs] add link to SELinux policy (#993)Libravatar Lukáš Zapletal1
2022-11-07[docs] refer to the latest release version (#992)Libravatar K1
2022-11-01[docs] Update apache-httpd.md (#937)Libravatar EchedeyLR1
2022-10-31[docs] Change Apache SSL setup to automatic and manual mode (#936)Libravatar EchedeyLR1
* Update apache-httpd.md * Update apache-httpd.md * Update apache-httpd.md
2022-10-31[docs] Add Apache HTTP Server without LetsEncrypt (#935)Libravatar tobi1
2022-10-31[docs] Update Apache2 HTTP Server docs for websockets (#934)Libravatar tobi1
2022-10-25FIx typo (#918)Libravatar mscherer1
2022-07-22[docs] Add client_max_body_size 40M; to nginx docs (#727)Libravatar tobi1
2022-07-08[bugfix] Various fixes (#699)Libravatar Forever2
* [bugfix] Correctly style inputs and buttons <input>, <textarea>, and <button> were incorrectly using the system-ui font previously; this commit fixes that. text-align: center; was added to <button> due to an inconsistency with .button where text-align would be off. * [chore] Update binary installation instructions This commit updates the example release mentioned in the docs, and mentions Caddy in the reverse proxy options. * [bugfix] Remove redundant Caddyfile Caddy automatically upgrades HTTP to HTTPS (see https://caddyserver.com/docs/automatic-https) so the upgrading part of the Caddyfile is redundant.
2022-05-23[docs] Add Caddy instructions to the documentation (#594)Libravatar Martijn de Boer1
* 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-09[Documentation] tidy docker-compose docs, add note about uid/gid (#551)Libravatar tobi1
2022-05-03[documentation] put single-quotes around passwords in install docs (#534)Libravatar tobi2
2022-04-29[documentation] Recommend users take latest *stable* release in installation ↵Libravatar tobi2
guides (#512) * add note about release version number * recommend users take latest stable release
2022-04-29[documentaton] Fix port number in Reverse proxy section (#506)Libravatar Nivex1
2022-04-24[documentation] NGINX docs updates (#471)Libravatar tobi1
* start adjusting nginx documentation * update NGINX docs * add link to the websocket docs
2022-04-22[documentation] Add WebSocket protocol documentation (#470)Libravatar tobi1
2022-04-19[Documentation] Simplify docker-compose documentation + example (#468)Libravatar tobi1
* simplify docker-compose docs + example * Change note about reverse proxy, add traefik * Linting