Your self-hosted, globally interconnected microblogging community

docker activitypub fediverse social-network activity-stream mastodon microblog social-web webfinger

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Eugen Rochko 44c5958203 Fixed small bugs and code style offences		10 years ago
app	Fixed small bugs and code style offences	10 years ago
bin	Initial commit	10 years ago
config	Incoming Salmon requests can be turned into follows and unfollows	10 years ago
db	Adding a Mention model, test stubs	10 years ago
lib	Initial commit	10 years ago
log	Initial commit	10 years ago
public	Initial commit	10 years ago
spec	Adding a Mention model, test stubs	10 years ago
test	Initial commit	10 years ago
vendor/assets	Initial commit	10 years ago
.gitignore	Adding a Mention model, test stubs	10 years ago
.rspec	Adding a Mention model, test stubs	10 years ago
.ruby-version	Initial commit	10 years ago
Gemfile	Adding a Mention model, test stubs	10 years ago
Gemfile.lock	Adding a Mention model, test stubs	10 years ago
README.md	Incoming Salmon requests can be turned into follows and unfollows	10 years ago
Rakefile	Initial commit	10 years ago
config.ru	Initial commit	10 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.

The core ideals of this project are:

Independence of legacy Twitter APIs - we don't want to be compatible with Twitter clients, we want our own clients
In that vein, a strong and clean REST API and OAuth2
Minimalism. Just because you can do almost anything with ActivityStreams doesn't mean you should. Limit the set of possible functions to what makes sense in a microblogging engine. This will make federation as well as UI design a lot easier
Ease of deployment. The end-goal of this project is to be distributable as a Docker image.

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

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