Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 3.36 KB

README.md

File metadata and controls

71 lines (51 loc) · 3.36 KB
Raw

microblog.pub (and then some)

Forked and modified to fit my personal needs.
As such, strong documentation for my modifications doesn't exist besides CHANGES.md.
Official upstream docs can be found at docs.microblog.pub.

builds.sr.ht status AGPL 3.0

Instances in the wild:

If you are running this fork, feel free to PR your site into this list!
Check the upstream README for a list of instances running the upstream version.
There are still some rough edges, but the server is mostly functional.

Features

  • Implements the ActivityPub server to server protocol
    • Federate with all the other popular ActivityPub servers like Pleroma, PixelFed, PeerTube, Mastodon...
    • Consume most of the content types available (notes, articles, videos, pictures...)
  • Exposes your ActivityPub profile as a minimalist microblog
    • Author notes in Markdown, with code highlighting support
    • Dedicated section for articles/blog posts (enabled when the first article is posted)
  • Lightweight
    • Uses SQLite, and Python 3.10+
    • Can be deployed on small VPS
  • Privacy-aware
    • EXIF metadata (like GPS location) are stripped before storage
    • Every media is proxied through the server
    • Strict access control for your outbox enforced via HTTP signature
  • No Javascript
    • The UI is pure HTML/CSS
    • Except tiny bits of hand-written JS in the note composer to insert emoji and add alt text to images
  • IndieWeb citizen
  • Easy to backup
    • Everything is stored in the data/ directory: config, uploads, secrets and the SQLite database.

Getting started

First familiarize yourself with the CHANGES.md list, then check out the upstream documentation.

Credits

Contributing

This fork's development takes place on GitHub. Since upstream changes are frequently pulled in, you should probably contribute there instead of here!

Upstream development takes place on sourcehut

Contributions are welcomed, check out the documentation for more details.

License

The project is licensed under the GNU AGPL v3 LICENSE (see the LICENSE file).