README.md 3.5 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 11
Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

Eugen's avatar
Eugen committed
12 13 14 15 16 17 18 19 20 21 22 23
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.

If you would like, you can [support the development of this project on Patreon][patreon].

[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
## Status
26

Eugen Rochko's avatar
Eugen Rochko committed
27 28 29 30 31
- 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
32
- Mentions and URLs converted to links in statuses
33 34
- REST API, including home and mention timelines
- OAuth2 provider system for the API
35
- Upload header image for profile page
36
- Deleting statuses, deletion propagation
Eugen's avatar
Eugen committed
37
- Real-time timelines via Websockets
Eugen Rochko's avatar
Eugen Rochko committed
38

39 40 41 42 43
## 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
44

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

47 48 49 50
## Requirements

- PostgreSQL
- Redis
51 52 53

## Running with Docker and Docker-Compose

Eugen Rochko's avatar
Eugen Rochko committed
54
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:
55 56 57 58 59

    docker-compose build

And finally

60
    docker-compose up -d
61 62 63 64

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

    docker-compose run web rake db:migrate
65 66 67 68 69 70

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.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

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