summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorColin Reeder <colin@vpzom.click>2020-10-14 16:28:16 -0600
committerColin Reeder <colin@vpzom.click>2020-10-14 16:28:16 -0600
commit6f183c37ed24dfe1b8fc69a68f31b10bda3e49bd (patch)
treee751904188f022aba00709493227e821e0e7420a
parentd2c3c0375269a187cbae691742395f298951da88 (diff)
Update docs with new env variables
-rw-r--r--doc/INSTALL.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index 083acc6..482fb93 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -8,8 +8,14 @@ Set these environment variables:
- HOST_URL_ACTIVITYPUB - If using the recommended proxy setup, set this to your root address (`https://example.com`)
- HOST_URL_API - e.g. `https://example.com/api`
- APUB_PROXY_REWRITES - Set to `true` to make signatures work with the proxy setup.
+ - ALLOW_FORWARDED - Set to `true` to make ratelimiting work with the proxy setup.
- BACKEND_HOST - (for hitide only) Set this to a URL which hitide can use to reach lotide
+Optionally (but recommended):
+ - SMTP_URL - URL used to access SMTP server, required for sending email (e.g. `smtps://username:password@smtp.example.com`)
+ - SMTP_FROM - From value used in sent emails, required for sending email
+ - MEDIA_LOCATION - Directory on disk used for storing uploaded images. If not set, image uploads will be disabled.
+
To build lotide, run `cargo build --release` in the lotide directory. A `lotide` binary will appear in `./target/release`.
hitide can be built in the same way.
@@ -20,6 +26,9 @@ To set up the database, run `migrant setup`, then `migrant apply -a`.
This is written for Nginx, but it should be possible to adapt it to other proxy servers. Replace `c_backend_1` and `c_hitide_1` with your actual hostnames.
```
+client_max_body_size 1G;
+proxy_set_header X-Forwarded-For $remote_addr;
+
location /api {
proxy_pass http://c_backend_1:3333;
}