+
+ 
+
+ 
+
+
+#### 🐳 Вариант A: Установка через Docker
-🐳 Развертывание Docker-Рекомендуется — Без настройки Python/Node.js +> Установка Python/Node.js не требуется ---- +**Требования**: [Docker](https://docs.docker.com/get-docker/) & [Docker Compose](https://docs.docker.com/compose/install/) + +**Быстрый старт** — Сборка из исходного кода: -**Требования**: [Docker](https://docs.docker.com/get-docker/) и [Docker Compose](https://docs.docker.com/compose/install/) +```bash +docker compose up # Сборка и запуск (~11 мин при первом запуске на mac mini M4) +docker compose build --no-cache # Очистка кэша и пересборка после обновления репозитория +``` -
-
-
🚀 Вариант A: Предварительно Собранный Образ (Быстрее Всего)+**Или использовать предварительно собранный образ** (быстрее): ```bash -# Работает на всех платформах — Docker автоматически определяет вашу архитектуру +# Работает на всех платформах — Docker автоматически определяет архитектуру docker run -d --name deeptutor \ -p 8001:8001 -p 3782:3782 \ --env-file .env \ @@ -325,67 +359,74 @@ docker run -d --name deeptutor \ # Windows PowerShell: используйте ${PWD} вместо $(pwd) ``` -Или использовать файл `.env`: +**Общие команды**: ```bash -docker run -d --name deeptutor \ - -p 8001:8001 -p 3782:3782 \ - --env-file .env \ - -v $(pwd)/data:/app/data \ - -v $(pwd)/config:/app/config:ro \ - ghcr.io/hkuds/deeptutor:latest +docker compose up -d # Запуск +docker compose down # Остановка +docker compose logs -f # Просмотр логов +docker compose up --build # Пересборка после изменений ``` -
-
+> 💡 Тег `:latest` является **мультиархитектурным образом** — Docker автоматически загружает правильную версию для вашей системы (Intel/AMD или Apple Silicon/ARM)
-**Команды**:
+**Облачная установка** — Необходимо установить внешний URL-адрес API:
```bash
-docker compose up -d # Запустить
-docker compose logs -f # Логи
-docker compose down # Остановить
-docker compose up --build # Пересобрать
-docker pull ghcr.io/hkuds/deeptutor:latest # Обновить образ
+docker run -d --name deeptutor \
+ -p 8001:8001 -p 3782:3782 \
+ -e NEXT_PUBLIC_API_BASE_EXTERNAL=https://your-server.com:8001 \
+ --env-file .env \
+ -v $(pwd)/data:/app/data \
+ ghcr.io/hkuds/deeptutor:latest
```
-> **Режим Разработки**: Добавьте `-f docker-compose.dev.yml`
+**Пример пользовательских портов:**
-🔨 Вариант B: Собрать из Исходного Кода+📋 Дополнительные параметры Docker (предварительно собранные образы, облачная установка, пользовательские порты)-```bash -# Собрать и запустить (~5-10 мин при первом запуске) -docker compose up --build -d +**Теги предварительно собранных образов:** -# Просмотр логов -docker compose logs -f -``` +| Тег | Архитектуры | Описание | +|:----|:--------------|:------------| +| `:latest` | AMD64 + ARM64 | Последний стабильный выпуск (автоопределение архитектуры) | +| `:v0.5.x` | AMD64 + ARM64 | Конкретная версия (автоопределение архитектуры) | +| `:v0.5.x-amd64` | Только AMD64 | Явный образ AMD64 | +| `:v0.5.x-arm64` | Только ARM64 | Явный образ ARM64 | - |
-
+```bash
+docker run -d --name deeptutor \
+ -p 9001:9001 -p 3000:3000 \
+ -e BACKEND_PORT=9001 \
+ -e FRONTEND_PORT=3000 \
+ -e NEXT_PUBLIC_API_BASE_EXTERNAL=https://your-server.com:9001 \
+ --env-file .env \
+ -v $(pwd)/data:/app/data \
+ ghcr.io/hkuds/deeptutor:latest
+```
-💻 Ручная Установка-Для разработки или сред без Docker + --- +#### 💻 Вариант B: Ручная установка + +> Для разработки или сред без Docker + **Требования**: Python 3.10+, Node.js 18+ -**Настроить Окружение**: +**1. Настройка окружения**: ```bash -# Использовать conda (Рекомендуется) -conda create -n deeptutor python=3.10 -conda activate deeptutor +# Использование conda (Рекомендуется) +conda create -n deeptutor python=3.10 && conda activate deeptutor -# Или использовать venv -python -m venv venv -source venv/bin/activate +# Или использование venv +python -m venv venv && source venv/bin/activate # Windows: venv\Scripts\activate ``` -**Установить Зависимости**: +**2. Установка зависимостей**: ```bash # Установка в один клик (Рекомендуется) @@ -397,21 +438,39 @@ pip install -r requirements.txt npm install --prefix web ``` -**Запустить**: +**3. Запуск**: ```bash -# Запустить веб-интерфейс -python scripts/start_web.py +python scripts/start_web.py # Запуск интерфейса и бэкенда +# Или: python scripts/start.py # Только CLI +# Остановка: Ctrl+C +``` -# Или только CLI -python scripts/start.py +
+ 🔧 Запуск интерфейса и бэкенда отдельно-# Остановить: Ctrl+C +**Бэкенд** (FastAPI): +```bash +python src/api/run_server.py +# Или: uvicorn src.api.main:app --host 0.0.0.0 --port 8001 --reload ``` - |
-
+ Спасибо, что посетили ✨ DeepTutor!
+
+