75 lines
2.0 KiB
Markdown
75 lines
2.0 KiB
Markdown
# Домовой
|
|
|
|
Self-hosted система инвентаризации домашней и малой серверной инфраструктуры.
|
|
|
|
## Что делает
|
|
|
|
- Сканирует заданные локальные сетевые диапазоны
|
|
- Находит устройства и предлагает создать карточки
|
|
- После добавления SSH-доступа — read-only deep scan хоста
|
|
- Находит сервисы, Docker-контейнеры, nginx vhost-ы, cron-задачи, backup-подсказки
|
|
- Создаёт карточки сервисов и связи между устройствами и сервисами
|
|
|
|
## Стек
|
|
|
|
- PHP 8.3, Slim Framework 4, PDO
|
|
- MariaDB
|
|
- Bootstrap 5.3, htmx
|
|
- Docker Compose
|
|
- Phinx (миграции)
|
|
|
|
## Предупреждение
|
|
|
|
Сканируйте только свои сети. Приложение read-only и ничего не меняет на удалённых хостах.
|
|
|
|
## Установка
|
|
|
|
```bash
|
|
git clone <repo>
|
|
cd domovoy
|
|
cp .env.example .env
|
|
# Отредактируйте .env: задайте APP_SECRET, ENCRYPTION_KEY, DB_PASSWORD
|
|
docker compose up -d --build
|
|
docker compose exec app php vendor/bin/phinx migrate
|
|
docker compose exec app php bin/setup first-admin
|
|
# Откройте http://localhost:8080
|
|
```
|
|
|
|
## Запуск
|
|
|
|
```bash
|
|
docker compose up -d
|
|
# http://localhost:8080
|
|
```
|
|
|
|
## Миграции
|
|
|
|
```bash
|
|
docker compose exec app php vendor/bin/phinx migrate
|
|
docker compose exec app php vendor/bin/phinx rollback
|
|
docker compose exec app php vendor/bin/phinx create MigrationName
|
|
```
|
|
|
|
## Smoke test
|
|
|
|
```bash
|
|
./scripts/check.sh
|
|
```
|
|
|
|
## Структура
|
|
|
|
```
|
|
domovoy/
|
|
app/ # Controllers, Services, Repositories, Middleware
|
|
db/migrations/ # Phinx миграции
|
|
public/ # Точка входа, assets
|
|
templates/ # PHP шаблоны
|
|
bin/ # CLI команды
|
|
docker/ # Dockerfile, nginx config
|
|
storage/ # логи, scan results
|
|
```
|
|
|
|
## Лицензия
|
|
|
|
MIT
|