From c5514c3875b9b782688047d547dfd6663a5b77bb Mon Sep 17 00:00:00 2001
From: lost+skunk <skunky@ebloid.ru>
Date: Thu, 1 Aug 2024 22:48:05 +0300
Subject: v1.3

---
 SETUP.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 SETUP.md

(limited to 'SETUP.md')

diff --git a/SETUP.md b/SETUP.md
new file mode 100644
index 0000000..ab30165
--- /dev/null
+++ b/SETUP.md
@@ -0,0 +1,42 @@
+[Версия на русском языке 🇷🇺](https://git.macaw.me/skunky/SkunkyArt/src/branch/master/SETUP-RU.md)
+
+# Units
+Maximum file size in megabytes, requires numeric value.<br>
+Time units:
+* `i` — minutes
+* `h` — hours
+* `w` — weeks
+* `m` — months
+* `y` — years
+
+# Config
+* `listen` — IP and port to listen on in the following form: ip:port
+* `uri` — Instance URI. Example: `"uri":"/art/"` -> https://skunky.ebloid.ru/art/
+* `cache` — Caching system; default is off.
+  * `enabled` — Caching system state, requires boolean value
+  * `path` — Path to cache directory, requires absolute filesystem path
+  * `lifetime` — Cached file life time, requires numeric value, followed by multiplicative suffix (see Time Units for details)
+  * `max-size` — Maximum file size in megabytes
+  * `update-interval` — Automatic rotation interval
+* `dirs-to-memory` — This setting determines which directories will be copied to RAM when SkunkyArt is started. Mandatory
+* `download-proxy` — Proxy address for downloading files.
+* `user-agent` — String, which SkunkyArt uses as UA
+
+# Setting up reverse proxy
+Pretty much business as usual, except for the [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto) header setting.
+
+Nginx example configuration:
+```apache
+server {
+    listen 443 ssl;
+    server_name skunky.example.com;
+    
+    # In case of subdomain, use / instend of ((BASE_URL))
+    location ((BASE_URL)) {
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header Host $host;
+        proxy_http_version 1.1;
+        proxy_pass http://((IP)):((PORT));
+    }
+}
+```
\ No newline at end of file
-- 
cgit v1.2.3