jason/cpas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

user auth documentation changes
Build and Push Docker Image / build (push) Successful in 16s
Details

Browse Source
This commit is contained in:
jason
2026-05-27 09:12:45 -05:00
parent 97be2d2908
commit 08401afd28
4 changed files with 116 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README_UNRAID_INSTALL.md
+31 -2
View File
@@ -152,6 +152,31 @@ Click **Add another Path, Port, Variable, Label or Device** for each:
| Key | `DB_PATH` |
| Value | `/data/cpas.db` |
**Variable 3 — Admin Username**
| Setting | Value |
|---|---|
| Config Type | `Variable` |
| Name | `Admin Username` |
| Key | `ADMIN_USERNAME` |
| Value | `admin` |
**Variable 4 — Admin Password**
| Setting | Value |
|---|---|
| Config Type | `Variable` |
| Name | `Admin Password` |
| Key | `ADMIN_PASSWORD` |
| Value | *(set a strong password — do not leave the default)* |
> **Important:** The app requires login. The admin account is created from
> `ADMIN_USERNAME` / `ADMIN_PASSWORD` on every start. **Always set a strong
> `ADMIN_PASSWORD`** — the image ships with a placeholder (`changeme`) that must
> be overridden. To rotate the admin password later, change this value and
> **Restart** the container. Additional user accounts are created in-app by an
> admin (top-right **Users** button) and are not affected by restarts.
---
### 5.6 Apply
@@ -167,8 +192,10 @@ Click **Add another Path, Port, Variable, Label or Device** for each:
1. Docker tab → **cpas-tracker** should show a green icon
2. Click the container icon → **WebUI**
Or open: `http://[YOUR-UNRAID-IP]:3001`
3. Confirm **● API connected** appears in the header
4. Health check: `http://[YOUR-UNRAID-IP]:3001/api/health`
3. A **login screen** appears. Sign in with the `ADMIN_USERNAME` / `ADMIN_PASSWORD`
you set in step 5.5.
4. Confirm **● API connected** appears in the header
5. Health check (no login required): `http://[YOUR-UNRAID-IP]:3001/api/health`
→ `{"status":"ok","timestamp":"..."}`
---
@@ -197,6 +224,8 @@ docker save cpas-tracker | gzip > cpas-tracker.tar.gz
| Problem | Fix |
|---|---|
| Container won't start | Docker tab → container icon → **Logs** |
| Can't log in / forgot admin password | Edit Container → set a new `ADMIN_PASSWORD` → **Restart**. The admin password re-syncs from this variable on every start. |
| "ADMIN_PASSWORD not set" in logs | Add the `ADMIN_PASSWORD` variable (step 5.5) and restart — without it the admin account is not created. |
| Port 3001 conflict | Change Host Port to `3002` in Edit Container |
| "API unreachable" in UI | Confirm green icon, check Logs, try Restart |
| DB permission error | Terminal: `chmod 755 /mnt/user/appdata/cpas/db` |