Merge pull request #4 from qwertzipups/patch-1

Update README.md
This commit is contained in:
Gervasio Marchand 2022-12-15 13:08:49 -08:00 committed by GitHub
commit c884146b40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -67,6 +67,8 @@ services:
restart: always restart: always
volumes: volumes:
- '/local/path/to/data:/data' - '/local/path/to/data:/data'
ports:
- 5000:5000
cli: cli:
image: 'ghcr.io/g3rv4/fakerelay:latest' image: 'ghcr.io/g3rv4/fakerelay:latest'
volumes: volumes:
@ -75,6 +77,35 @@ services:
That will store the configuration files at `/local/path/to/data` (they are a couple json files). That will store the configuration files at `/local/path/to/data` (they are a couple json files).
### Setup SSL reverse proxy
The relay needs to be accessible via a domain name with https. The subdomain can be served via a reverse proxy that also handles the SSL encryption.
#### Nginx config file
```
server {
listen 443 ssl http2;
listen [::]:443 http2 ssl;
# Uncomment and change these lines if you want to restrict access to fakerelay
# allow Your-Instance-IPv6-address;
# allow Your-Instance-IPv4-address;
# allow GetMoarFediverse-Container-IP;
# deny all;
server_name relay.domain.tld;
location / {
proxy_pass http://127.0.0.1:5000;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
proxy_max_temp_file_size 0;
}
#ssl_certificate /etc/letsencrypt/live/relay.domain.tld/fullchain.pem; # managed by Certbot
#ssl_certificate_key /etc/letsencrypt/live/relay.domain.tld/privkey.pem; # managed by Certbot
}
```
### Configure the app ### Configure the app
The first time you run this it needs to create a key, you can trigger that using: The first time you run this it needs to create a key, you can trigger that using: