krz/skunky-art
Alternative privacy frontend for DeviantArt.
clone: git clone https://gitbay.org/krz/skunky-art.git
v1.3.1: SETUP.md · raw
1[Версия на русском языке 🇷🇺](https://git.macaw.me/skunky/SkunkyArt/src/branch/master/SETUP-RU.md)
2
3# Units
4Maximum file size in megabytes, requires numeric value.<br>
5Time units:
6* `i` — minutes
7* `h` — hours
8* `w` — weeks
9* `m` — months
10* `y` — years
11
12# Config
13* `listen` — IP and port to listen on in the following form: ip:port
14* `uri` — Instance URI. Example: `"uri":"/art/"` -> https://skunky.ebloid.ru/art/
15* `cache` — Caching system; default is off.
16 * `enabled` — Caching system state, requires boolean value
17 * `path` — Path to cache directory, requires absolute filesystem path
18 * `lifetime` — Cached file life time, requires numeric value, followed by multiplicative suffix (see Time Units for details)
19 * `max-size` — Maximum file size in megabytes
20 * `update-interval` — Automatic rotation interval
21* `dirs-to-memory` — This setting determines which directories will be copied to RAM when SkunkyArt is started. Mandatory
22* `download-proxy` — Proxy address for downloading files.
23* `user-agent` — String, which SkunkyArt uses as UA
24
25# Setting up reverse proxy
26Pretty 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.
27
28Nginx example configuration:
29```apache
30server {
31 listen 443 ssl;
32 server_name skunky.example.com;
33
34 # In case of subdomain, use / instend of ((BASE_URL))
35 location ((BASE_URL)) {
36 proxy_set_header X-Forwarded-Proto $scheme;
37 proxy_set_header Host $host;
38 proxy_http_version 1.1;
39 proxy_pass http://((IP)):((PORT));
40 }
41}
42```