This commit is contained in:
186
docs/COMMANDS.md
Normal file
186
docs/COMMANDS.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# 🚀 CatLink Commands Quick Reference
|
||||
|
||||
## 📋 Основные команды
|
||||
|
||||
### Развертывание
|
||||
```bash
|
||||
make deploy # Мастер-развертывание (полная настройка)
|
||||
make pre-deploy-check # Проверка готовности системы
|
||||
make deploy-simple # Простое развертывание без мастер-настройки
|
||||
```
|
||||
|
||||
### Разработка
|
||||
```bash
|
||||
make install # Первая установка
|
||||
make dev # Режим разработки
|
||||
make build # Сборка контейнеров
|
||||
make up # Запуск сервисов
|
||||
make down # Остановка сервисов
|
||||
make restart # Перезапуск
|
||||
```
|
||||
|
||||
### База данных
|
||||
```bash
|
||||
make migrate # Применить миграции
|
||||
make makemigrations # Создать миграции
|
||||
make superuser # Создать суперпользователя
|
||||
```
|
||||
|
||||
### Безопасность
|
||||
```bash
|
||||
make security-audit # Аудит безопасности PostgreSQL
|
||||
make security-setup # Настройка безопасности БД
|
||||
make update-production-security # Безопасное обновление в продакшене
|
||||
```
|
||||
|
||||
### SSL/TLS
|
||||
```bash
|
||||
make ssl-setup # Интерактивная настройка SSL
|
||||
make ssl-renew # Обновление сертификатов
|
||||
```
|
||||
|
||||
### Мониторинг и диагностика
|
||||
```bash
|
||||
make status # Статус сервисов
|
||||
make health # Проверка здоровья
|
||||
make logs # Просмотр логов
|
||||
make monitor # Мониторинг ресурсов
|
||||
```
|
||||
|
||||
### Тестирование
|
||||
```bash
|
||||
make test # Запуск тестов
|
||||
make lint # Проверка кода
|
||||
make format # Форматирование кода
|
||||
```
|
||||
|
||||
### Обслуживание
|
||||
```bash
|
||||
make backup # Создать backup
|
||||
make restore # Восстановить из backup
|
||||
make clean # Очистка (containers, images)
|
||||
make clean-all # Полная очистка (+ volumes, data)
|
||||
make reset # Сброс к заводским настройкам
|
||||
```
|
||||
|
||||
## 🔧 Полезные скрипты
|
||||
|
||||
### Прямое выполнение
|
||||
```bash
|
||||
./scripts/master-deploy.sh # Мастер-развертывание
|
||||
./scripts/pre-deploy-check.sh # Проверка системы
|
||||
./scripts/ssl-manager.sh # Управление SSL
|
||||
./scripts/audit-db-security.sh # Аудит безопасности БД
|
||||
./scripts/health-check.sh # Проверка здоровья
|
||||
./scripts/auto-backup.sh # Создание backup
|
||||
```
|
||||
|
||||
## 🌐 URL-адреса (по умолчанию)
|
||||
|
||||
### Разработка
|
||||
- **Frontend:** http://localhost:3000
|
||||
- **Backend API:** http://localhost:8000/api/
|
||||
- **Admin:** http://localhost:8000/admin/
|
||||
|
||||
### Продакшен
|
||||
- **Site:** https://your-domain.com
|
||||
- **Admin:** https://your-domain.com/admin/
|
||||
|
||||
## 📁 Важные файлы
|
||||
|
||||
### Конфигурация
|
||||
- `.env` - переменные окружения
|
||||
- `docker-compose.yml` - основная конфигурация
|
||||
- `docker-compose.prod.yml` - продакшен overrides
|
||||
- `Makefile` - команды автоматизации
|
||||
|
||||
### Безопасность
|
||||
- `database/postgresql.conf` - конфигурация PostgreSQL
|
||||
- `database/pg_hba.conf` - настройки аутентификации
|
||||
- `SECURITY.md` - руководство по безопасности
|
||||
|
||||
### Документация
|
||||
- `README.md` - основная документация
|
||||
- `DEPLOYMENT.md` - руководство по развертыванию
|
||||
- `COMMANDS.md` - этот файл
|
||||
|
||||
### Backup и логи
|
||||
- `backups/` - резервные копии
|
||||
- `logs/` - логи системы
|
||||
|
||||
## 🚨 Экстренные команды
|
||||
|
||||
### Быстрое восстановление
|
||||
```bash
|
||||
# Перезапуск всех сервисов
|
||||
make restart
|
||||
|
||||
# Пересборка и перезапуск
|
||||
make build && make up
|
||||
|
||||
# Проверка логов при проблемах
|
||||
make logs
|
||||
|
||||
# Полная очистка и переустановка
|
||||
make clean-all && make install
|
||||
```
|
||||
|
||||
### Восстановление из backup
|
||||
```bash
|
||||
# База данных
|
||||
docker exec -i links-db-1 psql -U postgres links_db < backups/database/backup_YYYYMMDD.sql
|
||||
|
||||
# Файлы
|
||||
tar -xzf backups/files/media_YYYYMMDD.tar.gz
|
||||
```
|
||||
|
||||
### Диагностика проблем
|
||||
```bash
|
||||
# Проверка контейнеров
|
||||
docker ps -a
|
||||
|
||||
# Проверка ресурсов
|
||||
docker stats
|
||||
|
||||
# Проверка сетей
|
||||
docker network ls
|
||||
|
||||
# Проверка volumes
|
||||
docker volume ls
|
||||
```
|
||||
|
||||
## 🔄 Обновление проекта
|
||||
|
||||
### Стандартное обновление
|
||||
```bash
|
||||
git pull
|
||||
make restart
|
||||
```
|
||||
|
||||
### Обновление с миграциями
|
||||
```bash
|
||||
git pull
|
||||
make down
|
||||
make build
|
||||
make up
|
||||
make migrate
|
||||
```
|
||||
|
||||
### Безопасное обновление продакшена
|
||||
```bash
|
||||
make update-production-security
|
||||
```
|
||||
|
||||
## 💡 Подсказки
|
||||
|
||||
1. **Всегда проверяйте статус** перед началом работы: `make status`
|
||||
2. **Используйте pre-deploy-check** перед развертыванием: `make pre-deploy-check`
|
||||
3. **Регулярно делайте backup**: `./scripts/auto-backup.sh`
|
||||
4. **Мониторьте безопасность**: `make security-audit`
|
||||
5. **Проверяйте логи** при проблемах: `make logs`
|
||||
|
||||
## 📞 Поддержка
|
||||
|
||||
- **Issues:** https://github.com/smartsoltech/links/issues
|
||||
- **Документация:** README.md, DEPLOYMENT.md, SECURITY.md
|
||||
- **Команды:** `make help`
|
||||
Reference in New Issue
Block a user