2022-06-22 18:11:22 +00:00
# microblog.pub
2022-07-09 17:26:18 +00:00
A self-hosted, single-user, ActivityPub powered microblog.
2022-07-02 08:33:27 +00:00
[](https://builds.sr.ht/~tsileo/microblog.pub?)
2022-07-04 17:02:06 +00:00
[](https://git.sr.ht/~tsileo/microblog.pub/tree/v2/item/LICENSE)
2022-07-02 08:33:27 +00:00
2022-07-30 07:43:36 +00:00
Instances in the wild:
2022-06-22 18:11:22 +00:00
2022-07-30 07:43:36 +00:00
- [microblog.pub ](https://microblog.pub/ ) (follow to get updated about the project)
- [hexa.ninja ](https://hexa.ninja ) (theme customization example)
- [testing.microblog.pub ](https://testing.microblog.pub/ )
2023-01-07 08:42:33 +00:00
- [Irish Left Archive ](https://posts.leftarchive.ie/ ) (another theme customization example)
2022-07-04 20:00:19 +00:00
2022-07-30 07:43:36 +00:00
There are still some rough edges, but the server is mostly functional.
2022-07-09 07:59:25 +00:00
## Features
- Implements the [ActivityPub ](https://activitypub.rocks/ ) 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
2022-07-30 07:43:36 +00:00
- Dedicated section for articles/blog posts (enabled when the first article is posted)
2022-07-09 07:59:25 +00:00
- Lightweight
2022-10-10 09:05:36 +00:00
- Uses SQLite, and Python 3.10+
2022-07-09 07:59:25 +00:00
- 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
2022-07-21 20:43:06 +00:00
- Except tiny bits of hand-written JS in the note composer to insert emoji and add alt text to images
2022-07-09 07:59:25 +00:00
- IndieWeb citizen
2022-07-11 20:01:37 +00:00
- [IndieAuth ](https://www.w3.org/TR/indieauth/ ) support (OAuth2 extension)
- [Microformats ](http://microformats.org/wiki/Main_Page ) everywhere
2022-07-17 18:43:56 +00:00
- [Micropub ](https://www.w3.org/TR/micropub/ ) support
2022-07-11 20:01:37 +00:00
- Sends and processes [Webmentions ](https://www.w3.org/TR/webmention/ )
- RSS/Atom/[JSON](https://www.jsonfeed.org/) feed
- Easy to backup
- Everything is stored in the `data/` directory: config, uploads, secrets and the SQLite database.
## Getting started
Check out the [online documentation ](https://docs.microblog.pub ).
## Credits
- Emoji from [Twemoji ](https://twemoji.twitter.com/ )
- Awesome custom goose emoji from [@pamela@bsd.network ](https://bsd.network/@pamela )
## Contributing
All the development takes place on [sourcehut ](https://sr.ht/~tsileo/microblog.pub/ ), GitHub is only used as a mirror:
- [Project ](https://sr.ht/~tsileo/microblog.pub/ )
- [Issue tracker ](https://todo.sr.ht/~tsileo/microblog.pub )
- [Mailing list ](https://sr.ht/~tsileo/microblog.pub/lists )
2022-11-15 21:22:56 +00:00
Contributions are welcomed, check out the [contributing section of the documentation ](https://docs.microblog.pub/developer_guide.html#contributing ) for more details.
2022-07-11 20:01:37 +00:00
## License
The project is licensed under the GNU AGPL v3 LICENSE (see the LICENSE file).
