documentation/README.md

Mastodon documentation

Mastodon is a free, open-source GNU social-compatible social network server. A decentralized alternative 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.

Using Mastodon

• Frequently Asked Questions
• List of Mastodon instances
• Apps
• User Guide

Using the API

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

Running Mastodon

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

• Resources needed
• Production guide
• Docker guide
• Alternative: Running on Heroku
• Development guide
• Alternative: Development with Vagrant
• Alternative: Development and Production with Nanobox
• Administration guide
• Maintenance Tasks
• Tuning Mastodon
• System Configuration Alternatives

Contributing to Mastodon

• Sponsors
• Translate Mastodon in your language
• Report bugs and submit ideas

Protocols

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