Skip to content
Extraits de code Groupes Projets
README.md 3,78 ko
Newer Older
Eugen's avatar
Eugen a validé
[![Build Status](http://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/tootsuite/mastodon.svg)][code_climate]
Eugen's avatar
Eugen a validé
[travis]: https://travis-ci.org/tootsuite/mastodon
[code_climate]: https://codeclimate.com/github/tootsuite/mastodon
Eugen Rochko's avatar
Eugen Rochko a validé

Mastodon is a free, open-source social network server. A decentralized solution 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.
Matt Jankowski's avatar
Matt Jankowski a validé
An alternative implementation of the GNU social project. Based on [ActivityStreams](https://en.wikipedia.org/wiki/Activity_Streams_(format)), [Webfinger](https://en.wikipedia.org/wiki/WebFinger), [PubsubHubbub](https://en.wikipedia.org/wiki/PubSubHubbub) and [Salmon](https://en.wikipedia.org/wiki/Salmon_(protocol)).
Eugen Rochko's avatar
Eugen Rochko a validé
Click on the screenshot to watch a demo of the UI:

Eugen's avatar
Eugen a validé
[![Screenshot](https://i.imgur.com/T2q5V65.png)][youtube_demo]
Eugen Rochko's avatar
Eugen Rochko a validé

[youtube_demo]: https://www.youtube.com/watch?v=YO1jQ8_rAMU
Eugen's avatar
Eugen a validé

rbaumert's avatar
rbaumert a validé
The project focus is a clean REST API and a good user interface. Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.
Eugen's avatar
Eugen a validé

If you would like, you can [support the development of this project on Patreon][patreon]. Alternatively, you can donate to this BTC address: `17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd`
Eugen's avatar
Eugen a validé

[patreon]: https://www.patreon.com/user?u=619786

## Resources

- [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
Eugen's avatar
Eugen a validé
- [Use this tool to find Twitter friends on Mastodon](https://mastodon-bridge.herokuapp.com)
- [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
- [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
- [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
Eugen Rochko's avatar
Eugen Rochko a validé
## Features

Eugen Rochko's avatar
Eugen Rochko a validé
- **Fully interoperable with GNU social and any OStatus platform**
Eugen Rochko's avatar
Eugen Rochko a validé
  Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
Eugen Rochko's avatar
Eugen Rochko a validé
- **Real-time timeline updates**
Eugen Rochko's avatar
Eugen Rochko a validé
  See the updates of people you're following appear in real-time in the UI via WebSockets
Eugen Rochko's avatar
Eugen Rochko a validé
- **Federated thread resolving**
Eugen Rochko's avatar
Eugen Rochko a validé
  If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
Eugen Rochko's avatar
Eugen Rochko a validé
- **Media attachments like images and WebM**
Eugen Rochko's avatar
Eugen Rochko a validé
  Upload and view images and WebM videos attached to the updates
Eugen Rochko's avatar
Eugen Rochko a validé
- **OAuth2 and a straightforward REST API**
Eugen Rochko's avatar
Eugen Rochko a validé
  Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
Eugen Rochko's avatar
Eugen Rochko a validé
- **Background processing for long-running tasks**
Eugen Rochko's avatar
Eugen Rochko a validé
  Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
Eugen Rochko's avatar
Eugen Rochko a validé
- **Deployable via Docker**
Eugen Rochko's avatar
Eugen Rochko a validé
  You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy
Matt Jankowski's avatar
Matt Jankowski a validé
## Deployment
Matt Jankowski's avatar
Matt Jankowski a validé
There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
## Contributing
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. [Here are the guidelines for code contributions](CONTRIBUTING.md)
Eugen Rochko's avatar
Eugen Rochko a validé
**IRC channel**: #mastodon on irc.freenode.net

## Extra credits

- The [Emoji One](https://github.com/Ranks/emojione) pack has been used for the emojis
- The error page image courtesy of [Dopatwo](https://www.youtube.com/user/dopatwo)

![Mastodon error image](https://mastodon.social/oops.png)