Self-hosted house planner: true-scale 2D floor plan, 3D, satellite map overlay, sewer, electrical, water and underfloor heating with calculations, priced bill of materials. React + PHP, no database. By the team behind homedesignsai.pro
Установка
English | Русский
House Planner — статическое React-приложение и небольшой PHP API, который хранит план в файлах. Базы данных нет, Node.js на сервере не нужен. Запустить можно тремя способами.
| Способ | Для чего | Что нужно |
|---|---|---|
| Docker | домашний сервер, VPS, попробовать | Docker с Compose |
| Локальный PHP-сервер | разработка, быстрый просмотр | Node.js 22, PHP 8.1+ |
| Виртуальный хостинг | постоянный сайт с HTTPS | хостинг с PHP 8.1+ и Apache или LiteSpeed |
Docker
git clone https://github.com/egmalt/house-planner.git
cd house-planner
docker compose up -d --build
Откройте http://localhost:8080/. При первом запуске приложение попросит завершить установку: откройте /api/setup.php и задайте пароль (не короче 8 символов).
Пароль через окружение. Чтобы обойтись без мастера, передайте пароль при первом старте:
HOUSE_PASSWORD='длинный-пароль' docker compose up -d --build
Пароль применяется, только пока хранилище пустое. После установки HOUSE_PASSWORD ни на что не влияет, его можно оставить в .env.
Порт. Внутри контейнера — 8080, порт на хосте задаёт HOUSE_PORT (по умолчанию 8080):
HOUSE_PORT=9000 docker compose up -d
Эти переменные Compose читает и из файла .env рядом с docker-compose.yml.
Данные. Конфигурация, текущий план, все версии и снимки лежат в именованном томе house-data, смонтированном в /var/lib/house-planner. Пересборка образа и docker compose restart их не трогают. docker compose down -v том удаляет — без нужды -v не используйте.
Смена пароля. Удалите конфигурацию в томе и установите заново, план и история останутся:
docker compose exec house-planner rm /var/lib/house-planner/config.php
HOUSE_PASSWORD='новый-пароль' docker compose up -d --force-recreate
или без HOUSE_PASSWORD: docker compose restart и мастер /api/setup.php. Прежние входы перестают действовать: токен куки создаётся новый.
Защита мастера. Пока пароль не задан, /api/setup.php может открыть любой, у кого есть доступ к порту. Либо стартуйте сразу с HOUSE_PASSWORD, либо задайте HOUSE_SETUP_KEY — тогда мастер дополнительно спросит этот ключ.
Резервная копия.
docker compose exec -T house-planner tar -C /var/lib/house-planner -czf - . > house-backup-$(date +%F).tar.gz
HTTPS. Контейнер отдаёт обычный HTTP. Поставьте перед ним обратный прокси с TLS (Caddy, Traefik, nginx) и направьте его на HOUSE_PORT. Кука входа получает флаг Secure, когда запрос пришёл по HTTPS.
Локальный PHP-сервер
Режим разработки, сборка не нужна. Два терминала:
npm i
npm run dev:api # терминал 1: PHP API на 127.0.0.1:8000 из public/
npm run dev # терминал 2: Vite на http://localhost:5173
Откройте http://localhost:5173/api/setup.php, оставьте первый вариант хранилища, задайте пароль и откройте http://localhost:5173/. Vite проксирует /api, /data и /plans на PHP. Хранилище — $HOUSE_STORAGE, если задан, иначе ./storage в корне репозитория (в .gitignore).
scripts/dev-router.php повторяет правила .htaccess для встроенного сервера PHP (нет прямого доступа к api/_*.php и storage/, проверка куки для data/ и plans/). Но встроенный сервер всё равно только для своей машины.
Проверить боевую сборку локально: npm run build && php -S 127.0.0.1:8000 -t dist, затем http://127.0.0.1:8000/api/setup.php.
Виртуальный хостинг
Подойдёт любой хостинг с PHP 8.1+ (с расширением curl — для корзины Петровича) и Apache или LiteSpeed с mod_rewrite. Собрать локально, залить dist/, открыть /api/setup.php. Подробно про scripts/deploy.sh, FTP, HTTPS, обновления и резервные копии — в deploy.md.
Что делает мастер установки
/api/setup.php запускается один раз:
- Предлагает место хранилища по порядку:
$HOUSE_STORAGE,<корень сайта>/../storage(вне корня сайта, предпочтительно),<корень сайта>/storage(внутри, закрытоRequire all denied). - Создаёт папку хранилища и
config.phpв ней: хеш пароля, случайный токен куки, путь к засеву, часовой пояс. - Пишет
data/.htaccessиplans/.htaccess, которые без куки входа отвечают401. - При следующих заходах отвечает
403.
Первый запрос к API засевает хранилище из plans/demo.json: вымышленный одноэтажный дом в северном стиле с гаражом на участке 30 × 45 м в Эстонии. Замените его своим планом в редакторе или импортируйте JSON из меню «⋯».
Требования кратко
| Компонент | Версия |
|---|---|
| Node.js (только сборка) | 22 |
| PHP | 8.1+ с json и curl (для корзины Петровича) |
| Веб-сервер | Apache 2.4 или LiteSpeed с mod_rewrite; на nginx закройте /storage, /data, /plans в его конфигурации |
| Браузер | свежий Chrome, Firefox, Safari или Edge с WebGL 2 |
Дальше: работа с планировщиком.