Tweak the README

This commit is contained in:
Thomas Sileo
2020-01-22 21:00:14 +01:00
parent 00810e61a4
commit 0ae0310f5f
2 changed files with 20 additions and 6 deletions

View File

@@ -15,6 +15,8 @@
**Still in early development/I do not recommend to run an instance yet.**
<!-- start -->
## Features
- Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation)
@@ -90,12 +92,6 @@ By default, the server will listen on `localhost:5005` (http://localhost:5005 sh
For production, you need to setup a reverse proxy (nginx, caddy) to forward your domain to the local server
(and check [certbot](https://certbot.eff.org/) for getting a free TLS certificate).
### HTTP API
See [docs/api.md](docs/api.md) for the internal HTTP API documentation.
### Backup
The easiest way to backup all of your data is to backup the `microblog.pub/` directory directly (that's what I do and I have been able to restore super easily).

18
docs/head.html Normal file
View File

@@ -0,0 +1,18 @@
<style>
body {
background: #eee;
color: #111;
}
code {
color: #111;
}
.purple, a {
color: #1d781d;
}
h1 { font-weight: bold; }
pre {
background: #e6e6e6;
padding: 10px;
overflow: auto;
}
</style>