Self-Hosting Docs
Use these docs when you operate OpenPost on your own infrastructure. Self-hosting has no software fee, but it is not a Hosted service plan or a zero-price tier of the Hosted service. You pay for your infrastructure and any provider or third-party services you use.
These pages assume that you manage the server, public HTTPS origin, access controls, secrets, database, media storage, monitoring, backups, upgrades, and incident response. You also support the people who use your deployment and maintain its privacy, retention, and recovery practices.
Responsibility boundary
- Infrastructure and data: you choose and secure the server, database, media storage, logs, network, and data locations.
- Upgrades and backups: you track releases and security notices, apply updates, back up the database, media, and required secrets together, and test restores.
- Provider projects: you create and maintain social network projects, callback URLs, permissions, reviews, API access, and provider budgets. OpenPost still sends requested content and access tokens to those networks.
- Support: OpenPost publishes documentation, source code, a public issue tracker, and community help. A self-hosted operator handles deployment availability, user support, incidents, and operator-specific configuration.
Review the OpenPost source, security policy, and current releases before exposing an instance to users.
Install
- Why Self-Host? explains the costs and benefits. OpenPost uses SQLite and local files by default when you run it yourself.
- Docker Compose is the best place to start.
- Single Binary covers the app and server in one file.
- Nix Module covers the generated NixOS module reference.
- Reverse Proxy covers public HTTPS routing.
- Build From Source covers local builds.
- Docker Run shows how to run the container by hand.
Configure
- Configuration Overview groups the main settings.
- Environment Variables is the full configuration reference.
- Database covers SQLite and Postgres.
- Media Storage covers local files and S3/R2 storage.
- CORS and URLs covers public app and media web addresses.
- Production Checklist helps you check the server before people use it.
Providers
- Providers Overview explains social network app setup.
- Supported Platforms and Limits lists current implementation state.
- Provider Troubleshooting helps with OAuth, access, media link, and publish errors.
- Provider Roadmap explains what works now and what is planned.
- X, Mastodon, Bluesky, LinkedIn, Threads, Facebook, Instagram, TikTok, YouTube, and Discord cover each network's setup.
Operate
Adjacent docs
- If you only need to use the product, start with User Docs.
- If you are changing OpenPost code, start with Developer Docs.