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

4
[![Build Status](https://img.shields.io/circleci/project/github/tootsuite/mastodon.svg)][circleci]
5
[![Code Climate](https://img.shields.io/codeclimate/maintainability/tootsuite/mastodon.svg)][code_climate]
Eugen Rochko's avatar
Eugen Rochko committed
6
[![Translation status](https://weblate.joinmastodon.org/widgets/mastodon/-/svg-badge.svg)][weblate]
7

8
[circleci]: https://circleci.com/gh/tootsuite/mastodon
Eugen's avatar
Eugen committed
9
[code_climate]: https://codeclimate.com/github/tootsuite/mastodon
Eugen Rochko's avatar
Eugen Rochko committed
10
[weblate]: https://weblate.joinmastodon.org/engage/mastodon/
Eugen Rochko's avatar
Eugen Rochko committed
11

Eugen Rochko's avatar
Eugen Rochko committed
12
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
13

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

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

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

Eugen Rochko's avatar
Eugen Rochko committed
20
**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] or [Liberapay][liberapay].
Eugen's avatar
Eugen committed
23 24

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

Eugen Rochko's avatar
Eugen Rochko committed
27 28
---

Eugen's avatar
Eugen committed
29 30
## Resources

31
- [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
Eugen Rochko's avatar
Eugen Rochko committed
32 33 34
- [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)
35
- [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
Eugen Rochko's avatar
Eugen Rochko committed
36
- [List of sponsors](https://joinmastodon.org/sponsors)
37

Eugen Rochko's avatar
Eugen Rochko committed
38 39
## Features

Eugen Rochko's avatar
Eugen Rochko committed
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 68 69
**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

---

70 71 72
## 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
73

Matt Jankowski's avatar
Matt Jankowski committed
74
## Deployment
75

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

78
## Contributing
Eugen Rochko's avatar
Eugen Rochko committed
79

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

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

84 85 86 87 88 89 90 91 92 93
## License

Copyright (C) 2016-2018 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Eugen Rochko's avatar
Eugen Rochko committed
94
---
95

Eugen Rochko's avatar
Eugen Rochko committed
96
## Extra credits
97

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