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

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

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

10
Mastodon is a free, open-source social network server. A decentralized alternative 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 12

An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.
13

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

Eugen's avatar
Eugen committed
16
[![Screenshot](https://i.imgur.com/pNieDFp.png)][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

Eugen's avatar
Eugen committed
20 21
Focus of the project on 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.

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

Eugen's avatar
Eugen committed
28 29
- [List of Mastodon instances](https://github.com/Gargron/mastodon/wiki/List-of-Mastodon-instances)
- [Use this tool to find Twitter friends on Mastodon](https://mastodon-bridge.herokuapp.com)
Eugen's avatar
Eugen committed
30 31
- [API overview](https://github.com/Gargron/mastodon/wiki/API)
- [How to use the API via cURL/oAuth](https://github.com/Gargron/mastodon/wiki/Testing-with-cURL)
32
- [Frequently Asked Questions](https://github.com/Gargron/mastodon/wiki/FAQ)
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
Eugen Rochko's avatar
Eugen Rochko committed
50

51 52 53 54 55
## Configuration

- `LOCAL_DOMAIN` should be the domain/hostname of your instance. This is **absolutely required** as it is used for generating unique IDs for everything federation-related
- `LOCAL_HTTPS` set it to `true` if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs
- `HUB_URL` should be the URL of the PubsubHubbub service that your instance is going to use. By default it is the open service of Superfeedr
56

Eugen Rochko's avatar
Eugen Rochko committed
57
Consult the example configuration file, `.env.production.sample` for the full list. Among other things you need to set details for the SMTP server you are going to use.
Eugen Rochko's avatar
Eugen Rochko committed
58

59 60 61 62
## Requirements

- PostgreSQL
- Redis
63 64 65

## Running with Docker and Docker-Compose

Eugen Rochko's avatar
Eugen Rochko committed
66
The project now includes a `Dockerfile` and a `docker-compose.yml`. You need to turn `.env.production.sample` into `.env.production` with all the variables set before you can:
67 68 69 70 71

    docker-compose build

And finally

72
    docker-compose up -d
73 74 75

As usual, the first thing you would need to do would be to run migrations:

76
    docker-compose run --rm web rails db:migrate
77 78 79

And since the instance running in the container will be running in production mode, you need to pre-compile assets:

80
    docker-compose run --rm web rails assets:precompile
81 82

The container has two volumes, for the assets and for user uploads. The default docker-compose.yml maps them to the repository's `public/assets` and `public/system` directories, you may wish to put them somewhere else. Likewise, the PostgreSQL and Redis images have data containers that you may wish to map somewhere where you know how to find them and back them up.
83

84 85 86 87 88 89 90 91 92 93 94 95 96
**Note**: The `--rm` option for docker-compose will remove the container that is created to run a one-off command after it completes. As data is stored in volumes it is not affected by that container clean-up.

### Tasks

- `rake mastodon:media:clear` removes uploads that have not been attached to any status after a while, you would want to run this from a periodic cronjob
- `rake mastodon:push:clear` unsubscribes from PuSH notifications for remote users that have no local followers. You may not want to actually do that, to keep a fuller footprint of the fediverse or in case your users will soon re-follow
- `rake mastodon:push:refresh` re-subscribes PuSH for expiring remote users, this should be run periodically from a cronjob and quite often as the expiration time depends on the particular hub of the remote user
- `rake mastodon:feeds:clear` removes all timelines, which forces them to be re-built on the fly next time a user tries to fetch their home/mentions timeline. Only for troubleshooting

Running any of these tasks via docker-compose would look like this:

    docker-compose run --rm web rake mastodon:media:clear

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
### Updating

This approach makes updating to the latest version a real breeze.

    git pull

To pull down the updates, re-run

    docker-compose build

And finally,

    docker-compose up -d

Which will re-create the updated containers, leaving databases and data as is. Depending on what files have been updated, you might need to re-run migrations and asset compilation.
Eugen Rochko's avatar
Eugen Rochko committed
112 113 114 115

### Contributing

You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. This section may be updated with more details in the future.
116 117 118 119 120 121 122

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