Eugen Rochko 9cb690c706 Access tokens no longer expire, case-insensitive local username validation, as well as case-insensitive Webfinger look-up		9 years ago
app	Access tokens no longer expire, case-insensitive local username validation, as well as case-insensitive Webfinger look-up	9 years ago
bin	Adding config for puma, dashboard layout, fixing some queries	9 years ago
config	Access tokens no longer expire, case-insensitive local username validation, as well as case-insensitive Webfinger look-up	9 years ago
db	Adding CSS for form errors, adding missing indices	9 years ago
lib	Adding simple_form, adding profile settings, header image	9 years ago
log	Initial commit	9 years ago
public	Initial commit	9 years ago
spec	Bind oauth applications to users	9 years ago
vendor/assets	Initial commit	9 years ago
.dockerignore	Respect "delete" verb on remote feeds	9 years ago
.env.production.sample	Fixing the docker container setup (with assets compilation &co)	9 years ago
.gitignore	Ignore future .env files - those should not be committed to VC! Nor be part of docker containers	9 years ago
.rspec	Adding a Mention model, test stubs	9 years ago
.ruby-version	Initial commit	9 years ago
Dockerfile	Fixing the docker container setup (with assets compilation &co)	9 years ago
Gemfile	Adding simple_form, adding profile settings, header image	9 years ago
Gemfile.lock	Adding simple_form, adding profile settings, header image	9 years ago
LICENSE	Adding GNU Public license, adding home timeline, reblog/favourite counters	9 years ago
README.md	Adjusted todo list	9 years ago
Rakefile	Initial commit	9 years ago
config.ru	Initial commit	9 years ago
docker-compose.yml	Fixing the docker container setup (with assets compilation &co)	9 years ago

README.md

Mastodon

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

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

Missing:

Media attachments (photos, videos)
Streaming API
Blocking users, blocking remote instances

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

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.