ilia/punimtag
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finish homelab IP scrub across repo, add e2e env-defaults local override

Browse Source
This commit is contained in:
ilia
2026-07-26 15:56:57 -04:00
parent d6b546c95e
commit abb7b34700
11 changed files with 70 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/DEPLOYMENT.md
+20 -20
View File
@@ -32,12 +32,12 @@ This guide covers deployment of PunimTag to development and production environme
### Development Server Information
**Development Server:**
- **Host**: 10.0.10.121
- **Host**: <backend-host>
- **User**: appuser
- **Password**: [Contact administrator for password]
**Development Database:**
- **Host**: 10.0.10.179 (postgresQA / pve201 VM 109; legacy `.181` is dead)
- **Host**: `<db-host>`
- **Port**: 5432
- **User**: ladmin
- **Password**: [Contact administrator for password]
@@ -70,18 +70,18 @@ This will:
```bash
# Create deployment directory structure
ssh appuser@10.0.10.121 "mkdir -p /opt/punimtag/{backend,admin-frontend,viewer-frontend,data/uploads,logs}"
ssh appuser@<backend-host> "mkdir -p /opt/punimtag/{backend,admin-frontend,viewer-frontend,data/uploads,logs}"
# Transfer backend
scp -r backend/* appuser@10.0.10.121:/opt/punimtag/backend/
scp requirements.txt appuser@10.0.10.121:/opt/punimtag/
scp -r backend/* appuser@<backend-host>:/opt/punimtag/backend/
scp requirements.txt appuser@<backend-host>:/opt/punimtag/
# Transfer built frontends
scp -r admin-frontend/dist/* appuser@10.0.10.121:/opt/punimtag/admin-frontend/
scp -r viewer-frontend/.next/* appuser@10.0.10.121:/opt/punimtag/viewer-frontend/
scp -r admin-frontend/dist/* appuser@<backend-host>:/opt/punimtag/admin-frontend/
scp -r viewer-frontend/.next/* appuser@<backend-host>:/opt/punimtag/viewer-frontend/
# Transfer configuration files
scp .env.example appuser@10.0.10.121:/opt/punimtag/.env
scp .env.example appuser@<backend-host>:/opt/punimtag/.env
```
### Step 3: Server Setup
@@ -89,7 +89,7 @@ scp .env.example appuser@10.0.10.121:/opt/punimtag/.env
SSH into the development server:
```bash
ssh appuser@10.0.10.121
ssh appuser@<backend-host>
cd /opt/punimtag
```
@@ -125,8 +125,8 @@ Set the following variables:
```bash
# Development Database
DATABASE_URL=postgresql+psycopg2://ladmin:[PASSWORD]@10.0.10.179:5432/punimtag
DATABASE_URL_AUTH=postgresql+psycopg2://ladmin:[PASSWORD]@10.0.10.179:5432/punimtag_auth
DATABASE_URL=postgresql+psycopg2://ladmin:[PASSWORD]@<db-host>:5432/punimtag
DATABASE_URL_AUTH=postgresql+psycopg2://ladmin:[PASSWORD]@<db-host>:5432/punimtag_auth
# JWT Secrets (change in production!)
SECRET_KEY=dev-secret-key-change-in-production
@@ -150,16 +150,16 @@ API_PORT=8000
Create `admin-frontend/.env`:
```bash
VITE_API_URL=http://10.0.10.121:8000
VITE_API_URL=http://<backend-host>:8000
```
**Viewer Frontend:**
Create `viewer-frontend/.env`:
```bash
DATABASE_URL=postgresql://ladmin:[PASSWORD]@10.0.10.179:5432/punimtag
DATABASE_URL_AUTH=postgresql://ladmin:[PASSWORD]@10.0.10.179:5432/punimtag_auth
NEXTAUTH_URL=http://10.0.10.121:3001
DATABASE_URL=postgresql://ladmin:[PASSWORD]@<db-host>:5432/punimtag
DATABASE_URL_AUTH=postgresql://ladmin:[PASSWORD]@<db-host>:5432/punimtag_auth
NEXTAUTH_URL=http://<backend-host>:3001
NEXTAUTH_SECRET=dev-secret-key-change-in-production
```
@@ -263,17 +263,17 @@ sudo systemctl status punimtag-worker
1. **Check API Health:**
```bash
curl http://10.0.10.121:8000/api/v1/health
curl http://<backend-host>:8000/api/v1/health
```
2. **Check API Documentation:**
Open browser: `http://10.0.10.121:8000/docs`
Open browser: `http://<backend-host>:8000/docs`
3. **Access Admin Frontend:**
Open browser: `http://10.0.10.121:3000`
Open browser: `http://<backend-host>:3000`
4. **Access Viewer Frontend:**
Open browser: `http://10.0.10.121:3001`
Open browser: `http://<backend-host>:3001`
---
@@ -501,7 +501,7 @@ curl http://localhost:8000/api/v1/health
redis-cli ping
# PostgreSQL
psql -h 10.0.10.179 -U ladmin -d punimtag -c "SELECT 1;"
psql -h <db-host> -U ladmin -d punimtag -c "SELECT 1;"
```
---