mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
fix: release QA hardening across processing, media, security, and CI gates (#649)
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
This commit is contained in:
@@ -1,8 +1,9 @@
|
||||
---
|
||||
description: "Все переменные окружения SnapOtter со значениями по умолчанию. Настройте аутентификацию, хранилище, AI-модели, аналитику и не только."
|
||||
i18n_source_hash: 8e9e9ca2840c
|
||||
i18n_source_hash: 25970c776f7c
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 0a35f86cfc5b
|
||||
i18n_output_hash: e12d29a98fd6
|
||||
i18n_hash_version: 2
|
||||
---
|
||||
|
||||
# Конфигурация {#configuration}
|
||||
@@ -19,28 +20,51 @@ i18n_output_hash: 0a35f86cfc5b
|
||||
| `RATE_LIMIT_PER_MIN` | `1000` | Максимум запросов в минуту с одного IP. Установите 0, чтобы отключить ограничение частоты запросов. |
|
||||
| `CORS_ORIGIN` | (пусто) | Разделённый запятыми список разрешённых источников для CORS или пусто только для того же источника. |
|
||||
| `LOG_LEVEL` | `info` | Подробность журнала. Одно из: `fatal`, `error`, `warn`, `info`, `debug`, `trace`. |
|
||||
| `TRUST_PROXY` | `true` | Доверять заголовкам `X-Forwarded-For` от обратного прокси. Установите `false`, если прокси нет. |
|
||||
| `TRUST_PROXY` | `loopback,linklocal,uniquelocal` | Каким узлам разрешено задавать IP клиента через `X-Forwarded-For`. Значение по умолчанию верит только узлу из частной сети, поэтому обратному прокси в сети Docker или в локальной сети доверие есть, а поддельному заголовку от публичного клиента нет. Указывайте `true`, только если перед сервером стоит подконтрольный вам прокси с публичным адресом. |
|
||||
|
||||
### Аутентификация {#authentication}
|
||||
|
||||
Две булевы переменные ниже принимают только `true` и `false`. Всё остальное, будь то `1`, `yes` или `on`, не проходит проверку, и сервер завершает работу, не начав принимать соединения.
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `AUTH_ENABLED` | `false` | Установите `true`, чтобы требовать вход. Образ Docker по умолчанию использует `true`. |
|
||||
| `AUTH_ENABLED` | `true` | Требовать вход. Установите `false`, чтобы работать вообще без учётных записей: тогда любой запрос получает права администратора, поэтому оставляйте так только в доверенной сети. |
|
||||
| `DEFAULT_USERNAME` | `admin` | Имя пользователя для начальной учётной записи администратора. Используется только при первом запуске. |
|
||||
| `DEFAULT_PASSWORD` | `admin` | Пароль для начальной учётной записи администратора. Смените его после первого входа. |
|
||||
| `MAX_USERS` | `0` (без ограничений) | Максимальное число зарегистрированных учётных записей пользователей. Установите 0 для отсутствия ограничений. |
|
||||
| `SESSION_DURATION_HOURS` | `168` | Время жизни сессии входа в часах (по умолчанию 7 дней). |
|
||||
| `SKIP_MUST_CHANGE_PASSWORD` | - | Установите любое непустое значение, чтобы обойти принудительный запрос на смену пароля при первом входе |
|
||||
| `SKIP_MUST_CHANGE_PASSWORD` | `false` | Установите `true`, чтобы пропустить принудительный запрос на смену пароля при первом входе. |
|
||||
|
||||
### Хранилище {#storage}
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `STORAGE_MODE` | `local` | `local` или `s3`. S3/MinIO требует лицензию с функцией s3_storage. |
|
||||
| `DATABASE_URL` | `postgres://snapotter:snapotter@postgres:5432/snapotter` | Строка подключения PostgreSQL. |
|
||||
| `REDIS_URL` | `redis://redis:6379` | Строка подключения Redis (используется для очередей задач BullMQ). |
|
||||
| `WORKSPACE_PATH` | `./tmp/workspace` | Каталог для временных файлов во время обработки. Очищается автоматически. |
|
||||
| `FILES_STORAGE_PATH` | `./data/files` | Каталог для постоянных файлов пользователя (загруженные изображения, сохранённые результаты). |
|
||||
| `STORAGE_MODE` | `local` | `local` или `s3`. Для S3 и MinIO нужна лицензия с функцией s3_storage, а также переменные `S3_*` ниже. |
|
||||
| `DATABASE_URL` | `postgres://snapotter:snapotter@localhost:5432/snapotter` | Строка подключения PostgreSQL. Стек Compose направляет её на свой сервис `postgres`; оставьте её незаданной (вместе с `REDIS_URL`), чтобы получить встроенный режим. |
|
||||
| `REDIS_URL` | `redis://localhost:6379` | Строка подключения Redis (используется для очередей задач BullMQ). Compose направляет её на свой сервис `redis`. |
|
||||
| `WORKSPACE_PATH` | `./tmp/workspace` | Каталог для временных файлов во время обработки. Очищается автоматически. В образе задан `/tmp/workspace`. |
|
||||
| `FILES_STORAGE_PATH` | `./data/files` | Каталог для постоянных файлов пользователя (загруженные изображения, сохранённые результаты). В образе задан `/data/files`. |
|
||||
|
||||
### Объектное хранилище S3 {#s3-object-storage}
|
||||
|
||||
Читается, только когда задано `STORAGE_MODE=s3`. Пропустите любую из трёх обязательных переменных, и запуск завершится ошибкой с именем той переменной, которую вы не задали.
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `S3_BUCKET` | (пусто) | Бакет, в котором хранятся загрузки и результаты. Обязательная. |
|
||||
| `S3_ACCESS_KEY_ID` | (пусто) | Ключ доступа. Обязательная. В контейнере его можно вместо этого смонтировать файлом через `S3_ACCESS_KEY_ID_FILE`. |
|
||||
| `S3_SECRET_ACCESS_KEY` | (пусто) | Секретный ключ. Обязательная. То же соглашение о файлах: `S3_SECRET_ACCESS_KEY_FILE`. |
|
||||
| `S3_REGION` | `us-east-1` | Регион бакета. |
|
||||
| `S3_ENDPOINT` | (пусто) | Собственная конечная точка для MinIO, R2, Backblaze и других S3-совместимых хранилищ. Пусто означает AWS. |
|
||||
| `S3_FORCE_PATH_STYLE` | `false` | Установите `true` для MinIO и всего остального, что ожидает `endpoint/bucket/key` вместо адресации по виртуальному хосту. |
|
||||
| `S3_PREFIX` | (пусто) | Префикс ключей, чтобы один бакет мог обслуживать несколько экземпляров. |
|
||||
|
||||
### Шифрование данных при хранении {#encryption-at-rest}
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `DATA_ENCRYPTION_KEY` | (пусто) | 64 шестнадцатеричных символа (32 байта). Шифрует конфиденциальные настройки, хранящиеся в базе данных. Всё, что не является 64 шестнадцатеричными символами, отклоняется при запуске. |
|
||||
| `DATA_ENCRYPTION_KEY_PREVIOUS` | (пусто) | Ключ, от которого вы уходите при ротации, в том же формате. Задайте оба на время ротации, чтобы существующие строки по-прежнему расшифровывались, а затем уберите этот. |
|
||||
|
||||
### Встроенный режим {#embedded-mode}
|
||||
|
||||
@@ -59,16 +83,15 @@ i18n_output_hash: 0a35f86cfc5b
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `MAX_UPLOAD_SIZE_MB` | `100` | Максимальный размер файла на одну загрузку в мегабайтах. Установите 0 для отсутствия ограничений. |
|
||||
| `MAX_BATCH_SIZE` | `100` | Максимальное число файлов в одном пакетном запросе. Установите 0 для отсутствия ограничений. |
|
||||
| `MAX_UPLOAD_SIZE_MB` | `0` (без ограничений) | Максимальный размер файла на одну загрузку в мегабайтах. Установите 0 для отсутствия ограничений. Публикуемый образ поставляется со значением `0`; сборка из исходников начинает со 100. |
|
||||
| `MAX_BATCH_SIZE` | `0` (без ограничений) | Максимальное число файлов в одном пакетном запросе. Установите 0 для отсутствия ограничений. Публикуемый образ поставляется со значением `0`; сборка из исходников начинает со 100. |
|
||||
| `CONCURRENT_JOBS` | `0` (авто) | Число пакетных задач, выполняемых параллельно. Установите 0 для автоопределения по числу доступных ядер CPU. |
|
||||
| `MAX_MEGAPIXELS` | `0` (без ограничений) | Максимальное разрешение изображения в мегапикселях. Установите 0 для отсутствия ограничений. |
|
||||
| `MAX_WORKER_THREADS` | `0` (авто) | Максимальное число потоков-воркеров для обработки изображений. Установите 0 для автоопределения по числу доступных ядер CPU. |
|
||||
| `PROCESSING_TIMEOUT_S` | `0` (без ограничения) | Максимальное время обработки на запрос в секундах. Установите 0 для отсутствия тайм-аута. |
|
||||
| `MAX_PIPELINE_STEPS` | `20` | Максимальное число шагов в конвейере. Установите 0 для отсутствия ограничения. |
|
||||
| `MAX_CANVAS_PIXELS` | `0` (без ограничения) | Максимальный размер холста в пикселях для выходных изображений. Установите 0 для отсутствия ограничения. |
|
||||
| `MAX_SVG_SIZE_MB` | `0` (без ограничений) | Максимальный размер файла SVG в мегабайтах. Установите 0 для отсутствия ограничений. |
|
||||
| `MAX_SPLIT_GRID` | `100` | Максимальная размерность сетки для инструмента разбиения изображения. |
|
||||
| `MAX_SVG_SIZE_MB` | `50` | Наибольший SVG, принимаемый до очистки, в мегабайтах. Здесь `0` ведёт себя не так, как в соседних строках: он полностью снимает ограничение размера до разбора, а не поднимает его, поэтому эту переменную лучше оставить заданной. |
|
||||
| `MAX_PDF_PAGES` | `0` (без ограничений) | Максимальное число страниц PDF для преобразования PDF в изображение. Установите 0 для отсутствия ограничений. |
|
||||
|
||||
### Очистка {#cleanup}
|
||||
@@ -82,7 +105,7 @@ i18n_output_hash: 0a35f86cfc5b
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|---|---|---|
|
||||
| `DEFAULT_THEME` | `light` | Тема по умолчанию для новых сессий. `light` или `dark`. |
|
||||
| `DEFAULT_THEME` | `light` | Тема по умолчанию для новых сессий. `light`, `dark` или `system`. |
|
||||
| `DEFAULT_LOCALE` | `en` | Язык интерфейса по умолчанию. |
|
||||
| `DEFAULT_TOOL_VIEW` | `sidebar` | Макет инструментов по умолчанию. `sidebar` или `fullscreen`. |
|
||||
|
||||
@@ -124,13 +147,13 @@ services:
|
||||
image: postgres:17-alpine
|
||||
environment:
|
||||
POSTGRES_USER: snapotter
|
||||
POSTGRES_PASSWORD: snapotter
|
||||
POSTGRES_PASSWORD: snapotter # Измените это для нелокальных развертываний.
|
||||
POSTGRES_DB: snapotter
|
||||
volumes:
|
||||
- SnapOtter-pgdata:/var/lib/postgresql/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U snapotter"]
|
||||
test: ["CMD-SHELL", "pg_isready -U snapotter -d snapotter"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 12
|
||||
|
||||
Reference in New Issue
Block a user