Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.34 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.34 KB
Raw

microstatus License Build status

microstatus is a lightweight Mastodon- and GNU social-compatible OStatus and ActivityPub server implementation.

Current Status

microstatus is still under active design and not yet ready for mainstream usage.

If you need something that's mostly usable today and can't wait for microstatus to be ready, have a look at GoToSocial:

  • while still alpha software, it's already deployable and usable;
  • it's very lightweight, self-contained and easy to deploy;
  • it federates with Mastodon.

Design goals

microstatus aims at the following objectives:

  • provide a complete, standard compliant implementation of the OStatus and ActivityPub protocols;
  • be extremely lightweight, self-contained and easy to deploy;
  • federate with Mastodon and GNU social instances (at least);
  • use a hackable, UNIX-friendly storage format;
  • come with a nice client API.

microstatus (nice to have) non-goals include:

  • providing a scalable implementation of the OStatus and ActivityPub protocols;
  • handling billions of users;
  • being compatible with Mastodon's, GNU social's or Twitter's client API;
  • coming with a nice web or mobile UI.

Compilation

Run cargo build --release in your working copy.

Installation

Copy the microstatus binary wherever you want.

Usage

Usage: microstatus <working-directory>
       microstatus -h | --help
       microstatus --version

Arguments:
    working-directory working directory (file storage)

Options:
    -h, --help  Show this screen.
    --version   Show version.

Contributing and reporting bugs

Contributions are welcome through GitHub pull requests.

Please report bugs and feature requests on GitHub issues.

License

microstatus is copyright (C) 2017-2022 Jérémie Roquet [email protected] and licensed under the ISC license.