feat: добавлен env.example и команда make setup
- Создан файл env.example с полным набором переменных окружения - Добавлена команда make setup для копирования env.example в .env - Обновлен docker-compose.yml для использования переменных из .env - Добавлен .gitignore для исключения .env и временных файлов - Обновлен README.md с инструкциями по настройке переменных окружения - Добавлена таблица основных переменных окружения - Автор: Сергей Антропов (https://devops.org.ru)
This commit is contained in:
41
README.md
41
README.md
@@ -33,6 +33,12 @@ cd logboard_plus
|
||||
# Показать доступные команды
|
||||
make help
|
||||
|
||||
# Настроить переменные окружения
|
||||
make setup
|
||||
|
||||
# Отредактировать .env файл под свои нужды (опционально)
|
||||
# nano .env
|
||||
|
||||
# Собрать и запустить проект
|
||||
make build
|
||||
make up
|
||||
@@ -46,6 +52,7 @@ http://localhost:9001
|
||||
| Команда | Описание |
|
||||
|---------|----------|
|
||||
| `make help` | Показать справку по всем командам |
|
||||
| `make setup` | Настроить переменные окружения (копировать env.example в .env) |
|
||||
| `make build` | Собрать Docker образ |
|
||||
| `make up` | Запустить сервисы в фоновом режиме |
|
||||
| `make down` | Остановить и удалить сервисы |
|
||||
@@ -58,6 +65,36 @@ http://localhost:9001
|
||||
| `make dev` | Запуск в режиме разработки (с выводом логов) |
|
||||
| `make rebuild` | Пересобрать и запустить сервисы |
|
||||
|
||||
### Настройка переменных окружения
|
||||
|
||||
Проект использует файл `.env` для хранения всех настроек. Для настройки:
|
||||
|
||||
1. **Автоматическая настройка:**
|
||||
```bash
|
||||
make setup
|
||||
```
|
||||
|
||||
2. **Ручная настройка:**
|
||||
```bash
|
||||
cp env.example .env
|
||||
nano .env # или любой другой редактор
|
||||
```
|
||||
|
||||
#### Основные переменные окружения:
|
||||
|
||||
| Переменная | Описание | Значение по умолчанию |
|
||||
|------------|----------|----------------------|
|
||||
| `LOGBOARD_PORT` | Порт веб-интерфейса | `9001` |
|
||||
| `LOGBOARD_USER` | Имя пользователя для Basic Auth | `admin` |
|
||||
| `LOGBOARD_PASS` | Пароль для Basic Auth | `s3cret-change-me` |
|
||||
| `LOGBOARD_TAIL` | Количество строк истории | `500` |
|
||||
| `LOGBOARD_SNAPSHOT_DIR` | Директория для снимков | `/app/snapshots` |
|
||||
| `COMPOSE_PROJECT_NAME` | Фильтр по проекту Docker Compose | (пусто) |
|
||||
| `SECRET_KEY` | Секретный ключ для шифрования | `your-secret-key-here` |
|
||||
| `ENCRYPTION_KEY` | Ключ шифрования | `your-encryption-key-here` |
|
||||
|
||||
**⚠️ Важно:** Измените значения `LOGBOARD_PASS`, `SECRET_KEY` и `ENCRYPTION_KEY` в продакшене!
|
||||
|
||||
### Классический способ
|
||||
|
||||
```bash
|
||||
@@ -65,6 +102,10 @@ http://localhost:9001
|
||||
unzip logboard_plus_fanin_groups.zip
|
||||
cd logboard_plus
|
||||
|
||||
# Настроить переменные окружения
|
||||
cp env.example .env
|
||||
# Отредактировать .env файл
|
||||
|
||||
# Запуск через docker-compose
|
||||
docker compose up --build -d
|
||||
|
||||
|
||||
Reference in New Issue
Block a user