README.md 4.18 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

Eugen Rochko's avatar
Eugen Rochko committed
10
Mastodon is a federated microblogging engine. An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.
11

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

14
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
15 16 17 18 19 20 21 22 23

[patreon]: https://www.patreon.com/user?u=619786

**Current status of the project is early development**

## Resources

- [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)
24

Eugen Rochko's avatar
Eugen Rochko committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
## Features

- **Fully interoperable with GNU social and any OStatus platform**  
  Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
- **Real-time timeline updates**  
  See the updates of people you're following appear in real-time in the UI via WebSockets
- **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 WebM**  
  Upload and view images and WebM videos attached to the updates
- **OAuth2 and a straightforward REST API**  
  Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
- **Background processing for long-running tasks**  
  Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
- **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
Eugen Rochko's avatar
Eugen Rochko committed
41

42 43 44 45 46
## 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
47

Eugen Rochko's avatar
Eugen Rochko committed
48 49
Consult the example configuration file, `.env.production.sample` for the full list.

50 51 52 53
## Requirements

- PostgreSQL
- Redis
54 55 56

## Running with Docker and Docker-Compose

Eugen Rochko's avatar
Eugen Rochko committed
57
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:
58 59 60 61 62

    docker-compose build

And finally

63
    docker-compose up -d
64 65 66 67

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

    docker-compose run web rake db:migrate
68 69 70 71 72 73

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

    docker-compose run web rake assets:precompile

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.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

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