krz/skunky-art

Alternative privacy frontend for DeviantArt.

clone: git clone https://gitbay.org/krz/skunky-art.git

v1.3.3: SETUP.md · raw

 1# Units
 2Maximum file size in megabytes, requires numeric value.<br>
 3Time units:
 4* `i` — minutes
 5* `h` — hours
 6* `w` — weeks
 7* `m` — months
 8* `y` — years
 9
10# Config
11* `listen` — IP and port to listen on in the following form: ip:port
12* `uri` — Instance URI. Example: `"uri":"/art/"` -> https://skunky.ebloid.ru/art/
13* `cache` — Caching system; default is off.
14  * `enabled` — Caching system state, requires boolean value
15  * `path` — Path to cache directory, requires absolute filesystem path
16  * `lifetime` — Cached file life time, requires numeric value, followed by multiplicative suffix (see Time Units for details)
17  * `max-size` — Maximum file size in megabytes
18  * `update-interval` — Automatic rotation interval
19* `static-path` — This setting determines path to static, which will be copied to RAM when SkunkyArt is started. Useless if you're use binary compiled with 'embed' tag.
20* `download-proxy` — Proxy address for downloading files.
21* `user-agent` — String, which SkunkyArt uses as UA
22
23# Setting up reverse proxy
24Pretty 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.
25
26Nginx example configuration:
27```apache
28server {
29    listen 443 ssl;
30    server_name skunky.example.com;
31    
32    # In case of subdomain, use / instend of ((BASE_URL))
33    location ((BASE_URL)) {
34        proxy_set_header X-Forwarded-Proto $scheme;
35        proxy_set_header Host $host;
36        proxy_http_version 1.1;
37        proxy_pass http://((IP)):((PORT));
38    }
39}
40```