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! 📖✨
2.9 KiB
2.9 KiB
Документация Quoter
📚 Оглавление
📋 Архитектура и принципы работы
- 🚀 Как работает Quoter - Подробная архитектура системы с диаграммами
- 🔀 Гибридная архитектура - Vercel Edge + Quoter integration
- 📐 Формат URL для ресайзера - Полное руководство по URL паттернам
- ⚙️ API Reference - Полная документация API
🛡️ Безопасность и настройка
- 🔒 Безопасность и защита от DDoS - Комплексная система защиты
- ⚙️ Конфигурация - Настройка переменных окружения
- 🚀 Развертывание - Инструкции по развертыванию
- 📊 Мониторинг - Логирование и мониторинг
🎨 Интеграции
- 🎨 Vercel OG Integration - Полное руководство по интеграции с @vercel/og
- ⚡ Vercel OG Quick Start - Быстрый старт за 5 минут
Технические детали
- Архитектура - Техническая архитектура системы
- База данных - Структура Redis и схемы данных
- S3 интеграция - Работа с S3/Storj
- Обработка изображений - Создание миниатюр и оверлеев
- Безопасность - Аутентификация и авторизация
Разработка
- Разработка - Настройка среды разработки
- Тестирование - Руководство по тестированию
- Contributing - Руководство для контрибьюторов
CI/CD и автоматизация
- Тестирование - Полное покрытие тестами (36 тестов)
- Развертывание - Автоматизированный конвейер
- Мониторинг - Отслеживание качества кода
🚀 Быстрый старт
- Установите зависимости:
cargo build - Настройте переменные окружения (см. Конфигурация)
- Запустите сервер:
cargo run - Проверьте API:
curl http://localhost:8080/
📋 Требования
- Rust 1.70+
- Redis 6.0+
- Доступ к S3/Storj API