From b9657d2013e3ccaca42206993dc188ee830dbdfc Mon Sep 17 00:00:00 2001
From: William Desportes <williamdes@wdes.fr>
Date: Sun, 6 Apr 2025 21:10:48 +0200
Subject: [PATCH] Document ENVs

---
 snow-scanner/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/snow-scanner/README.md b/snow-scanner/README.md
index d1720e3..13b9db2 100644
--- a/snow-scanner/README.md
+++ b/snow-scanner/README.md
@@ -5,5 +5,24 @@ This project name is inspired by the Netflix series "The Snowpiercer"
 ## Run it
 
 ```sh
+SERVER_ADDRESS="127.0.0.1:8777" \
+DB_URL="mysql://db-user:db-pass@db-server/db-snow-scanner" \
+STATIC_DATA_DIR="$PWD/../data" \
 cargo run --release
 ```
+
+## Run in production
+
+The env file located at `/etc/snow-scanner/.env`:
+
+```env
+# Your public IP
+SERVER_ADDRESS="[2a10:ffff:ff:ff:fff::1]:80"
+DB_URL="mysql://db-user:db-pass@db-server/db-snow-scanner"
+STATIC_DATA_DIR="/usr/share/snow-scanner/data"
+# Adjust this
+ROCKET_LOG_LEVEL="debug"
+ROCKET_PROFILE="debug"
+# Setup TLS
+ROCKET_TLS='{certs="/etc/ssl/certs/cert.pem",key="/etc/ssl/private/key.pem", mutual={ca_certs="/etc/ssl/certs/cloudflare.crt",mandatory=true}}'
+```