microblog.pub

A self-hosted, single-user, ActivityPub powered microblog.

Still in early development.

Features

Implements a basic ActivityPub server (with federation)
- Compatible with Mastodon and others (Pleroma, Hubzilla...)
- Also implements a remote follow compatible with Mastodon instances
Exposes your outbox as a basic microblog
Implements IndieAuth endpoints (authorization and token endpoint)
- U2F support
- You can use your ActivityPub identity to login to other websites/app
Admin UI with notifications and the stream of people you follow
Allows you to attach files to your notes
- Privacy-aware image upload endpoint that strip EXIF meta data before storing the file
No JavaScript, that's it, even the admin UI is pure HTML/CSS
Easy to customize (the theme is written Sass)
- mobile-friendly theme
- with dark and light version
Microformats aware (exports h-feed, h-entry, h-cards, ...)
Exports RSS/Atom feeds
Comes with a tiny HTTP API to help posting new content and performing basic actions
Easy to "cache" (the external/public-facing microblog part)
- With a good setup, cached content can be served most of the time
- You can setup a "purge" hook to let you invalidate cache when the microblog was updated
Deployable with Docker (Docker compose for everything: dev, test and deployment)
Focus on testing
- Tested against the official ActivityPub test suite ([ ] TODO submit the report)
- CI runs some local "federation" tests
- Manually tested against Mastodon
- Project is running an up-to-date instance

ActivityPub

microblog.pub implements an ActivityPub server, it implements both the client to server API and the federated server to server API.

Compatible with Mastodon (which is not following the spec closely), but will drop OStatus messages.

Activities are verified using HTTP Signatures or by fetching the content on the remote server directly.

Running your instance

Installation

$ git clone
$ make css
$ cp -r config/me.sample.yml config/me.yml

Configuration

$ make password

Deployment

$ docker-compose up -d

Development

The most convenient way to hack on microblog.pub is to run the server locally, and run

# One-time setup
$ pip install -r requirements.txt
# Start the Celery worker, RabbitMQ and MongoDB
$ docker-compose -f docker-compose-dev.yml up -d
# Run the server locally
$ MICROBLOGPUB_DEBUG=1 FLASK_APP=app.py flask run -p 5005 --with-threads

User API

The user API is used by the admin UI (and requires a CSRF token when used with a regular user session), but it can also be accessed with an API key.

All the examples are using HTTPie.

POST /api/note/delete{?id}

Deletes the given note id.

Answers a 201 (Created) status code.

You can pass the id via JSON, form data or query argument.

Example

$ http POST https://microblog.pub/api/note/delete Authorization:'Bearer <token>' id=http://microblob.pub/outbox/<node_id>/activity

Response

{
    "activity": "https://microblog.pub/outbox/<delete_id>"
}

Contributions

PRs are welcome, please open an issue to start a discussion before your start any work.

4 KiB Raw Blame History