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](Using-Mastodon)
- [Frequently Asked Questions](Using-Mastodon/FAQ.md)
- [List of Mastodon instances](Using-Mastodon/List-of-Mastodon-instances.md)
- [Apps](Using-Mastodon/Apps.md)
- [User Guide](Using-Mastodon/User-guide.md)

### [Using the API](Using-the-API)
- [API documentation](Using-the-API/API.md)
- [Libraries](Using-the-API/Libraries.md)
- [Streaming API documentation](Using-the-API/Streaming-API.md)
- [Testing the API with cURL](Using-the-API/Testing-with-cURL.md)
- [OAuth details](Using-the-API/OAuth-details.md)
- [Tips for app developers](Using-the-API/Tips-for-app-developers.md)
- [Push notifications](Using-the-API/Push-notifications.md)

### [Running Mastodon](Running-Mastodon)

**Please note**: It is highly recommended to run a [tagged release](https://github.com/tootsuite/mastodon/releases) of Mastodon and **not** run off the current `master` branch.

- [Resources needed](Running-Mastodon/Resources-needed.md)
- [Production guide](Running-Mastodon/Production-guide.md)
- [Docker guide](Running-Mastodon/Docker-Guide.md)
- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md)
- [Development guide](Running-Mastodon/Development-guide.md)
- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md)
- [Alternative: Development _and_ Production with Nanobox](Running-Mastodon/Nanobox-Guide.md)
- [Administration guide](Running-Mastodon/Administration-guide.md)
- [Maintenance Tasks](Running-Mastodon/Maintenance-Tasks.md)
- [Tuning Mastodon](Running-Mastodon/Tuning.md)
- [System Configuration Alternatives](Running-Mastodon/Alternatives.md)

### [Contributing to Mastodon](Contributing-to-Mastodon)
- [Sponsors](Contributing-to-Mastodon/Sponsors.md)
- [Translate Mastodon in your language](Contributing-to-Mastodon/Translating.md)
- [Report bugs and submit ideas](https://github.com/tootsuite/mastodon/issues)

### Protocols

- [List of used specs and RFCs for the federation](Specs-and-RFCs-used.md)
- [Extensions of the above protocols](Extensions.md)
Import from main repo README (#82) * Add docker guide from main repo readme * Add maintenance tasks doc to running section * Clean up markdown in prod guide * Move guidance to use tagged releases to docs * Move local domain and host config to docs repo * Title of page * Update Production-guide.md 2017-04-18 16:32:47 +02:00			`# Mastodon documentation`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00
			`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.`

Links to folders and to the Ressources-Needed page 2017-04-18 17:06:30 +02:00			`### [Using Mastodon](Using-Mastodon)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00			`- [Frequently Asked Questions](Using-Mastodon/FAQ.md)`
			`- [List of Mastodon instances](Using-Mastodon/List-of-Mastodon-instances.md)`
			`- [Apps](Using-Mastodon/Apps.md)`
Add user guide to README toc 2017-04-02 23:05:21 +02:00			`- [User Guide](Using-Mastodon/User-guide.md)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00
Links to folders and to the Ressources-Needed page 2017-04-18 17:06:30 +02:00			`### [Using the API](Using-the-API)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00			`- [API documentation](Using-the-API/API.md)`
Moves libraries to a separate file (#229) 2017-05-11 08:35:12 +02:00			`- [Libraries](Using-the-API/Libraries.md)`
Adding documentation for streaming API. Fixing filtering bug 2017-02-02 16:35:06 +01:00			`- [Streaming API documentation](Using-the-API/Streaming-API.md)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00			`- [Testing the API with cURL](Using-the-API/Testing-with-cURL.md)`
			`- [OAuth details](Using-the-API/OAuth-details.md)`
			`- [Tips for app developers](Using-the-API/Tips-for-app-developers.md)`
Add more links to main docs page 2017-01-29 12:59:02 +01:00			`- [Push notifications](Using-the-API/Push-notifications.md)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00
Links to folders and to the Ressources-Needed page 2017-04-18 17:06:30 +02:00			`### [Running Mastodon](Running-Mastodon)`
Adds note about running off master. 2017-04-26 10:52:13 +02:00
			Please note: It is highly recommended to run a [tagged release](https://github.com/tootsuite/mastodon/releases) of Mastodon and not run off the current `master` branch.

Fixed typo (#114) 2017-04-22 00:30:33 +02:00			`- [Resources needed](Running-Mastodon/Resources-needed.md)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00			`- [Production guide](Running-Mastodon/Production-guide.md)`
Add Docker guide link to Running Mastodon Section (#92) 2017-04-19 18:37:36 +02:00			`- [Docker guide](Running-Mastodon/Docker-Guide.md)`
Add more links to main docs page 2017-01-29 12:59:02 +01:00			`- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md)`
Add separate sections for Heroku and Vagrant deployments. Add guide for instance administration. Move 'Contribution guide' to 'Development guide'. 2017-01-22 09:50:40 +01:00			`- [Development guide](Running-Mastodon/Development-guide.md)`
Add more links to main docs page 2017-01-29 12:59:02 +01:00			`- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md)`
Document Nanobox Usage To be merged after Nanobox Support is merged in the main repo: https://github.com/tootsuite/mastodon/pull/1709 2017-04-22 09:21:37 +02:00			`- [Alternative: Development _and_ Production with Nanobox](Running-Mastodon/Nanobox-Guide.md)`
Update broken links, add new sponsor 2017-01-27 17:01:21 +01:00			`- [Administration guide](Running-Mastodon/Administration-guide.md)`
Import from main repo README (#82) * Add docker guide from main repo readme * Add maintenance tasks doc to running section * Clean up markdown in prod guide * Move guidance to use tagged releases to docs * Move local domain and host config to docs repo * Title of page * Update Production-guide.md 2017-04-18 16:32:47 +02:00			`- [Maintenance Tasks](Running-Mastodon/Maintenance-Tasks.md)`
Add tuning documentation, add <content> tags back to most salmons, make status pagination headers generation more lax about next page existing 2017-02-25 03:34:37 +01:00			`- [Tuning Mastodon](Running-Mastodon/Tuning.md)`
updated readme 2017-04-15 00:56:36 +02:00			`- [System Configuration Alternatives](Running-Mastodon/Alternatives.md)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00
Links to folders and to the Ressources-Needed page 2017-04-18 17:06:30 +02:00			`### [Contributing to Mastodon](Contributing-to-Mastodon)`
Add wiki contents to docs/ instead 2017-01-21 22:49:08 +01:00			`- [Sponsors](Contributing-to-Mastodon/Sponsors.md)`
			`- [Translate Mastodon in your language](Contributing-to-Mastodon/Translating.md)`
			`- [Report bugs and submit ideas](https://github.com/tootsuite/mastodon/issues)`
Add more links to main docs page 2017-01-29 12:59:02 +01:00
			`### Protocols`

			`- [List of used specs and RFCs for the federation](Specs-and-RFCs-used.md)`
			`- [Extensions of the above protocols](Extensions.md)`