Tweak the README
This commit is contained in:
@@ -15,6 +15,8 @@
|
|||||||
|
|
||||||
**Still in early development/I do not recommend to run an instance yet.**
|
**Still in early development/I do not recommend to run an instance yet.**
|
||||||
|
|
||||||
|
<!-- start -->
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Implements a basic [ActivityPub](https://activitypub.rocks/) server (with federation)
|
- 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
|
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).
|
(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
|
### 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).
|
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
18
docs/head.html
Normal 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>
|
Reference in New Issue
Block a user