docs: Полная переработка документации проекта

- Удалена старая документация с эмодзи
- Создана новая техническая документация на русском языке
- Добавлены подробные руководства:
  * README.md - обзор проекта
  * docs/installation.md - установка и настройка
  * docs/configuration.md - конфигурация
  * docs/api.md - API документация
  * docs/management.md - управление проектом
  * docs/security.md - безопасность
  * docs/troubleshooting.md - устранение неполадок
- Обновлены конфигурационные файлы
- Улучшена структура проекта

Автор: Сергей Антропов
Сайт: https://devops.org.ru
This commit is contained in:
2025-08-18 22:03:27 +03:00
parent 749b40a494
commit 86a2c44333
17 changed files with 1156 additions and 1940 deletions

View File

@@ -1,79 +1,159 @@
# LogBoard+ - Переменные окружения
# Автор: Сергей Антропов
# Сайт: https://devops.org.ru
# Версия: 1.0.0
# Основные настройки приложения
# =============================================================================
# ОСНОВНЫЕ НАСТРОЙКИ ПРИЛОЖЕНИЯ
# =============================================================================
# Порт на котором будет работать веб-интерфейс LogBoard+
LOGBOARD_PORT=9001
LOGBOARD_TAIL=500
LOGBOARD_USER=admin
LOGBOARD_PASS=s3cret-change-me
# Директория для снимков логов
# Количество строк логов для отображения по умолчанию (tail)
LOGBOARD_TAIL=500
# Имя пользователя для входа в систему
LOGBOARD_USER=admin
# Пароль для входа в систему (обязательно измените в продакшене)
LOGBOARD_PASS=admin
# Директория для сохранения снимков логов (путь внутри контейнера)
LOGBOARD_SNAPSHOT_DIR=/app/snapshots
# Путь к HTML шаблону
# Путь к HTML шаблону главной страницы
LOGBOARD_INDEX_HTML=./templates/index.html
# Временная зона для временных меток
TZ_TS=
# Временная зона для временных меток в логах (например: Europe/Moscow, UTC)
TZ_TS=Europe/Moscow
# =============================================================================
# НАСТРОЙКИ DOCKER
# =============================================================================
# Фильтр по проекту Docker Compose (опционально)
# Если указано, будут показаны только контейнеры из этого проекта
# COMPOSE_PROJECT_NAME=myproj
# Настройки множественных проектов
# Укажите проекты через запятую для отображения контейнеров из нескольких проектов
# Если не указано или пустое значение - показываются ВСЕ контейнеры из всех проектов
# LOGBOARD_PROJECTS=project1,project2,project3
# Настройки Docker
# Путь к Docker socket для подключения к Docker daemon
DOCKER_HOST=unix:///var/run/docker.sock
# Проверка TLS для Docker (для удаленных Docker hosts)
DOCKER_TLS_VERIFY=
# Путь к сертификатам Docker (для удаленных Docker hosts)
DOCKER_CERT_PATH=
# Настройки Docker сетей (внешние сети для подключения)
# Укажите имена внешних сетей через запятую
DOCKER_NETWORKS=iaas,infrastructure_iaas
# Настройки безопасности
# Измените эти значения на свои в продакшене
# =============================================================================
# НАСТРОЙКИ БЕЗОПАСНОСТИ
# =============================================================================
# Секретный ключ для JWT токенов (обязательно измените в продакшене)
SECRET_KEY=your-secret-key-here
# Ключ шифрования для чувствительных данных (обязательно измените в продакшене)
ENCRYPTION_KEY=your-encryption-key-here
# Настройки логирования
# =============================================================================
# НАСТРОЙКИ ЛОГИРОВАНИЯ
# =============================================================================
# Уровень логирования приложения (DEBUG, INFO, WARNING, ERROR)
LOG_LEVEL=INFO
# Формат логов (json, text)
LOG_FORMAT=json
# Настройки веб-интерфейса
# =============================================================================
# НАСТРОЙКИ ВЕБ-ИНТЕРФЕЙСА
# =============================================================================
# Заголовок веб-интерфейса
WEB_TITLE=LogBoard+
# Описание веб-интерфейса
WEB_DESCRIPTION=Веб-панель для просмотра логов микросервисов
# Версия веб-интерфейса
WEB_VERSION=1.0.0
# Настройки производительности
# =============================================================================
# НАСТРОЙКИ ПРОИЗВОДИТЕЛЬНОСТИ
# =============================================================================
# Максимальное количество одновременных подключений
MAX_CONNECTIONS=100
# Таймаут подключения в секундах
CONNECTION_TIMEOUT=30
# Таймаут чтения в секундах
READ_TIMEOUT=60
# Настройки фильтрации контейнеров
# =============================================================================
# НАСТРОЙКИ ФИЛЬТРАЦИИ КОНТЕЙНЕРОВ
# =============================================================================
# Пропускать контейнеры с проблемными health check (true/false)
LOGBOARD_SKIP_UNHEALTHY=true
# Настройки таймаутов (в секундах)
# Таймаут получения списка контейнеров в секундах
LOGBOARD_CONTAINER_LIST_TIMEOUT=10
# Таймаут получения информации о контейнере в секундах
LOGBOARD_CONTAINER_INFO_TIMEOUT=3
# Таймаут health check контейнера в секундах
LOGBOARD_HEALTH_CHECK_TIMEOUT=2
# Настройки аутентификации
AUTH_ENABLED=true
AUTH_METHOD=jwt
SESSION_TIMEOUT=3600
SECRET_KEY=your-secret-key-here-change-in-production
# =============================================================================
# НАСТРОЙКИ АУТЕНТИФИКАЦИИ
# =============================================================================
# Настройки уведомлений
# Включить аутентификацию (true/false)
AUTH_ENABLED=true
# Метод аутентификации (jwt)
AUTH_METHOD=jwt
# Время жизни сессии в секундах
SESSION_TIMEOUT=3600
# =============================================================================
# НАСТРОЙКИ УВЕДОМЛЕНИЙ
# =============================================================================
# Включить уведомления по email (true/false)
NOTIFICATIONS_ENABLED=false
# SMTP сервер для отправки уведомлений
SMTP_HOST=
# Порт SMTP сервера
SMTP_PORT=587
# Пользователь SMTP
SMTP_USER=
# Пароль SMTP
SMTP_PASS=
# Email отправителя
SMTP_FROM=
# Настройки AJAX обновления логов
# =============================================================================
# НАСТРОЙКИ AJAX ОБНОВЛЕНИЯ
# =============================================================================
# Интервал AJAX обновления логов в миллисекундах
LOGBOARD_AJAX_UPDATE_INTERVAL=2000