documentation/README.md

45 lines
2.3 KiB
Markdown
Raw Normal View History

# Mastodon documentation
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.
### [Using Mastodon](Using-Mastodon)
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)
2017-04-02 23:05:21 +02:00
- [User Guide](Using-Mastodon/User-guide.md)
2017-01-21 22:49:08 +01:00
### [Using the API](Using-the-API)
2017-01-21 22:49:08 +01:00
- [API documentation](Using-the-API/API.md)
- [Libraries](Using-the-API/Libraries.md)
- [Streaming API documentation](Using-the-API/Streaming-API.md)
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)
2017-01-29 12:59:02 +01:00
- [Push notifications](Using-the-API/Push-notifications.md)
2017-01-21 22:49:08 +01:00
### [Running Mastodon](Running-Mastodon)
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.
2017-04-22 00:30:33 +02:00
- [Resources needed](Running-Mastodon/Resources-needed.md)
2017-01-21 22:49:08 +01:00
- [Production guide](Running-Mastodon/Production-guide.md)
- [Docker guide](Running-Mastodon/Docker-Guide.md)
2017-01-29 12:59:02 +01:00
- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md)
- [Development guide](Running-Mastodon/Development-guide.md)
2017-01-29 12:59:02 +01:00
- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md)
- [Alternative: Development _and_ Production with Nanobox](Running-Mastodon/Nanobox-Guide.md)
2017-01-27 17:01:21 +01:00
- [Administration guide](Running-Mastodon/Administration-guide.md)
- [Maintenance Tasks](Running-Mastodon/Maintenance-Tasks.md)
- [Tuning Mastodon](Running-Mastodon/Tuning.md)
2017-04-15 00:56:36 +02:00
- [System Configuration Alternatives](Running-Mastodon/Alternatives.md)
2017-01-21 22:49:08 +01:00
### [Contributing to Mastodon](Contributing-to-Mastodon)
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)
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)