krz/skunky-art

 1[English version 🇬🇧](/skunky/SkunkyArt/src/branch/master/SETUP.md)
 2
 3# Единицы измерения
 4Размер файла в кеше измеряется в мегабайтах.<br>
 5Единицы времени:
 6* `i` — минуты
 7* `h` — часы
 8* `w` — недели
 9* `m` — месяца
10* `y` — года
11
12# Конфигурация
13* `listen` — IP и порт для слушанья; заполняется по такой форме: ip:port
14* `uri` — URI инстанса. Пример: `"uri":"/art/"` -> https://skunky.ebloid.ru/art/
15* `cache` — Система кеширования; по умолчанию выключена
16  * `enabled` — Состояние системы кеширования; требуется булёвое значение
17  * `path` — Полный путь до каталога, куда будет сохраняться кеш
18  * `lifetime` — Время жизни файла в кеше, требует целочисленное значение, дополненное суффиксом времени (см. 'Единицы времени')
19  * `max-size` — Максимальный размер файла
20  * `update-interval` — Интервал для автоматической ротации кеша
21* `static-path` — Строка, являющаяся путём до статики. SkunkyArt при запуске скопирует содержимое этого каталога в ОЗУ. Однако, если вы собрали фронтенд с тегом 'embed', то этого не произайдёт
22* `download-proxy` — Адрес прокси для загрузки файлов
23* `user-agent` — Строка, которая используется в качестве User-Agent'а
24
25# Настройка обратного прокси
26Если вы собираетесь хостить инстанс в Интернете, то вам следует настроить заголовок прокси [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto). В противном случае, все ссылки на вашем инстансе будут вида "http". Ниже есть информация о том, как настроить обратное проксирование:
27
28Nginx:
29```apache
30server {
31    listen 443 ssl;
32    server_name skunky.example.com;
33    
34    # Если используется поддомен, то вместо ((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```