6a961e899f
* Clarify Docker instructions for prebuilt images Made clear there are two options for getting the Docker image: pulling the prebuilt image, or building your own. Using a prebuilt image is easier for anyone who hasn't made code changes on their instance. * Fix errors in Docker prebuilt image instructions |
||
|---|---|---|
| Contributing-to-Mastodon | ||
| Maintaining-Mastodon | ||
| Running-Mastodon | ||
| Using-Mastodon | ||
| Using-the-API | ||
| Extensions.md | ||
| LICENSE | ||
| README.md | ||
| Specs-and-RFCs-used.md | ||
README.md
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
masterbranch.
- Before you start: Examples of resource usage from other live instances
- If you want to use Docker: Installation using Docker
- If you want to run it standalone: Standalone installation
- There are other options:
- After installation:
- Advanced:
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:
Contributing to Mastodon
- 🎉 List of Sponsors - thank you to these people! 🎉
- Translate Mastodon to your language
- Report bugs and submit ideas