mirror of
https://github.com/getnora-io/nora.git
synced 2026-04-12 12:40:31 +00:00
docs: add bilingual onboarding (EN/RU)
This commit is contained in:
190
deploy/README.md
190
deploy/README.md
@@ -1,57 +1,187 @@
|
|||||||
# NORA Demo Deployment
|
# NORA Demo Deployment
|
||||||
|
|
||||||
## DNS Setup
|
[English](#english) | [Русский](#russian)
|
||||||
|
|
||||||
Add A record:
|
---
|
||||||
```
|
|
||||||
demo.getnora.io → <VPS_IP>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deploy
|
<a name="english"></a>
|
||||||
|
## English
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run NORA with Docker
|
||||||
|
docker run -d \
|
||||||
|
--name nora \
|
||||||
|
-p 4000:4000 \
|
||||||
|
-v nora-data:/data \
|
||||||
|
ghcr.io/getnora-io/nora:latest
|
||||||
|
|
||||||
|
# Check health
|
||||||
|
curl http://localhost:4000/health
|
||||||
|
```
|
||||||
|
|
||||||
|
### Push Docker Images
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Tag your image
|
||||||
|
docker tag myapp:v1 localhost:4000/myapp:v1
|
||||||
|
|
||||||
|
# Push to NORA
|
||||||
|
docker push localhost:4000/myapp:v1
|
||||||
|
|
||||||
|
# Pull from NORA
|
||||||
|
docker pull localhost:4000/myapp:v1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use as Maven Repository
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<!-- pom.xml -->
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>nora</id>
|
||||||
|
<url>http://localhost:4000/maven2/</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use as npm Registry
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm config set registry http://localhost:4000/npm/
|
||||||
|
npm install lodash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use as PyPI Index
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install --index-url http://localhost:4000/simple/ requests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Production Deployment with HTTPS
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone repo
|
|
||||||
git clone https://github.com/getnora-io/nora.git
|
git clone https://github.com/getnora-io/nora.git
|
||||||
cd nora/deploy
|
cd nora/deploy
|
||||||
|
|
||||||
# Start
|
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
|
|
||||||
# Check logs
|
|
||||||
docker compose logs -f
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## URLs
|
### URLs
|
||||||
|
|
||||||
- **Web UI:** https://demo.getnora.io/ui/
|
| URL | Description |
|
||||||
- **API Docs:** https://demo.getnora.io/api-docs
|
|-----|-------------|
|
||||||
- **Health:** https://demo.getnora.io/health
|
| `/ui/` | Web UI |
|
||||||
|
| `/api-docs` | Swagger API Docs |
|
||||||
|
| `/health` | Health Check |
|
||||||
|
| `/metrics` | Prometheus Metrics |
|
||||||
|
|
||||||
## Docker Usage
|
### Environment Variables
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
|----------|---------|-------------|
|
||||||
|
| `NORA_HOST` | 127.0.0.1 | Bind address |
|
||||||
|
| `NORA_PORT` | 4000 | Port |
|
||||||
|
| `NORA_STORAGE_PATH` | data/storage | Storage path |
|
||||||
|
| `NORA_AUTH_ENABLED` | false | Enable auth |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<a name="russian"></a>
|
||||||
|
## Русский
|
||||||
|
|
||||||
|
### Быстрый старт
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Tag and push
|
# Запуск NORA в Docker
|
||||||
docker tag myimage:latest demo.getnora.io/myimage:latest
|
docker run -d \
|
||||||
docker push demo.getnora.io/myimage:latest
|
--name nora \
|
||||||
|
-p 4000:4000 \
|
||||||
|
-v nora-data:/data \
|
||||||
|
ghcr.io/getnora-io/nora:latest
|
||||||
|
|
||||||
# Pull
|
# Проверка работоспособности
|
||||||
docker pull demo.getnora.io/myimage:latest
|
curl http://localhost:4000/health
|
||||||
```
|
```
|
||||||
|
|
||||||
## Management
|
### Загрузка Docker образов
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Stop
|
# Тегируем образ
|
||||||
|
docker tag myapp:v1 localhost:4000/myapp:v1
|
||||||
|
|
||||||
|
# Пушим в NORA
|
||||||
|
docker push localhost:4000/myapp:v1
|
||||||
|
|
||||||
|
# Скачиваем из NORA
|
||||||
|
docker pull localhost:4000/myapp:v1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Использование как Maven репозиторий
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<!-- pom.xml -->
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>nora</id>
|
||||||
|
<url>http://localhost:4000/maven2/</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Использование как npm реестр
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm config set registry http://localhost:4000/npm/
|
||||||
|
npm install lodash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Использование как PyPI индекс
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install --index-url http://localhost:4000/simple/ requests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Продакшен с HTTPS
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/getnora-io/nora.git
|
||||||
|
cd nora/deploy
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
### Эндпоинты
|
||||||
|
|
||||||
|
| URL | Описание |
|
||||||
|
|-----|----------|
|
||||||
|
| `/ui/` | Веб-интерфейс |
|
||||||
|
| `/api-docs` | Swagger документация |
|
||||||
|
| `/health` | Проверка здоровья |
|
||||||
|
| `/metrics` | Метрики Prometheus |
|
||||||
|
|
||||||
|
### Переменные окружения
|
||||||
|
|
||||||
|
| Переменная | По умолчанию | Описание |
|
||||||
|
|------------|--------------|----------|
|
||||||
|
| `NORA_HOST` | 127.0.0.1 | Адрес привязки |
|
||||||
|
| `NORA_PORT` | 4000 | Порт |
|
||||||
|
| `NORA_STORAGE_PATH` | data/storage | Путь хранилища |
|
||||||
|
| `NORA_AUTH_ENABLED` | false | Включить авторизацию |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Management / Управление
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Stop / Остановить
|
||||||
docker compose down
|
docker compose down
|
||||||
|
|
||||||
# Restart
|
# Restart / Перезапустить
|
||||||
docker compose restart
|
docker compose restart
|
||||||
|
|
||||||
# View logs
|
# Logs / Логи
|
||||||
docker compose logs -f nora
|
docker compose logs -f nora
|
||||||
docker compose logs -f caddy
|
|
||||||
|
|
||||||
# Update
|
# Update / Обновить
|
||||||
docker compose pull
|
docker compose pull && docker compose up -d
|
||||||
docker compose up -d
|
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user