Untone
b876564f4a
### New Documentation: - **URL Format Guide**: Complete guide for image resizer URL patterns - **Hybrid Architecture**: Vercel Edge + Quoter integration strategy - **Updated How-it-works**: Comprehensive system architecture with diagrams - **Enhanced Configuration**: Security settings, troubleshooting, Vercel integration ### Documentation Structure: 📋 Architecture & Principles: - 🚀 How Quoter Works (detailed system architecture) - 🔀 Hybrid Architecture (Vercel + Quoter best practices) - 📐 URL Format (complete resizer URL guide) 🛡️ Security & Configuration: - 🔒 Security & DDoS Protection (comprehensive guide) - ⚙️ Configuration (updated with new settings) - 🚀 Deployment & 📊 Monitoring 🎨 Integrations: - Vercel OG Integration guides - Edge Function examples ### Key Features Documented: - Complete URL patterns for image resizing - Security rate limiting configuration - Hybrid upload (Quoter) + download (Vercel) strategy - JWT validation and session management - Multi-cloud storage (Storj + AWS fallback) - Performance optimization techniques - Production deployment strategies All documentation is now production-ready and includes practical examples! 📖✨
49 lines
2.9 KiB
Markdown
49 lines
2.9 KiB
Markdown
# Документация Quoter
|
||
|
||
## 📚 Оглавление
|
||
|
||
### 📋 Архитектура и принципы работы
|
||
- [🚀 Как работает Quoter](./how-it-works.md) - Подробная архитектура системы с диаграммами
|
||
- [🔀 Гибридная архитектура](./hybrid-architecture.md) - Vercel Edge + Quoter integration
|
||
- [📐 Формат URL для ресайзера](./url-format.md) - Полное руководство по URL паттернам
|
||
- [⚙️ API Reference](./api-reference.md) - Полная документация API
|
||
|
||
### 🛡️ Безопасность и настройка
|
||
- [🔒 Безопасность и защита от DDoS](./security.md) - Комплексная система защиты
|
||
- [⚙️ Конфигурация](./configuration.md) - Настройка переменных окружения
|
||
- [🚀 Развертывание](./deployment.md) - Инструкции по развертыванию
|
||
- [📊 Мониторинг](./monitoring.md) - Логирование и мониторинг
|
||
|
||
### 🎨 Интеграции
|
||
- [🎨 Vercel OG Integration](./vercel-og-integration.md) - Полное руководство по интеграции с @vercel/og
|
||
- [⚡ Vercel OG Quick Start](./vercel-og-quickstart.md) - Быстрый старт за 5 минут
|
||
|
||
### Технические детали
|
||
- [Архитектура](./architecture.md) - Техническая архитектура системы
|
||
- [База данных](./database.md) - Структура Redis и схемы данных
|
||
- [S3 интеграция](./s3-integration.md) - Работа с S3/Storj
|
||
- [Обработка изображений](./image-processing.md) - Создание миниатюр и оверлеев
|
||
- [Безопасность](./security.md) - Аутентификация и авторизация
|
||
|
||
### Разработка
|
||
- [Разработка](./development.md) - Настройка среды разработки
|
||
- [Тестирование](./testing.md) - Руководство по тестированию
|
||
- [Contributing](./contributing.md) - Руководство для контрибьюторов
|
||
|
||
### CI/CD и автоматизация
|
||
- [Тестирование](./testing.md) - Полное покрытие тестами (36 тестов)
|
||
- [Развертывание](./deployment.md) - Автоматизированный конвейер
|
||
- [Мониторинг](./monitoring.md) - Отслеживание качества кода
|
||
|
||
## 🚀 Быстрый старт
|
||
|
||
1. Установите зависимости: `cargo build`
|
||
2. Настройте переменные окружения (см. [Конфигурация](./configuration.md))
|
||
3. Запустите сервер: `cargo run`
|
||
4. Проверьте API: `curl http://localhost:8080/`
|
||
|
||
## 📋 Требования
|
||
|
||
- Rust 1.70+
|
||
- Redis 6.0+
|
||
- Доступ к S3/Storj API |