2.32 KB
Newer Older
1 2 3 4 5

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

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

Eugen Rochko's avatar
Eugen Rochko committed
## Status

Eugen Rochko's avatar
Eugen Rochko committed
10 11 12 13 14
- 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
- Mentions and URLs converted to links in statuses
16 17
- REST API, including home and mention timelines
- OAuth2 provider system for the API
- Upload header image for profile page
- Deleting statuses, deletion propagation
Eugen Rochko's avatar
Eugen Rochko committed
20 21 22 23 24


- Media attachments (photos, videos)
- UI to post, reblog, favourite, follow and unfollow
- Streaming API
26 27 28 29 30 31

## 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
32 33 34 35 36

## Requirements

- PostgreSQL
- Redis
37 38 39 40 41 42 43 44 45 46 47 48 49 50

## Running with Docker and Docker-Compose

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:

    docker-compose build

And finally

    docker-compose up

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

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

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.