Glitch-Shrike/README.md

Mastodon
========

[![Build Status](http://img.shields.io/travis/Gargron/goldfinger.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/Gargron/mastodon.svg)][code_climate]

[travis]: https://travis-ci.org/Gargron/mastodon
[code_climate]: https://codeclimate.com/github/Gargron/mastodon

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

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)

## Status

- 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
- REST API, including home and mention timelines
- OAuth2 provider system for the API
- Upload header image for profile page
- Deleting statuses, deletion propagation
- Real-time timelines via Websockets

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

Consult the example configuration file, `.env.production.sample` for the full list.

## Requirements

- PostgreSQL
- Redis

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

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

    docker-compose run web rake db:migrate

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.

### 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.
Improved Atom rendering templates, added README 2016-02-23 12:08:01 +00:00			`Mastodon`
			`========`

Updating badges [ci skip] 2016-03-21 08:17:40 +00:00			`[![Build Status](http://img.shields.io/travis/Gargron/goldfinger.svg)][travis]`
			`[![Code Climate](https://img.shields.io/codeclimate/github/Gargron/mastodon.svg)][code_climate]`
Fix typo on /api/accounts/:id/statuses, fix potential case-sensitivity issue when registering incoming status mentions, add Travis CI file 2016-03-18 22:23:19 +00:00
Linking badges [skip ci] 2016-03-21 08:19:16 +00:00			`[travis]: https://travis-ci.org/Gargron/mastodon`
			`[code_climate]: https://codeclimate.com/github/Gargron/mastodon`

Improved Atom rendering templates, added README 2016-02-23 12:08:01 +00:00			`Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.`

Update README.md 2016-09-02 12:07:21 +00:00			`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)`
Improved Atom rendering templates, added README 2016-02-23 12:08:01 +00:00
Update status in readme 2016-03-06 12:00:38 +00:00			`## Status`
Improved Atom rendering templates, added README 2016-02-23 12:08:01 +00:00
Update status in readme 2016-03-06 12:00:38 +00:00			`- 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`
Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 16:52:23 +00:00			`- Mentions and URLs converted to links in statuses`
Adding simple_form, adding profile settings, header image 2016-03-12 19:47:22 +00:00			`- REST API, including home and mention timelines`
			`- OAuth2 provider system for the API`
Adding a docker-compose template for running Mastodon easily 2016-03-14 20:39:39 +00:00			`- Upload header image for profile page`
Deleting statuses, deletion propagation 2016-03-16 09:58:58 +00:00			`- Deleting statuses, deletion propagation`
Update README.md 2016-09-02 12:07:21 +00:00			`- Real-time timelines via Websockets`
Update status in readme 2016-03-06 12:00:38 +00:00
Incoming Salmon requests can be turned into follows and unfollows 2016-02-23 21:17:07 +00:00			`## 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
Adding simple_form, adding profile settings, header image 2016-03-12 19:47:22 +00:00
Improved readme 2016-03-16 12:00:25 +00:00			Consult the example configuration file, `.env.production.sample` for the full list.

Adding simple_form, adding profile settings, header image 2016-03-12 19:47:22 +00:00			`## Requirements`

			`- PostgreSQL`
			`- Redis`
Adding a docker-compose template for running Mastodon easily 2016-03-14 20:39:39 +00:00
			`## Running with Docker and Docker-Compose`

Improved readme 2016-03-16 12:00:25 +00:00			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:
Adding a docker-compose template for running Mastodon easily 2016-03-14 20:39:39 +00:00
			`docker-compose build`

			`And finally`

Adding section on updating to the latest version [ci skip] 2016-03-19 00:14:55 +00:00			`docker-compose up -d`
Adding a docker-compose template for running Mastodon easily 2016-03-14 20:39:39 +00:00
			`As usual, the first thing you would need to do would be to run migrations:`

			`docker-compose run web rake db:migrate`
Fixing the docker container setup (with assets compilation &co) 2016-03-16 11:57:01 +00:00
			`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.
Adding section on updating to the latest version [ci skip] 2016-03-19 00:14:55 +00:00
			`### 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.`