mastodon/README.md

71 lines
4.0 KiB
Markdown
Raw Normal View History

2017-07-23 00:46:10 +00:00
![Mastodon](https://i.imgur.com/NhZc40l.png)
========
2017-01-08 02:47:33 +00:00
[![Build Status](http://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/tootsuite/mastodon.svg)][code_climate]
2017-01-08 02:47:33 +00:00
[travis]: https://travis-ci.org/tootsuite/mastodon
[code_climate]: https://codeclimate.com/github/tootsuite/mastodon
2016-03-21 08:19:16 +00:00
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.
2016-10-24 10:37:06 +00:00
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)).
2016-10-05 11:37:47 +00:00
Click on the screenshot to watch a demo of the UI:
2017-06-07 15:53:47 +00:00
[![Screenshot](https://i.imgur.com/pG3Nnz3.jpg)][youtube_demo]
2016-10-05 11:37:47 +00:00
[youtube_demo]: https://www.youtube.com/watch?v=YO1jQ8_rAMU
2016-09-24 18:44:47 +00:00
2017-04-08 02:48:46 +00:00
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.
2016-09-02 12:07:21 +00:00
If you would like, you can [support the development of this project on Patreon][patreon]. Alternatively, you can donate to this BTC address: `17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd`
2016-09-02 12:07:21 +00:00
[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)
2016-10-24 10:37:06 +00:00
- [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)
2016-09-21 21:32:53 +00:00
## Features
2016-10-05 11:37:47 +00:00
- **Fully interoperable with GNU social and any OStatus platform**
2016-09-21 21:32:53 +00:00
Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
2016-10-05 11:37:47 +00:00
- **Real-time timeline updates**
2016-09-21 21:32:53 +00:00
See the updates of people you're following appear in real-time in the UI via WebSockets
2016-10-05 11:37:47 +00:00
- **Federated thread resolving**
2016-09-21 21:32:53 +00:00
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
2016-10-05 11:37:47 +00:00
- **Media attachments like images and WebM**
2016-09-21 21:32:53 +00:00
Upload and view images and WebM videos attached to the updates
2016-10-05 11:37:47 +00:00
- **OAuth2 and a straightforward REST API**
2016-09-21 21:32:53 +00:00
Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
2016-10-05 11:37:47 +00:00
- **Background processing for long-running tasks**
2016-09-21 21:32:53 +00:00
Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
2016-10-05 11:37:47 +00:00
- **Deployable via Docker**
2016-09-21 21:32:53 +00:00
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
## Development
Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
2016-03-06 12:00:38 +00:00
## Deployment
There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
## Contributing
2016-10-05 11:37:47 +00:00
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)
2016-11-28 12:40:33 +00:00
**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)