README.md 3.97 KB
Newer Older
1 2 3
Mastodon
========

Eugen's avatar
Eugen committed
4 5
[![Build Status](http://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/tootsuite/mastodon.svg)][code_climate]
6

Eugen's avatar
Eugen committed
7 8
[travis]: https://travis-ci.org/tootsuite/mastodon
[code_climate]: https://codeclimate.com/github/tootsuite/mastodon
Eugen Rochko's avatar
Eugen Rochko committed
9

10
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.
Eugen's avatar
Eugen committed
11

Matt Jankowski's avatar
Matt Jankowski committed
12
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)).
13

Eugen Rochko's avatar
Eugen Rochko committed
14 15
Click on the screenshot to watch a demo of the UI:

Eugen Rochko's avatar
Eugen Rochko committed
16
[![Screenshot](https://i.imgur.com/pG3Nnz3.jpg)][youtube_demo]
Eugen Rochko's avatar
Eugen Rochko committed
17 18

[youtube_demo]: https://www.youtube.com/watch?v=YO1jQ8_rAMU
Eugen's avatar
Eugen committed
19

rbaumert's avatar
rbaumert committed
20
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 committed
21

22
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 committed
23 24 25 26 27

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

## Resources

28
- [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
Eugen's avatar
Eugen committed
29
- [Use this tool to find Twitter friends on Mastodon](https://mastodon-bridge.herokuapp.com)
30 31 32
- [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)
33

Eugen Rochko's avatar
Eugen Rochko committed
34 35
## Features

Eugen Rochko's avatar
Eugen Rochko committed
36
- **Fully interoperable with GNU social and any OStatus platform**
Eugen Rochko's avatar
Eugen Rochko committed
37
  Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
Eugen Rochko's avatar
Eugen Rochko committed
38
- **Real-time timeline updates**
Eugen Rochko's avatar
Eugen Rochko committed
39
  See the updates of people you're following appear in real-time in the UI via WebSockets
Eugen Rochko's avatar
Eugen Rochko committed
40
- **Federated thread resolving**
Eugen Rochko's avatar
Eugen Rochko committed
41
  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 committed
42
- **Media attachments like images and WebM**
Eugen Rochko's avatar
Eugen Rochko committed
43
  Upload and view images and WebM videos attached to the updates
Eugen Rochko's avatar
Eugen Rochko committed
44
- **OAuth2 and a straightforward REST API**
Eugen Rochko's avatar
Eugen Rochko committed
45
  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 committed
46
- **Background processing for long-running tasks**
Eugen Rochko's avatar
Eugen Rochko committed
47
  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 committed
48
- **Deployable via Docker**
Eugen Rochko's avatar
Eugen Rochko committed
49
  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
50 51 52 53
  
## Development

Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
Eugen Rochko's avatar
Eugen Rochko committed
54

Matt Jankowski's avatar
Matt Jankowski committed
55
## Deployment
56

Matt Jankowski's avatar
Matt Jankowski committed
57
There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
58

59
## Contributing
Eugen Rochko's avatar
Eugen Rochko committed
60

61
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)
62

Eugen Rochko's avatar
Eugen Rochko committed
63 64
**IRC channel**: #mastodon on irc.freenode.net

65
## Extra credits
66 67 68 69 70

- 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)