845ed4ad99
db:setup is used in all guides except Docker Guide, which uses db:migrate to create the database. db:setup is actually superior over db:migrate for the purpose in terms of performance and compatibility. db:setup is performant because it does not perform redundant migrations. db:migrate, on the other hand, executes migration code which will be dismissed by later migrations. db:migrate also waits for seconds to allow to interrupt migrations if it is not favorable to run them on a running server, but db:setup is obviously executed on a instance which is not running yet, and the wait is unnecessary. db:migrate has a compatibility issue. It requires a compatibility layer to keep it working, and such one may be broken, or not provided by dependencies such as Paperclip. This commit replaces db:migrate with db:setup in the building guide. The procedure cannot be applied to migration from an older release, where the old procedure could, but it is not problematic because it has dedicated Updating section. |
||
---|---|---|
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
master
branch.
- 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