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

4
5
6
[![GitHub release](https://img.shields.io/github/release/mastodon/mastodon.svg)][releases]
[![Build Status](https://img.shields.io/circleci/project/github/mastodon/mastodon.svg)][circleci]
[![Code Climate](https://img.shields.io/codeclimate/maintainability/mastodon/mastodon.svg)][code_climate]
7
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/mastodon/localized.svg)][crowdin]
Eugen Rochko's avatar
Eugen Rochko committed
8
[![Docker Pulls](https://img.shields.io/docker/pulls/tootsuite/mastodon.svg)][docker]
9

10
11
12
[releases]: https://github.com/mastodon/mastodon/releases
[circleci]: https://circleci.com/gh/mastodon/mastodon
[code_climate]: https://codeclimate.com/github/mastodon/mastodon
13
[crowdin]: https://crowdin.com/project/mastodon
Eugen Rochko's avatar
Eugen Rochko committed
14
[docker]: https://hub.docker.com/r/tootsuite/mastodon/
Eugen Rochko's avatar
Eugen Rochko committed
15

16
Mastodon is a **free, open-source social network server** based on ActivityPub where users can follow friends and discover new ones. On Mastodon, users can publish anything they want: links, pictures, text, video. All Mastodon servers are interoperable as a federated network (users on one server can seamlessly communicate with users from another one, including non-Mastodon software that implements ActivityPub)!
Eugen's avatar
Eugen committed
17

Eugen Rochko's avatar
Eugen Rochko committed
18
Click below to **learn more** in a video:
Eugen Rochko's avatar
Eugen Rochko committed
19

Eugen Rochko's avatar
Eugen Rochko committed
20
[![Screenshot](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/ezgif-2-60f1b00403.gif)][youtube_demo]
Eugen Rochko's avatar
Eugen Rochko committed
21

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

24
## Navigation
Eugen's avatar
Eugen committed
25

Eugen Rochko's avatar
Eugen Rochko committed
26
27
28
29
30
31
32
- [Project homepage 🐘](https://joinmastodon.org)
- [Support the development via Patreon][patreon]
- [View sponsors](https://joinmastodon.org/sponsors)
- [Blog](https://blog.joinmastodon.org)
- [Documentation](https://docs.joinmastodon.org)
- [Browse Mastodon servers](https://joinmastodon.org/#getting-started)
- [Browse Mastodon apps](https://joinmastodon.org/apps)
Eugen's avatar
Eugen committed
33

Eugen Rochko's avatar
Eugen Rochko committed
34
[patreon]: https://www.patreon.com/mastodon
Eugen's avatar
Eugen committed
35

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

Eugen Rochko's avatar
Eugen Rochko committed
38
39
<img src="https://docs.joinmastodon.org/elephant.svg" align="right" width="30%" />

Eugen Rochko's avatar
Eugen Rochko committed
40
41
**No vendor lock-in: Fully interoperable with any conforming platform**

Eugen Rochko's avatar
Eugen Rochko committed
42
It doesn't have to be Mastodon, whatever implements ActivityPub is part of the social network! [Learn more](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/)
Eugen Rochko's avatar
Eugen Rochko committed
43

Eugen Rochko's avatar
Eugen Rochko committed
44
**Real-time, chronological timeline updates**
Eugen Rochko's avatar
Eugen Rochko committed
45
46
47
48
49
50
51

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

**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!

Eugen Rochko's avatar
Eugen Rochko committed
52
**Safety and moderation tools**
Eugen Rochko's avatar
Eugen Rochko committed
53

Eugen Rochko's avatar
Eugen Rochko committed
54
Private posts, locked accounts, phrase filtering, muting, blocking and all sorts of other features, along with a reporting and moderation system. [Learn more](https://blog.joinmastodon.org/2018/07/cage-the-mastodon/)
Eugen Rochko's avatar
Eugen Rochko committed
55

Eugen Rochko's avatar
Eugen Rochko committed
56
**OAuth2 and a straightforward REST API**
Eugen Rochko's avatar
Eugen Rochko committed
57

58
Mastodon acts as an OAuth2 provider so 3rd party apps can use the REST and Streaming APIs, resulting in a rich app ecosystem with a lot of choices!
Eugen Rochko's avatar
Eugen Rochko committed
59

Eugen Rochko's avatar
Eugen Rochko committed
60
## Deployment
Eugen Rochko's avatar
Eugen Rochko committed
61

Eugen Rochko's avatar
Eugen Rochko committed
62
**Tech stack:**
Eugen Rochko's avatar
Eugen Rochko committed
63

Eugen Rochko's avatar
Eugen Rochko committed
64
65
66
- **Ruby on Rails** powers the REST API and other web pages
- **React.js** and Redux are used for the dynamic parts of the interface
- **Node.js** powers the streaming API
Eugen Rochko's avatar
Eugen Rochko committed
67

Eugen Rochko's avatar
Eugen Rochko committed
68
**Requirements:**
69

Eugen Rochko's avatar
Eugen Rochko committed
70
- **PostgreSQL** 9.5+
71
72
- **Redis** 4+
- **Ruby** 2.5+
73
- **Node.js** 12+
Eugen Rochko's avatar
Eugen Rochko committed
74

trwnh's avatar
trwnh committed
75
The repository includes deployment configurations for **Docker and docker-compose**, but also a few specific platforms like **Heroku**, **Scalingo**, and **Nanobox**. The [**stand-alone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
76

Eugen Rochko's avatar
Eugen Rochko committed
77
A **Vagrant** configuration is included for development purposes.
78

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

BenisonSebastian's avatar
BenisonSebastian committed
81
Mastodon is **free, open-source software** licensed under **AGPLv3**.
Eugen Rochko's avatar
Eugen Rochko committed
82

83
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository, or submit translations using Crowdin. To get started, take a look at [CONTRIBUTING.md](CONTRIBUTING.md). If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).
84

85
**IRC channel**: #mastodon on irc.libera.chat
Eugen Rochko's avatar
Eugen Rochko committed
86

87
88
## License

Sean's avatar
Sean committed
89
Copyright (C) 2016-2021 Eugen Rochko & other Mastodon contributors (see [AUTHORS.md](AUTHORS.md))
90
91
92
93
94
95

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/>.