* Adds note for instance admins. * Addresses feedback from #1925.
Mastodon is a free, open-source social network server. A decentralized solution to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.
An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.
Click on the screenshot to watch a demo of the UI:
The project focus is a clean REST API and a good user interface. Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.
If you would like, you can support the development of this project on Patreon. Alternatively, you can donate to this BTC address:
- List of Mastodon instances
- Use this tool to find Twitter friends on Mastodon
- API overview
- Frequently Asked Questions
- List of apps
- Fully interoperable with GNU social and any OStatus platform Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
- Real-time timeline updates See the updates of people you're following appear in real-time in the UI via WebSockets
- Federated thread resolving If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
- Media attachments like images and WebM Upload and view images and WebM videos attached to the updates
- OAuth2 and a straightforward REST API Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
- Background processing for long-running tasks Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
- Deployable via Docker You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy
If you want a stable release for production use, you should use tagged releases. To checkout the latest available tagged version:
git clone https://github.com/tootsuite/mastodon.git cd mastodon git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
LOCAL_DOMAINshould be the domain/hostname of your instance. This is absolutely required as it is used for generating unique IDs for everything federation-related
LOCAL_HTTPSset it to
trueif HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs
Consult the example configuration file,
.env.production.sample for the full list. Among other things you need to set details for the SMTP server you are going to use.
Running with Docker and Docker-Compose
The project now includes a
Dockerfile and a
docker-compose.yml file (which requires at least docker-compose version
Review the settings in
docker-compose.yml. Note that it is not default to store the postgresql database and redis databases in a persistent storage location,
so you may need or want to adjust the settings there.
Then, you need to fill in the
cp .env.production.sample .env.production nano .env.production
Do NOT change the
DB_* settings when running with the default docker configurations.
You will need to fill in, at least:
OTP_SECRET, and the
SMTP_* settings. To generate the
OTP_SECRET, you may use:
Before running the first time, you need to build the images:
docker-compose build docker-compose run --rm web rake secret
Do this once for each of those keys, and copy the result into the
.env.production file in the appropriate field.
Then you should run the
db:migrate command to create the database, or migrate it from an older release:
docker-compose run --rm web rails db:migrate
Then, you will also need to precompile the assets:
docker-compose run --rm web rails assets:precompile
before you can launch the docker image with:
If you wish to run this as a daemon process instead of monitoring it on console, use instead:
docker-compose up -d
Then you may login to your new Mastodon instance by browsing to http://localhost:3000/
Following that, make sure that you read the production guide. You are probably going to want to understand how to configure Nginx to make your Mastodon instance available to the rest of the world.
The container has two volumes, for the assets and for user uploads, and optionally two more, for the postgresql and redis databases.
The default docker-compose.yml maps them to the repository's
public/system directories, you may wish to put them somewhere else. Likewise, the PostgreSQL and Redis images have data containers that you may wish to map somewhere where you know how to find them and back them up.
--rm option for docker-compose will remove the container that is created to run a one-off command after it completes. As data is stored in volumes it is not affected by that container clean-up.
rake mastodon:media:clearremoves uploads that have not been attached to any status after a while, you would want to run this from a periodic cronjob
rake mastodon:push:clearunsubscribes from PuSH notifications for remote users that have no local followers. You may not want to actually do that, to keep a fuller footprint of the fediverse or in case your users will soon re-follow
rake mastodon:push:refreshre-subscribes PuSH for expiring remote users, this should be run periodically from a cronjob and quite often as the expiration time depends on the particular hub of the remote user
rake mastodon:feeds:clear_allremoves all timelines, which forces them to be re-built on the fly next time a user tries to fetch their home/mentions timeline. Only for troubleshooting
rake mastodon:feeds:clearremoves timelines of users who haven't signed in lately, which allows to save RAM and improve message distribution. This is required to be run periodically so that when they login again the regeneration process will trigger
Running any of these tasks via docker-compose would look like this:
docker-compose run --rm web rake mastodon:media:clear
This approach makes updating to the latest version a real breeze.
git pullto download updates from the repository
docker-compose buildto compile the Docker image out of the changed source files
docker-compose run --rm web rails db:migrateto perform database migrations. Does nothing if your database is up to date
docker-compose run --rm web rails assets:precompileto compile new JS and CSS assets
docker-compose up -dto re-create (restart) containers and pick up the changes
Deployment without Docker
Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the production guide for examples, configuration and instructions.
Deployment on Scalingo
Deployment on Heroku (experimental)
Mastodon can run on Heroku, but it gets expensive and impractical due to how Heroku prices resource usage. You can view a guide for deployment on Heroku here, but you have been warned.
Development with Vagrant
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. Here are the guidelines for code contributions
IRC channel: #mastodon on irc.freenode.net