docs: update README and docs with strict Quick Start (docker-compose-prod), fix WebSocket paths, enforce strict tone

This commit is contained in:
2025-09-04 13:43:10 +03:00
parent afa2829872
commit 7ccdf75bab
15 changed files with 825 additions and 131 deletions

View File

@@ -7,7 +7,7 @@
LogBoard+ - это современная веб-панель для мониторинга и просмотра логов Docker контейнеров в реальном времени. Приложение идеально подходит для локальной разработки, позволяя разработчикам всегда держать логи микросервисов перед глазами на втором мониторе.
### 🎯 **Идеально для локальной разработки**
### Идеально для локальной разработки
LogBoard+ особенно полезен для разработчиков, работающих с микросервисной архитектурой:
@@ -16,7 +16,7 @@ LogBoard+ особенно полезен для разработчиков, р
- **Мониторинг в реальном времени** - Видите проблемы сразу, как они возникают
- **Централизованный просмотр** - Все логи в одном месте, а не в десятках терминалов
### 🐳 **Оптимизирован для Docker и Docker Compose**
### Оптимизирован для Docker и Docker Compose
Если ваша инфраструктура основана на Docker и Docker Compose, LogBoard+ станет незаменимым инструментом:
@@ -26,13 +26,13 @@ LogBoard+ особенно полезен для разработчиков, р
- **Multi-view режим** - одновременный просмотр логов нескольких контейнеров
- **Интеграция с Docker API** - прямая работа с контейнерами
### 🚀 **Производительность и удобство**
### Производительность и удобство
Приложение предоставляет удобный веб-интерфейс для работы с логами микросервисов, поддерживает множественные проекты Docker Compose и включает в себя функции безопасности.
## Быстрый старт
### Установка
### Вариант A: Разработка
```bash
# Клонирование репозитория
@@ -40,17 +40,50 @@ git clone <repository-url>
cd logboard
# Настройка переменных окружения
cp env.example .env
make setup
# Запуск приложения
docker compose up --build -d
make up
```
### Доступ
### Вариант B: Продакшен (пример docker-compose-prod.yaml)
- **URL:** http://localhost:9001
- **Пользователь:** `admin`
- **Пароль:** `admin` (обязательно измените в продакшене!)
```yaml
services:
logboard:
image: docker.io/inecs/logboard:v1
container_name: logboard
environment:
LOGBOARD_PORT: "9001"
LOGBOARD_TAIL: "500"
LOGBOARD_USER: "admin"
LOGBOARD_PASS: "admin"
LOGBOARD_SNAPSHOT_DIR: "/app/snapshots"
LOGBOARD_STATIC_DIR: "/app/static"
LOGBOARD_INDEX_HTML: "./app/templates/index.html"
TZ_TS: "Europe/Moscow"
DOCKER_HOST: "unix:///var/run/docker.sock"
SECRET_KEY: "your-secret-key-here"
ENCRYPTION_KEY: "your-encryption-key-here"
LOG_LEVEL: "INFO"
LOG_FORMAT: "json"
DEBUG_MODE: "false"
AUTH_ENABLED: "true"
SESSION_TIMEOUT: "3600"
ports:
- "9001:9001"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- ./snapshots:/app/snapshots
restart: unless-stopped
user: 0:0
```
После запуска интерфейс доступен по адресу: http://localhost:9001
Учетные данные по умолчанию:
- Пользователь: `admin`
- Пароль: `admin` (обязательно измените в продакшене)
## Документация
@@ -106,35 +139,35 @@ docker compose up --build -d
## Скриншоты
### 🔐 Страница входа
### Страница входа
| Светлая тема | Темная тема |
|--------------|-------------|
| ![Вход - светлая тема](../screenshots/login-white.png) | ![Вход - темная тема](../screenshots/login-dark.png) |
### 📊 Основной интерфейс
### Основной интерфейс
| Светлая тема | Темная тема |
|--------------|-------------|
| ![Single View - светлая тема](../screenshots/single-view-white.png) | ![Single View - темная тема](../screenshots/single-view-dark.png) |
### 🖥️ Multi-view режим
### Multi-view режим
![Multi-view режим](../screenshots/multi-view.png)
### 📋 Карточки контейнеров
### Карточки контейнеров
![Карточки контейнеров](../screenshots/container-cards.png)
### 📁 Проекты
### Проекты
![Список проектов](../screenshots/projects.png)
### ⚙️ Настройки
### Настройки
![Панель настроек](../screenshots/options.png)
### 🔧 Сворачиваемая боковая панель
### Сворачиваемая боковая панель
![Сворачиваемая боковая панель](../screenshots/collapse-sidebar.png)
### Справка
### Справка
![Окно справки](../screenshots/help.png)
### 🚨 Страницы ошибок
### Страницы ошибок
![Страницы ошибок](../screenshots/error%20pages.png)
## Архитектура
@@ -169,22 +202,22 @@ docker compose up --build -d
- `GET /api/auth/me` - Информация о текущем пользователе
#### Контейнеры и сервисы
- `GET /api/services` - Список контейнеров
- `GET /api/projects` - Список проектов Docker Compose
- `GET /api/containers/services` - Список контейнеров
- `GET /api/containers/projects` - Список проектов Docker Compose
- `GET /api/logs/{container_id}` - Логи контейнера
- `GET /api/logs/stats/{container_id}` - Статистика логов
#### Управление
- `GET /api/settings` - Настройки приложения
- `GET /api/excluded-containers` - Список исключенных контейнеров
- `POST /api/excluded-containers` - Обновление исключенных контейнеров
- `POST /api/snapshot` - Создание снимка логов
- `GET /api/containers/excluded` - Список исключенных контейнеров
- `POST /api/containers/excluded` - Обновление исключенных контейнеров
- `POST /api/logs/snapshot` - Создание снимка логов
### WebSocket API
- `ws://host:port/ws/logs/{container_id}` - Логи отдельного контейнера
- `ws://host:port/ws/fan/{service_name}` - Логи сервиса (все реплики)
- `ws://host:port/ws/fan_group` - Логи группы сервисов
- `ws://host:port/api/websocket/logs/{container_id}` - Логи отдельного контейнера
- `ws://host:port/api/websocket/fan/{service_name}` - Логи сервиса (все реплики)
- `ws://host:port/api/websocket/fan_group` - Логи группы сервисов
## Конфигурация