mastodon/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

Missing:

- Media attachments (photos, videos)
- Home timeline, notifications timeline
- UI to post, reblog, favourite, follow and unfollow
- Upload header image for profile page
- Deleting statuses, deletion propagation

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

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

Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 16:52:23 +00:00			`Current status of the project is early development. Documentation &co will be added later`
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`
Update status in readme 2016-03-06 12:00:38 +00:00
			`Missing:`

			`- Media attachments (photos, videos)`
			`- Home timeline, notifications timeline`
			`- UI to post, reblog, favourite, follow and unfollow`
			`- Upload header image for profile page`
Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 16:52:23 +00:00			`- Deleting statuses, deletion propagation`
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