README.md

Note: The documentation has moved to a different repository, where it is compiled to docs.joinmastodon.org. This repository is no longer updated.

Mastodon is a free, open-source social network server based on open web protocols like ActivityPub and OStatus. The social focus of the project is a viable decentralized alternative to commercial social media silos that returns the control of the content distribution channels to the people.

Documentation

Using Mastodon

• Frequently Asked Questions
• List of Mastodon instances (Alternative list)
• List of apps for Mastodon (or just search for Mastodon in your app store of choice)
• User guide

Using the API

• API documentation
• Streaming API documentation
• Testing the API with cURL
• OAuth details
• Tips for app developers
• Push notifications
• Libraries

Running Mastodon

In production

Please note: It is highly recommended to run a tagged release of Mastodon and not run off the current master branch.

• Before you start: Examples of resource usage from other live instances
• Installing mastodon:
  • Using Docker
  • Standalone installation
  • On Heroku
  • On Scalingo
  • On Nanobox
• After installation:
  • Administrating a Mastodon instance
  • Tuning Mastodon performance
  • List of terminal commands
  • Customizing the look
  • Updating Mastodon
• Advanced:
  • Serving Mastodon from a subdomain
  • Scaling up with PgBouncer
  • Enabling full-text search with Elasticsearch

The aforementioned guides presume using certain software, like Nginx. But using alternatives is possible: Alternative system configurations

In development

• Setting up a development environment
• There are other options:
  • Using Vagrant
  • Using Nanobox

Contributing to Mastodon

• 🎉 List of Sponsors - thank you to these people! 🎉
• Translate Mastodon to your language
• Report bugs and submit ideas

Protocols

• List of used specs and RFCs for the federation
• Extensions of the above protocols