microblog.pub

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

Developer's guide

This guide assumes you have some knowledge of ActivityPub.

Architecture

Microblog.pub is a "modern" Python application with "old-school" server-rendered templates.

The server has 3 components:

Tasks

The project uses Invoke to manage tasks (a Python powered Makefile).

You can find the tasks definition in tasks.py and list the tasks using:

inv -l

Media storage

The uploads are stored in the data/ directory, using a simple content-addressed storage system (file contents hash is BLOB filename). Files metadata are stored in the database.

Installation

Running a local version requires:

You can follow the Python developer version of the install instructions.

Documentation

The documention is managed as Markdown files in docs/ and the online documentation is built using a homegrown Python script (scripts/build_docs.py).

You can build the documentation locally by running:

inv build-docs

And check out the result by starting a static server using Python standard library:

cd docs/dist
python -m http.server 8001