docs: update documentation to reflect new project structure
- Update README.md with new project structure and installation instructions - Update docs/installation.md with simplified setup process - Update docs/configuration.md with correct file paths - Update docs/index.md with new documentation structure - Add docs/project-structure.md with detailed architecture overview - Reflect changes from refactoring: app/ directory structure, .env file usage - Update installation instructions to use docker compose up --build -d - Add comprehensive project structure documentation
This commit is contained in:
74
README.md
74
README.md
@@ -99,6 +99,17 @@ LogBoard+ особенно полезен для разработчиков, р
|
||||
cd logboard
|
||||
```
|
||||
|
||||
2. **Настройка переменных окружения**
|
||||
```bash
|
||||
cp env.example .env
|
||||
# Отредактируйте .env файл при необходимости
|
||||
```
|
||||
|
||||
3. **Запуск приложения**
|
||||
```bash
|
||||
docker compose up --build -d
|
||||
```
|
||||
|
||||
2. **Настройка переменных окружения**
|
||||
```bash
|
||||
make setup
|
||||
@@ -161,19 +172,51 @@ make debug-status
|
||||
|
||||
```
|
||||
logboard/
|
||||
├── app.py # Основное приложение FastAPI
|
||||
├── app/ # Основная папка приложения
|
||||
│ ├── __init__.py # Инициализация пакета
|
||||
│ ├── app.py # Основное приложение FastAPI
|
||||
│ ├── excluded_containers.json # Исключенные контейнеры
|
||||
│ ├── api/ # API модули
|
||||
│ │ ├── __init__.py
|
||||
│ │ └── v1/
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── router.py # Основной роутер API
|
||||
│ │ └── endpoints/ # API endpoints
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── auth.py # Аутентификация
|
||||
│ │ ├── containers.py # Управление контейнерами
|
||||
│ │ ├── logs.py # Логи
|
||||
│ │ ├── pages.py # HTML страницы
|
||||
│ │ ├── settings.py # Настройки
|
||||
│ │ └── websocket.py # WebSocket API
|
||||
│ ├── core/ # Основные модули
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── auth.py # Аутентификация и авторизация
|
||||
│ │ ├── config.py # Конфигурация приложения
|
||||
│ │ ├── docker.py # Работа с Docker API
|
||||
│ │ └── logger.py # Система логирования
|
||||
│ ├── models/ # Модели данных
|
||||
│ │ ├── __init__.py
|
||||
│ │ └── auth.py # Модели аутентификации
|
||||
│ ├── static/ # Статические файлы
|
||||
│ │ ├── css/ # CSS стили
|
||||
│ │ ├── js/ # JavaScript файлы
|
||||
│ │ ├── images/ # Изображения
|
||||
│ │ └── fonts/ # Шрифты
|
||||
│ └── templates/ # HTML шаблоны
|
||||
│ ├── index.html # Главная страница
|
||||
│ ├── login.html # Страница входа
|
||||
│ └── error.html # Страницы ошибок
|
||||
├── docs/ # Документация
|
||||
├── snapshots/ # Снимки логов
|
||||
├── screenshots/ # Скриншоты интерфейса
|
||||
├── .env # Переменные окружения (создается из env.example)
|
||||
├── env.example # Пример переменных окружения
|
||||
├── docker-compose.yml # Конфигурация Docker Compose
|
||||
├── Dockerfile # Образ Docker
|
||||
├── requirements.txt # Зависимости Python
|
||||
├── Makefile # Команды управления
|
||||
├── env.example # Пример переменных окружения
|
||||
├── excluded_containers.json # Исключенные контейнеры
|
||||
├── templates/ # HTML шаблоны
|
||||
│ ├── index.html # Главная страница
|
||||
│ ├── login.html # Страница входа
|
||||
│ └── error.html # Страницы ошибок
|
||||
├── snapshots/ # Снимки логов
|
||||
└── screenshots/ # Скриншоты интерфейса
|
||||
├── start.sh # Скрипт запуска
|
||||
└── README.md # Документация проекта
|
||||
```
|
||||
|
||||
## API Документация
|
||||
@@ -210,6 +253,12 @@ logboard/
|
||||
|
||||
### Переменные окружения
|
||||
|
||||
Приложение использует файл `.env` для конфигурации. Создайте его из `env.example`:
|
||||
|
||||
```bash
|
||||
cp env.example .env
|
||||
```
|
||||
|
||||
Основные настройки приложения:
|
||||
|
||||
| Переменная | Описание | По умолчанию |
|
||||
@@ -219,6 +268,9 @@ logboard/
|
||||
| `LOGBOARD_PASS` | Пароль пользователя | `admin` |
|
||||
| `LOGBOARD_TAIL` | Количество строк логов | `500` |
|
||||
| `SECRET_KEY` | Секретный ключ JWT | `your-secret-key-here` |
|
||||
| `ENCRYPTION_KEY` | Ключ шифрования | `your-encryption-key-here` |
|
||||
| `AUTH_ENABLED` | Включить аутентификацию | `true` |
|
||||
| `LOG_LEVEL` | Уровень логирования | `INFO` |
|
||||
|
||||
### Настройка проектов
|
||||
|
||||
@@ -234,7 +286,7 @@ LOGBOARD_PROJECTS=project1,project2,project3
|
||||
|
||||
### Исключение контейнеров
|
||||
|
||||
Создайте файл `excluded_containers.json`:
|
||||
Файл `app/excluded_containers.json` содержит список контейнеров, которые не будут отображаться в интерфейсе:
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user