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

7 8
Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

9
**Current status of the project is early development. Documentation &co will be added later**
10

Eugen Rochko's avatar
Eugen Rochko committed
11
## Status
12

Eugen Rochko's avatar
Eugen Rochko committed
13 14 15 16 17
- GNU Social users can follow Mastodon users
- Mastodon users can follow GNU Social users
- Retweets, favourites, mentions, replies work in both directions
- Public pages for profiles and single statuses
- Sign up, login, forgotten passwords and changing password
18
- Mentions and URLs converted to links in statuses
19 20
- REST API, including home and mention timelines
- OAuth2 provider system for the API
21
- Upload header image for profile page
22
- Deleting statuses, deletion propagation
Eugen Rochko's avatar
Eugen Rochko committed
23

24 25 26 27 28
## 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
29

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

32 33 34 35
## Requirements

- PostgreSQL
- Redis
36 37 38

## Running with Docker and Docker-Compose

Eugen Rochko's avatar
Eugen Rochko committed
39
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:
40 41 42 43 44

    docker-compose build

And finally

45
    docker-compose up -d
46 47 48 49

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

    docker-compose run web rake db:migrate
50 51 52 53 54 55

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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

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