118 lines
3.7 KiB
Markdown
118 lines
3.7 KiB
Markdown
# Deploy notes — Void 2.0
|
||
|
||
## App deploy (CT 311 — `void2-app`)
|
||
|
||
One-time setup on the target host:
|
||
|
||
```bash
|
||
# Node 22 (from nodesource if Debian's default is older)
|
||
curl -fsSL https://deb.nodesource.com/setup_22.x | bash -
|
||
apt install -y nodejs
|
||
|
||
# Service user + working dir
|
||
useradd -r -m -d /opt/void-server void
|
||
mkdir -p /opt/void-server
|
||
chown void: /opt/void-server
|
||
|
||
# systemd
|
||
install -m 644 void-server.service /etc/systemd/system/void-server.service
|
||
systemctl daemon-reload
|
||
systemctl enable void-server
|
||
|
||
# Secrets — /opt/void-server/.env must contain:
|
||
# DATABASE_URL=postgres://void:<password>@<db-host>:5432/void
|
||
# OWNER_TOKEN=<32+ char secret>
|
||
# PORT=3000
|
||
# NODE_ENV=production
|
||
chmod 600 /opt/void-server/.env
|
||
chown void: /opt/void-server/.env
|
||
```
|
||
|
||
Then from the dev box:
|
||
|
||
```bash
|
||
cd /project/src/void-v2
|
||
./deploy/push.sh
|
||
```
|
||
|
||
## Maintenance
|
||
|
||
```bash
|
||
journalctl -u void-server -f # follow logs
|
||
systemctl status void-server # check status
|
||
systemctl restart void-server # cycle
|
||
|
||
# Run migrations on the deployed copy:
|
||
ssh root@void2-app 'cd /opt/void-server && npm run migrate'
|
||
```
|
||
|
||
## Notes
|
||
|
||
- `.env` is excluded from the rsync to avoid clobbering production secrets with dev values.
|
||
- The push script uses `--omit=dev` to skip test deps on the target.
|
||
- `tests/` is excluded — they're for the dev environment only.
|
||
|
||
## Workers (Python void-workers — Plan 4+)
|
||
|
||
Runs alongside void-server as a second systemd unit.
|
||
|
||
One-time setup on CT 311:
|
||
|
||
```bash
|
||
apt install -y python3.12 python3.12-venv python3-pip \
|
||
ffmpeg tesseract-ocr tesseract-ocr-eng poppler-utils
|
||
|
||
useradd -r -m -d /opt/void-workers -s /bin/bash voidworkers
|
||
mkdir -p /opt/void-workers /var/lib/void/whisper-models
|
||
chown voidworkers: /opt/void-workers
|
||
chown -R voidworkers: /var/lib/void/whisper-models
|
||
|
||
# voidworkers needs to read the shared blob store
|
||
usermod -aG void voidworkers
|
||
chmod -R g+rX /var/lib/void/blobs
|
||
|
||
install -m 644 deploy/void-workers.service /etc/systemd/system/
|
||
systemctl daemon-reload
|
||
systemctl enable void-workers
|
||
```
|
||
|
||
`/opt/void-workers/.env` (mode 600, owned by voidworkers):
|
||
|
||
```
|
||
DATABASE_URL=postgres://void:<pw>@192.168.1.215:5432/void
|
||
BLOB_ROOT=/var/lib/void/blobs
|
||
WHISPER_MODEL=small.en
|
||
WHISPER_CACHE=/var/lib/void/whisper-models
|
||
```
|
||
|
||
Deploy after edits:
|
||
|
||
```bash
|
||
cd /project/src/void-v2
|
||
./deploy/push-workers.sh
|
||
```
|
||
|
||
## SQL_ASCII cluster note
|
||
|
||
`void2-db` was initialized as SQL_ASCII (not UTF-8). The data is already
|
||
UTF-8 in practice but Python's psycopg refuses to decode without an
|
||
explicit `client_encoding=UTF8` parameter. Workers set this on every
|
||
connection (`lib/db/pool.py` equivalent in `workers/void_workers/`).
|
||
Node's `pg` lib is more lenient and doesn't need this. If you ever
|
||
re-initdb the cluster, use `--encoding=UTF8 --locale=C.UTF-8`.
|
||
|
||
## Plan 6 (alpha-8)
|
||
|
||
- **Migrations 012–014** (dashboard_layout, speedtest_results, service_status) are applied by the standard `npm run migrate` — no manual steps needed.
|
||
- **`speedtest-cli` on CT 311** — the hourly speedtest job requires it:
|
||
```bash
|
||
pip install --break-system-packages speedtest-cli
|
||
```
|
||
Until installed, speedtest jobs will fail but the Sacred Valley speedtest card still renders any existing history without error.
|
||
- **Icon cache** — the server writes cached service icons to `ICON_CACHE` (default `/var/lib/void/icons`) and auto-creates the directory on first use. You can pre-create and own it for clarity:
|
||
```bash
|
||
mkdir -p /var/lib/void/icons
|
||
chown void: /var/lib/void/icons
|
||
```
|
||
- **Service registry** — edit `config/services.json` to the real homelab service URLs and CT numbers. The committed seed values are best-guess placeholders and should be updated before the health band is meaningful.
|