jonny/microblog.pub
1
0
Fork 0
forked from forks/microblog.pub
Code Pull requests Activity

More README tweaks

Browse source
This commit is contained in:
Thomas Sileo 2019-04-22 12:56:43 +02:00
parent d885f45e3e
commit cdc364f028
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -73,6 +73,9 @@ $ cd microblog.pub
$ make config $ make config
``` ```
Once the initial configuration is done, you can still tweak the config by editing `config/me.yml` directly.
### Deployment ### Deployment
To spawn the docker-compose project (running this command will also update _microblog.pub_ to latest and restart the project it it's already running): To spawn the docker-compose project (running this command will also update _microblog.pub_ to latest and restart the project it it's already running):
@ -81,15 +84,23 @@ To spawn the docker-compose project (running this command will also update _micr
$ make run $ make run
``` ```
By default, the server will listen on `localhost:5005` (http://localhost:5005 should work if you're running locally).
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 ### HTTP API
See [docs/api.md](docs/api.md) for the internal HTTP API documentation. 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).
It should be safe to copy the directory while the Docker compose project is running. It should be safe to copy the directory while the Docker compose project is running.
## Development ## Development
The project requires Python3.7+. The project requires Python3.7+.