forks/microblog.pub
1
0
Fork 1
mirror of https://git.sr.ht/~tsileo/microblog.pub synced 2024-12-22 05:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

Tweak the README

Browse source
This commit is contained in:
Thomas Sileo 2018-05-20 12:28:11 +02:00
parent 20656259e9
commit eb9d7c6896
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -6,25 +6,26 @@
width="200" height="200" border="0" alt="microblog.pub">
</p>
<p align="center">
<a href="https://github.com/tsileo/microblog.pub/releases"><img src="https://img.shields.io/badge/version-1.0.0-green.svg?" alt="Version"></a>
<a href="https://travis-ci.org/tsileo/microblog.pub"><img src="https://travis-ci.org/tsileo/microblog.pub.svg?branch=master" alt="Build Status"></a>
<a href="https://github.com/tsileo/microblog.pub/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-AGPL_3.0-green.svg?style=flat" alt="License"></a>
<a href="https://github.com/tsileo/microblog.pub/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-AGPL_3.0-blue.svg?style=flat" alt="License"></a>
</p>
<p align="center">A self-hosted, single-user, <a href="https://activitypub.rocks">ActivityPub</a> powered microblog.</p>
**Still in early development.**
## Features
- Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation)
- Compatible with [Mastodon](https://github.com/tootsuite/mastodon) and others (Pleroma, Hubzilla...)
- Also implements a remote follow compatible with Mastodon instances
- Expose your outbox as a basic microblog
- [IndieAuth](https://indieauth.spec.indieweb.org/) endpoints (authorization and token endpoint)
- Exposes your outbox as a basic microblog
- Implements [IndieAuth](https://indieauth.spec.indieweb.org/) 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
- Attach files to your notes
- Privacy-aware upload that strip EXIF meta data before storing the file
- 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)
- Microformats aware (exports `h-feed`, `h-entry`, `h-cards`, ...)
@ -39,6 +40,7 @@
```shell
$ git clone
$ make css
$ cp -r config/me.sample.yml config/me.yml
```
### Configuration
@ -53,8 +55,6 @@ $ make password
$ docker-compose up -d
```
You should use a reverse proxy...
## Development
The most convenient way to hack on microblog.pub is to run the server locally, and run