README updated with -root_url and sample systemd unit file

This commit is contained in:
Gerdriaan Mulder 2019-12-28 18:47:20 +01:00
parent 095348d614
commit ac2c62f9e6
1 changed files with 18 additions and 1 deletions

View File

@ -24,7 +24,7 @@ are the exceptions:
## Database ## Database
We will be using [`go.etcd.io/bbolt`]. This file should be the *only* file We use [`go.etcd.io/bbolt`]. This file should be the *only* file
apart from our monolithic binary. All settings and keys should go in here. apart from our monolithic binary. All settings and keys should go in here.
Any read-only data resides in the binary file (possibly compressed). Any read-only data resides in the binary file (possibly compressed).
@ -114,8 +114,25 @@ server {
proxy_pass http://127.0.0.1:8000; proxy_pass http://127.0.0.1:8000;
proxy_set_header Host rushlink.local; proxy_set_header Host rushlink.local;
proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1; proxy_http_version 1.1;
} }
} }
``` ```
`rushlink` automatically detects whether `http` or `https` is used when
`X-Forwarded-Proto` is correctly set. Otherwise, pass `-root_url
https://rushlink.local` to the binary (e.g. in the `systemd` unit file).
## Sample `systemd` unit file
```
[Install]
WantedBy=nginx.service
[Service]
Type=simple
User=rushlink
Group=nogroup
ExecStart=/var/lib/rushlink/rushlink -database /var/lib/rushlink/db -file-store /var/lib/rushlink/filestore -root_url https://rushlink.local
```