26 lines
1.7 KiB
Markdown
26 lines
1.7 KiB
Markdown
|
# Image Gateway — Документация
|
||
|
|
|
||
|
|
Self-hosted прокси-сервер для обработки и кеширования изображений.
|
||
|
|
|
||
|
|
## Содержание
|
||
|
|
|
||
|
|
| Документ | Описание |
|
||
|
|
|---|---|
|
||
|
|
| [Обзор проекта](overview.md) | Что это, зачем, архитектура, компоненты |
|
||
|
|
| [Гайд использования](usage-guide.md) | Готовые кейсы: обработка, кеш, purge, подпись |
|
||
|
|
| [Руководство разработчика](dev-guide.md) | Запуск, конфигурация, переменные окружения |
|
||
|
|
| [URL-справочник](url-reference.md) | Формат URL, параметры обработки, примеры |
|
||
|
|
| [API кеша](cache-api.md) | Purge кеша, Souin API |
|
||
|
|
| [E2E тесты](e2e-tests.md) | Автоматические Docker Compose тесты кеша |
|
||
|
|
| [Чек-лист тестирования](testing-checklist.md) | Пошаговая ручная проверка всех функций |
|
||
|
|
|
||
|
|
## Быстрая навигация
|
||
|
|
|
||
|
|
- Хочу **запустить локально** → [dev-guide.md](dev-guide.md)
|
||
|
|
- Хочу **запустить и тестировать** → [usage-guide.md](usage-guide.md)
|
||
|
|
- Хочу **узнать формат URL** → [url-reference.md](url-reference.md)
|
||
|
|
- Хочу **сбросить кеш** → [cache-api.md](cache-api.md)
|
||
|
|
- Хочу **запустить автотесты** → [e2e-tests.md](e2e-tests.md)
|
||
|
|
- Хочу **протестировать вручную** → [testing-checklist.md](testing-checklist.md)
|
||
|
|
- Хочу **понять что это за проект** → [overview.md](overview.md)
|