mteehan/vacuum-wall
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation for config/ migration, new install model, and firewall config API

Browse Source 
Reflect config/ vs data/ split, install-time Jinja2 templating, auto-discovered
paths, ZeroSSL/ACME support, and the new firewall save-then-apply API in all
reference docs.
This commit is contained in:
Mike Teehan
2026-05-14 03:31:59 +00:00
parent 6106c1434d
commit dcb581a359
6 changed files with 166 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.md
+4 -4
View File
@@ -1,6 +1,6 @@
# REST API Reference
All endpoints are served by the management WebUI Flask application bound to `127.0.0.1:9090`, proxied through nginx with SSL termination and HTTP basic authentication. Requests target the management domain (e.g., `https://wall.lan/api/...`).
All endpoints are served by the management WebUI Flask application bound to `127.0.0.1:9090`, proxied through nginx with SSL termination and HTTP basic authentication. Requests target the management domain (e.g., `https://<hostname>.local/api/...`).
Every request and response uses `Content-Type: application/json`.
@@ -672,7 +672,7 @@ Configure the nginx proxy block for the management WebUI itself, including optio
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `domain` | `string` | Yes | Management domain (e.g., `"wall.lan"`) |
| `domain` | `string` | Yes | Management domain (e.g., `"myhost.local"`) |
| `flask_host` | `string` | No | Flask app bind host; defaults to `"127.0.0.1"` |
| `flask_port` | `number` | No | Flask app bind port; defaults to `9090` |
| `auth_user` | `string` | No | Username for basic auth. An `.htpasswd` entry is created when this field is present. |
@@ -686,7 +686,7 @@ If `auth_user` and `auth_pass` are provided, the endpoint creates or updates the
## Certificate API
Endpoints prefixed with `/api/certs/...`. Manage TLS certificates via ACME (Let's Encrypt / certbot).
Endpoints prefixed with `/api/certs/...`. Manage TLS certificates via ACME (ZeroSSL, Let's Encrypt, etc.).
### Listing & Details
@@ -793,7 +793,7 @@ Returns HTTP `404` if the certificate is not found.
POST /api/certs/email
```
Set or update the ACME account contact email (used by Let's Encrypt for expiration and security notices).
Set or update the ACME account contact email (used by the CA for expiration and security notices).
**Request Body:**