https://github.com/arkanosis/microstatus

Lightweight Mastodon- and GNU social-compatible ActivityPub and OStatus server implementation
https://github.com/arkanosis/microstatus

activitypub gnu-social mastodon microblog mstd ostatus social-network

Last synced: 6 days ago
JSON representation

Lightweight Mastodon- and GNU social-compatible ActivityPub and OStatus server implementation

• Host: GitHub
• URL: https://github.com/arkanosis/microstatus
• Owner: Arkanosis
• License: isc
• Created: 2017-04-11T23:56:29.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-08T20:26:01.000Z (about 2 years ago)
• Last Synced: 2024-04-13T21:03:22.578Z (9 months ago)
• Topics: activitypub, gnu-social, mastodon, microblog, mstd, ostatus, social-network
• Language: Rust
• Homepage: https://microstatus.org/
• Size: 79.1 KB
• Stars: 169
• Watchers: 14
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# microstatus [![](https://img.shields.io/crates/v/microstatus.svg)](https://crates.io/crates/microstatus) [![License](https://img.shields.io/badge/license-ISC-blue.svg)](/LICENSE) [![Build status](https://travis-ci.org/Arkanosis/microstatus.svg?branch=master)](https://travis-ci.org/Arkanosis/microstatus)

**microstatus** is a lightweight [Mastodon](https://github.com/tootsuite/mastodon)- and [GNU social](https://gnu.io/social/)-compatible [OStatus](https://www.w3.org/community/ostatus/) and [ActivityPub](https://www.w3.org/TR/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](https://docs.gotosocial.org/):

* 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 

       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](https://github.com/Arkanosis/microstatus/pulls).

Please report bugs and feature requests on [GitHub issues](https://github.com/Arkanosis/microstatus/issues).

## License

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