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:
42
Makefile
42
Makefile
@@ -2,7 +2,7 @@
|
||||
# Автор: Сергей Антропов
|
||||
# Сайт: https://devops.org.ru
|
||||
|
||||
.PHONY: help setup build up down restart logs clean status ps shell generate test-auth
|
||||
.PHONY: help setup build up down restart logs clean status ps shell
|
||||
|
||||
# Переменные
|
||||
COMPOSE_FILE = docker-compose.yml
|
||||
@@ -34,7 +34,10 @@ setup: ## Настроить переменные окружения (копир
|
||||
cp env.example .env; \
|
||||
echo "$(GREEN)Файл .env создан из env.example$(NC)"; \
|
||||
echo "$(YELLOW)Не забудьте отредактировать .env под свои нужды!$(NC)"; \
|
||||
echo "$(YELLOW)После редактирования .env запустите make generate для обновления docker-compose.yml$(NC)"; \
|
||||
echo "$(YELLOW)Особенно важны переменные безопасности:$(NC)"; \
|
||||
echo "$(YELLOW) - LOGBOARD_PASS$(NC)"; \
|
||||
echo "$(YELLOW) - SECRET_KEY$(NC)"; \
|
||||
echo "$(YELLOW) - ENCRYPTION_KEY$(NC)"; \
|
||||
else \
|
||||
echo "$(YELLOW)Файл .env уже существует.$(NC)"; \
|
||||
echo "$(YELLOW)Для пересоздания удалите .env и запустите make setup$(NC)"; \
|
||||
@@ -47,9 +50,15 @@ build: ## Собрать Docker образ
|
||||
|
||||
up: ## Запустить сервисы в фоновом режиме (с правами root)
|
||||
@echo "$(GREEN)Запуск сервисов с правами root...$(NC)"
|
||||
@mkdir -p snapshots
|
||||
docker compose -f $(COMPOSE_FILE) up -d
|
||||
@echo "$(GREEN)Сервисы запущены с правами root!$(NC)"
|
||||
@echo "$(YELLOW)Приложение доступно по адресу: http://localhost:9001$(NC)"
|
||||
@if [ -f .env ]; then \
|
||||
PORT=$$(grep "^LOGBOARD_PORT=" .env | cut -d'=' -f2 || echo "9001"); \
|
||||
echo "$(YELLOW)Приложение доступно по адресу: http://localhost:$$PORT$(NC)"; \
|
||||
else \
|
||||
echo "$(YELLOW)Приложение доступно по адресу: http://localhost:9001$(NC)"; \
|
||||
fi
|
||||
|
||||
down: ## Остановить и удалить сервисы (с правами root)
|
||||
@echo "$(YELLOW)Остановка сервисов с правами root...$(NC)"
|
||||
@@ -88,8 +97,33 @@ rebuild: ## Пересобрать и запустить сервисы
|
||||
@echo "$(YELLOW)Пересборка и запуск сервисов...$(NC)"
|
||||
docker compose -f $(COMPOSE_FILE) down
|
||||
docker compose -f $(COMPOSE_FILE) build --no-cache
|
||||
@mkdir -p snapshots
|
||||
docker compose -f $(COMPOSE_FILE) up -d
|
||||
@echo "$(GREEN)Сервисы пересобраны и запущены!$(NC)"
|
||||
@echo "$(YELLOW)Приложение доступно по адресу: http://localhost:9001$(NC)"
|
||||
@if [ -f .env ]; then \
|
||||
PORT=$$(grep "^LOGBOARD_PORT=" .env | cut -d'=' -f2 || echo "9001"); \
|
||||
echo "$(YELLOW)Приложение доступно по адресу: http://localhost:$$PORT$(NC)"; \
|
||||
else \
|
||||
echo "$(YELLOW)Приложение доступно по адресу: http://localhost:9001$(NC)"; \
|
||||
fi
|
||||
|
||||
config: ## Показать конфигурацию с подставленными переменными окружения
|
||||
@echo "$(GREEN)Конфигурация Docker Compose с переменными окружения:$(NC)"
|
||||
docker compose -f $(COMPOSE_FILE) config
|
||||
|
||||
validate: ## Проверить синтаксис docker-compose.yml
|
||||
@echo "$(GREEN)Проверка синтаксиса docker-compose.yml...$(NC)"
|
||||
docker compose -f $(COMPOSE_FILE) config --quiet
|
||||
@echo "$(GREEN)Синтаксис корректен!$(NC)"
|
||||
|
||||
env-check: ## Проверить переменные окружения
|
||||
@echo "$(GREEN)Проверка переменных окружения...$(NC)"
|
||||
@if [ -f .env ]; then \
|
||||
echo "$(GREEN)Файл .env найден$(NC)"; \
|
||||
echo "$(YELLOW)Основные переменные:$(NC)"; \
|
||||
grep -E "^(LOGBOARD_PORT|LOGBOARD_USER|LOGBOARD_PASS|SECRET_KEY|ENCRYPTION_KEY)=" .env || echo "$(RED)Переменные не найдены$(NC)"; \
|
||||
else \
|
||||
echo "$(RED)Файл .env не найден. Запустите make setup$(NC)"; \
|
||||
fi
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user