119 lines
5.8 KiB
Markdown
119 lines
5.8 KiB
Markdown
# Quoter 🚀
|
||
|
||
[](https://www.rust-lang.org/)
|
||
[](https://actix.rs/)
|
||
[](https://redis.io/)
|
||
[](https://aws.amazon.com/s3/)
|
||
[](LICENSE)
|
||
|
||
> Микросервис для управления файлами с поддержкой квот, миниатюр и интеграции с S3 хранилищами
|
||
|
||
Quoter - это высокопроизводительный сервис для загрузки и управления файлами, построенный на Rust с использованием Actix Web. Поддерживает автоматическое создание миниатюр, управление квотами пользователей и интеграцию с различными S3-совместимыми хранилищами.
|
||
|
||
## 📖 Документация
|
||
|
||
Подробная документация доступна в папке [`docs/`](./docs/):
|
||
|
||
### Основные разделы
|
||
- [📚 Оглавление](./docs/README.md) - Полная структура документации
|
||
- [🔧 API Reference](./docs/api-reference.md) - Документация API
|
||
- [⚙️ Конфигурация](./docs/configuration.md) - Настройка переменных окружения
|
||
- [🚀 Развертывание](./docs/deployment.md) - Инструкции по развертыванию
|
||
- [📊 Мониторинг](./docs/monitoring.md) - Логирование и мониторинг
|
||
|
||
### Технические детали
|
||
- [🏗️ Архитектура](./docs/architecture.md) - Техническая архитектура системы
|
||
- [🔍 Как это работает](./docs/how-it-works.md) - Подробное описание процессов
|
||
- [💻 Разработка](./docs/development.md) - Настройка среды разработки
|
||
- [🤝 Contributing](./docs/contributing.md) - Руководство для контрибьюторов
|
||
|
||
## ✨ Основные возможности
|
||
|
||
- 🔐 **Аутентификация** через JWT токены
|
||
- 📁 **Загрузка файлов** в S3/Storj с автоматическим определением MIME-типов
|
||
- 🖼️ **Автоматические миниатюры** для изображений (10, 40, 110, 300, 600, 800, 1400px)
|
||
- 💾 **Управление квотами** пользователей (5 ГБ по умолчанию)
|
||
- 🎨 **Оверлеи для shout** с автоматическим наложением текста
|
||
- 🔄 **CORS поддержка** для веб-приложений
|
||
- ⚡ **Высокая производительность** благодаря асинхронной архитектуре
|
||
- 📊 **Мониторинг и логирование** всех операций
|
||
|
||
## 🏗️ Архитектура
|
||
|
||
Quoter построен на современном стеке технологий:
|
||
|
||
- **Backend**: Rust + Actix Web
|
||
- **База данных**: Redis для квот и кэширования
|
||
- **Хранилище**: S3-совместимые сервисы (Storj, AWS S3)
|
||
- **Аутентификация**: JWT токены через GraphQL API
|
||
- **Обработка изображений**: image-rs + imageproc
|
||
|
||
## 📋 Требования
|
||
|
||
- **Rust**: 1.70 или выше
|
||
- **Redis**: 6.0 или выше
|
||
- **S3 совместимое хранилище**: Storj, AWS S3 или другое
|
||
- **API ядра**: для аутентификации и получения данных shout
|
||
|
||
## 🔧 Использование
|
||
|
||
### Переменные окружения
|
||
|
||
Подробная информация о настройке переменных окружения доступна в [документации по конфигурации](./docs/configuration.md).
|
||
|
||
### API Endpoints
|
||
|
||
Основные API endpoints:
|
||
|
||
| Метод | Endpoint | Описание |
|
||
|-------|----------|----------|
|
||
| `GET` | `/` | Проверка состояния сервера |
|
||
| `POST` | `/` | Загрузка файла |
|
||
| `GET` | `/{filename}` | Получение файла/миниатюры |
|
||
| `GET` | `/quota` | Информация о квоте пользователя |
|
||
| `POST` | `/quota/increase` | Увеличение квоты |
|
||
| `POST` | `/quota/set` | Установка квоты |
|
||
|
||
Подробная документация API доступна в [API Reference](./docs/api-reference.md).
|
||
|
||
### Примеры использования
|
||
|
||
#### Загрузка файла
|
||
```bash
|
||
curl -X POST http://localhost:8080/ \
|
||
-H "Authorization: Bearer your-token" \
|
||
-F "file=@image.jpg"
|
||
```
|
||
|
||
#### Получение миниатюры
|
||
```bash
|
||
curl http://localhost:8080/image_300.jpg
|
||
```
|
||
|
||
#### Увеличение квоты
|
||
```bash
|
||
curl -X POST http://localhost:8080/quota/increase \
|
||
-H "Authorization: Bearer your-token" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"user_id": "user123", "additional_bytes": 1073741824}'
|
||
```
|
||
|
||
## 🧪 Разработка
|
||
|
||
```bash
|
||
cargo build # сборка
|
||
cargo test # запуск тестов
|
||
cargo clippy # Проверка кода
|
||
cargo fmt # Форматирование
|
||
RUST_LOG=debug cargo run # подробные логи
|
||
```
|
||
|
||
### Метрики
|
||
|
||
Основные метрики для мониторинга:
|
||
|
||
- Количество загруженных файлов
|
||
- Использование квот пользователями
|
||
- Время ответа API
|
||
- Ошибки аутентификации
|
||
- Ошибки загрузки в S3 |