README.md 1.41 KB
Newer Older
1 2 3 4 5
Mastodon
========

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

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

Eugen Rochko's avatar
Eugen Rochko committed
8
## Status
9

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
15
- Mentions and URLs converted to links in statuses
16 17
- REST API, including home and mention timelines
- OAuth2 provider system for the API
Eugen Rochko's avatar
Eugen Rochko committed
18 19 20 21 22 23

Missing:

- Media attachments (photos, videos)
- UI to post, reblog, favourite, follow and unfollow
- Upload header image for profile page
24
- Deleting statuses, deletion propagation
25
- 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