README.md 3.88 KB
Newer Older
Eugen Rochko's avatar
Eugen Rochko committed
1
![Mastodon](https://i.imgur.com/NhZc40l.png)
2 3
========

4 5
[![Build Status](https://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/maintainability/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

Eugen Rochko's avatar
Eugen Rochko committed
10
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. The technical focus of the project is a good user interface, a clean REST API for 3rd party apps and robust anti-abuse tools.
Eugen's avatar
Eugen committed
11

Eugen Rochko's avatar
Eugen Rochko committed
12
Click on the screenshot below to watch a demo of the UI:
Eugen Rochko's avatar
Eugen Rochko committed
13

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

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

Eugen Rochko's avatar
Eugen Rochko committed
18
**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
19

20
If you would like, you can [support the development of this project on Patreon][patreon] or [Liberapay][liberapay]. Alternatively, you can donate to this BTC address: `17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd`
Eugen's avatar
Eugen committed
21 22

[patreon]: https://www.patreon.com/user?u=619786
23
[liberapay]: https://liberapay.com/Mastodon/
Eugen's avatar
Eugen committed
24

Eugen Rochko's avatar
Eugen Rochko committed
25 26
---

Eugen's avatar
Eugen committed
27 28
## Resources

29
- [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
Eugen Rochko's avatar
Eugen Rochko committed
30 31 32
- [Use this tool to find Twitter friends on Mastodon](https://bridge.joinmastodon.org)
- [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
- [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
33
- [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
Eugen Rochko's avatar
Eugen Rochko committed
34
- [List of sponsors](https://joinmastodon.org/sponsors)
35

Eugen Rochko's avatar
Eugen Rochko committed
36 37
## Features

Eugen Rochko's avatar
Eugen Rochko committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
**No vendor lock-in: Fully interoperable with any conforming platform**

It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!

**Real-time timeline updates**

See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!

**Federated thread resolving**

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

**Media attachments like images and short videos**

Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos are looped - like vines!

**OAuth2 and a straightforward REST API**

Mastodon acts as an OAuth2 provider so 3rd party apps can use the API

**Fast response times**

Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing

**Deployable via Docker**

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

---

68 69 70
## 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
71

Matt Jankowski's avatar
Matt Jankowski committed
72
## Deployment
73

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

76
## Contributing
Eugen Rochko's avatar
Eugen Rochko committed
77

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

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

Eugen Rochko's avatar
Eugen Rochko committed
82
---
83

Eugen Rochko's avatar
Eugen Rochko committed
84
## Extra credits
85

Eugen Rochko's avatar
Eugen Rochko committed
86
The elephant friend illustrations are created by [Dopatwo](https://mastodon.social/@dopatwo)