简体中文
EnglishWhat is GoToSocial Documentation?
Updated
GoToSocial Documentation (docs.gotosocial.org) is the official documentation site for GoToSocial, a federated social networking server software. It is not a social platform you sign up for — it is the reference material for people who run, administer, or use a GoToSocial instance. If you are evaluating whether GoToSocial fits your needs, deploying your own server, or troubleshooting an existing one, this is the primary source to consult.
What GoToSocial actually is
GoToSocial is server software for the Fediverse — the network of interoperable social platforms that communicate via ActivityPub. The documentation describes it as having a "backend-first design," meaning it focuses on the server and API layer, with the expectation that you use a separate client app to interact with it. It is compatible with the Mastodon API, so many existing Mastodon clients work with it.
The docs also note GoToSocial's history and status within the broader federation landscape, and it lists alternatives for comparison.
What the documentation covers
The site is organized into several major sections, each aimed at a different stage of the lifecycle:
| Section | What it helps you do |
|---|---|
| Getting Started | Understand deployment considerations and pick a release |
| Installation | Install via bare metal, container, or from source |
| Configuration | Set up database, instance, accounts, media, TLS, OIDC, email, and more |
| Reverse Proxy | Configure NGINX, Apache, or Caddy 2, including WebSocket support |
| Advanced | Split-domain deployments, caching, provisioning TLS, tracing, metrics, SQLite replication |
| Admin | Manage sign-ups, federation modes, domain blocks, backups, spam filtering, themes |
| Federation | Understand HTTP signatures, access control, rate limiting, actors, and posts |
| User Guide | Settings, posts, search, custom CSS, password management, RSS, migration |
| Client API Docs | Authenticate and call API routes and methods |
There is also a FAQ, a glossary, and a contributing section.
Who should read it
The documentation is written for three overlapping audiences:
- Instance administrators — people deploying and maintaining a GoToSocial server. The Installation, Configuration, Admin, and Advanced sections are primarily for you.
- End users — people with an account on an existing instance. The User Guide and Client API Docs are the relevant parts.
- Developers and integrators — people building clients or tooling against the API. The Client API Docs, Federation, and Advanced sections matter most.
If you are simply looking for a social network to join, this site is not that — it is the manual for the software behind one.
How to access it
The documentation is published at docs.gotosocial.org and is also available via Codeberg, where the project is hosted. The site has a table of contents and a local directory structure, so you can navigate by topic rather than reading linearly. The documentation is written in English.
One practical note: the site mentions "subscription" in its content, but the documentation itself does not present pricing or payment details for using the docs. Treat any subscription references as project-related context rather than a cost to read the documentation.