tajniak81andClaude Opus 5
9a2a4ab72e
Every attachment — a document scan, a fuel receipt, a workshop invoice, a
photo of a part's box — has lived inside pb_data, in a directory beside the
SQLite file. One volume held both, so neither could be sized, backed up or
moved without the other. PocketBase can keep those bytes in an S3 bucket
instead, and now it is told to.
Nothing on the way to a client changes, because an attachment was never a
storage URL to begin with: it is fetched from GET /api/{records}/{id}/file,
which re-checks car access and asks PocketBase for the bytes as the service
account. PocketBase streams from the bucket through that same endpoint rather
than redirecting to it, so the web app, the phone and the plugin cannot tell
which side of the switch they are on.
The bootstrap that already creates the collections now writes PocketBase's
files-storage settings too, from PB_S3_*, on every boot and only when they
differ from what is already there — then asks PocketBase to prove it can reach
the bucket, and says so in the log either way. Two asymmetries are deliberate.
A read of the settings masks the stored secret, so a rotation of the secret
alone is invisible from here and needs another PB_S3_* to move with it. And it
never turns S3 back off: files already written to a bucket are reachable only
while PocketBase still points at it, so dropping the configuration would strand
them rather than undo anything.
Each deployment shape is one compose file with an .env example of the same
name, not a base plus an overlay to remember — six of each per folder, for
Docker and Docker-AIO alike: the plain one, .seaweedfs, .s3, and the three prod
twins. The SeaweedFS files run master, volume, filer and gateway as one process
and a one-shot init container beside it, because PocketBase never issues a
CreateBucket and SeaweedFS will not conjure one on first upload. The credentials
do double duty there — the gateway's only identity is also what PocketBase
authenticates with. In the all-in-one that gateway is a second container rather
than a fourth process under supervisord: keeping the object store inside the
image, on the volume the files are being moved off, would have defeated the
point and would have meant rebuilding.
Files uploaded before the switch are not carried across; PocketBase copies
nothing, and both READMEs say so where an operator will read it.
The TLS overlay and its Caddyfile go. The section they served stays, without
them: nothing in the stack terminates TLS any more, so it now names the four
variables to set in front of whichever proxy already does — TRUST_FORWARDED_PROTO
being the one that decides whether a charger is believed about how it arrived.
Unexercised: this was written on a machine without Docker, so the pinned
SeaweedFS image, the bucket-create and the settings write have not been run
against a live stack. The Go side builds, vets and tests clean.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
180 lines
8.1 KiB
Markdown
180 lines
8.1 KiB
Markdown
# DriverVault — Docker AIO (all-in-one image)
|
|
|
|
**PocketBase + API Server + Web App in a single container**, supervised by
|
|
`supervisord` with nginx serving the SPA and proxying `/api/` to the API Server
|
|
on localhost. One image, one volume set, no compose network — the simplest way
|
|
to stand DriverVault up on a single host.
|
|
|
|
Prefer the three-container stack in [`../Docker`](../Docker) when you want to
|
|
scale, upgrade or restart the pieces independently.
|
|
|
|
```
|
|
:80 nginx ─► SPA, and /api/ ─► API Server on 127.0.0.1:8080 ─► PocketBase on :8070
|
|
```
|
|
|
|
| File | Use |
|
|
|---|---|
|
|
| `Dockerfile` | the all-in-one image (build context must be the **repo root**) |
|
|
| `docker-compose.yml` | **builds from source** — for development and local testing |
|
|
| `docker-compose.prod.yml` | **pulls the prebuilt image** from the registry |
|
|
| `.env.example` / `.env.prod.example` | copy to `.env` for the matching compose file |
|
|
|
|
## Run it
|
|
|
|
```bash
|
|
cd "Docker-AIO"
|
|
cp .env.example .env # then edit — PB_ADMIN_* have no safe defaults
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Production, from the registry:
|
|
|
|
```bash
|
|
cp .env.prod.example .env # then edit
|
|
docker compose -f docker-compose.prod.yml pull
|
|
docker compose -f docker-compose.prod.yml up -d
|
|
```
|
|
|
|
Then: web app on `http://host:8090/`, the API Server's superadmin panel on
|
|
`http://host:8080/`, PocketBase admin on `http://host:8070/_/`.
|
|
|
|
Note the port mapping: inside the container the web app is on **80**, published
|
|
as `WEB_PORT` (8090 by default) to line up with the other deployment.
|
|
|
|
## Building by hand
|
|
|
|
The build context **must be the repo root** so the Dockerfile can reach both
|
|
`API Server/` and `Web App/`:
|
|
|
|
```bash
|
|
docker build -f "Docker-AIO/Dockerfile" -t drivervault-aio .
|
|
```
|
|
|
|
Build args: `VITE_API_BASE` (leave empty so the bundle uses same-origin `/api`)
|
|
and `PB_VERSION`, which the Dockerfile already pins. Override it to build a
|
|
different PocketBase; set it to an empty string to resolve the latest release at
|
|
build time instead.
|
|
|
|
## First boot
|
|
|
|
Identical to the multi-container stack, and idempotent:
|
|
|
|
1. PocketBase upserts its superuser from `PB_ADMIN_EMAIL` / `PB_ADMIN_PASSWORD`.
|
|
2. The API Server waits for PocketBase to report healthy, then creates any
|
|
missing collections, reconciles existing ones, and creates the first app
|
|
`superadmin` from `DRIVERVAULT_SUPERADMIN_EMAIL` / `_PASSWORD`.
|
|
|
|
> Leave `PB_BOOTSTRAP` at `true`, including across upgrades. A release can add
|
|
> collections or fields the server needs, and a stack that skipped the bootstrap
|
|
> never gets them. The API Server self-heals exactly one thing — `app_settings`,
|
|
> the collection holding the plugin settings, which it creates on demand because
|
|
> it cannot serve the plugin panel without it. Every other schema change still
|
|
> depends on this flag, so turn it off only for a database you know already
|
|
> matches the release you are running.
|
|
|
|
## Volumes
|
|
|
|
| Volume | Holds |
|
|
|---|---|
|
|
| `/pb/pb_data` | the PocketBase SQLite database and uploaded files — everything that persists |
|
|
|
|
One volume, because the API Server keeps no state on disk. Plugin enable-state
|
|
and global config live in the database like the rest of the settings, so backing
|
|
up this one path backs up the whole image. It defaults to a Docker-managed named
|
|
volume; set `PB_DATA` to an absolute host path in the prod file for a bind mount.
|
|
|
|
> One thing does **not** persist: the API Server panel's *Settings → PocketBase*
|
|
> and *Settings → Web App* screens apply immediately but only for the life of the
|
|
> container. Set the corresponding environment variables to change them
|
|
> permanently.
|
|
|
|
## File storage (SeaweedFS / S3)
|
|
|
|
Uploaded files — document scans, service and refill receipts, workshop invoices,
|
|
part photos — live inside `pb_data` by default, next to the database. Two further
|
|
compose files put them in an S3 bucket instead, so the blobs and the database can
|
|
be sized, backed up and moved independently. Nothing else changes: an attachment has
|
|
always been fetched through the API Server (`GET /api/service-records/{id}/file`),
|
|
never from a storage URL, so the Web App, the phone app and the Home Assistant
|
|
plugin cannot tell the difference.
|
|
|
|
Each shape is one self-contained compose file — nothing to layer, nothing to
|
|
remember — with an `.env` example of the same name:
|
|
|
|
| Shape | From the registry | From source |
|
|
|---|---|---|
|
|
| **Local storage** — the default, unchanged | `docker-compose.prod.yml` | `docker-compose.yml` |
|
|
| **SeaweedFS beside the image** | `docker-compose.prod.seaweedfs.yml` | `docker-compose.seaweedfs.yml` |
|
|
| **An S3 endpoint elsewhere** | `docker-compose.prod.s3.yml` | `docker-compose.s3.yml` |
|
|
|
|
So `docker-compose.prod.seaweedfs.yml` is configured from
|
|
`.env.prod.seaweedfs.example`, `docker-compose.s3.yml` from `.env.s3.example`,
|
|
and so on:
|
|
|
|
```sh
|
|
cp .env.prod.seaweedfs.example .env # then edit it — PB_S3_* have no defaults
|
|
docker compose -f docker-compose.prod.seaweedfs.yml pull
|
|
docker compose -f docker-compose.prod.seaweedfs.yml up -d
|
|
```
|
|
|
|
Set `PB_S3_ACCESS_KEY` and `PB_S3_SECRET` first — both storage files refuse to
|
|
start without them. The SeaweedFS ones run the gateway as a **second container**
|
|
(master, volume, filer and S3 in one process, on its own `seaweed_data` volume)
|
|
rather than a fourth process under supervisord: keeping the object store in this
|
|
image, on the volume the files are being moved off, would defeat the point and
|
|
would mean rebuilding. They also run a one-shot `seaweedfs-init` that creates the
|
|
bucket, because PocketBase never issues a `CreateBucket` of its own. The
|
|
external-S3 ones add no containers at all: set `PB_S3_ENDPOINT`, and create the
|
|
bucket yourself.
|
|
|
|
On every boot the API Server's bootstrap writes PocketBase's *Files storage*
|
|
settings from those variables, then asks PocketBase to prove it can reach the
|
|
bucket. Watch for it in the log:
|
|
|
|
```
|
|
[api] bootstrap: ✓ file storage → S3 (drivervault at http://seaweedfs:8333)
|
|
[api] bootstrap: ✓ S3 storage reachable
|
|
```
|
|
|
|
A boot that finds the settings already correct logs `• file storage already on S3`
|
|
and writes nothing.
|
|
|
|
Two things to know before turning it on:
|
|
|
|
- **Existing files are not migrated.** PocketBase copies nothing when the setting
|
|
flips, so attachments uploaded before the switch stop resolving. Copy
|
|
`pb_data/storage/<collectionId>/<recordId>/<file>` into the bucket root, keeping
|
|
that layout, *before* enabling it — or start from a stack with no attachments.
|
|
- **Going back to the plain compose file is not an off switch.** It leaves
|
|
PocketBase pointed at
|
|
the bucket, deliberately: files already written there are reachable only while
|
|
it is. Move them back and turn it off in PocketBase's own admin UI. For the same
|
|
reason a rotation of `PB_S3_SECRET` alone is invisible to the bootstrap —
|
|
PocketBase masks the stored secret on read — so change another `PB_S3_*` value
|
|
alongside it, or set it in the admin UI.
|
|
|
|
## Charger control (OCPP)
|
|
|
|
Chargers in own/proxy mode dial in to `/ocpp/{serial}` on the **API Server port
|
|
(8080)** — not through nginx — authenticating with a per-charger control token
|
|
in an OCPP Basic-auth header. Because a plaintext `ws://` would expose that
|
|
token, `OCPP_REQUIRE_TLS` defaults to `true`.
|
|
|
|
This image serves plain HTTP, so charger control needs TLS terminated in front
|
|
of it, with `OCPP_PUBLIC_URL` set to the public `wss://` base. Only drop
|
|
`OCPP_REQUIRE_TLS` on a trusted network.
|
|
|
|
## Caveats
|
|
|
|
- PocketBase and the API Server run as the unprivileged `app` user; only nginx
|
|
stays root, because it binds port 80. A crash of `supervisord` still takes all
|
|
three services down together — that is the trade for the simplicity.
|
|
- Logs from all three processes are interleaved on the container's stdout/stderr
|
|
(`docker logs drivervault-aio`).
|
|
- `PB_VERSION` is pinned in the Dockerfile so two builds of the same source
|
|
agree. Setting it to an empty string restores the old behaviour of resolving
|
|
the latest release **at build time**, which also costs an unauthenticated
|
|
GitHub API call and is subject to that 60/hour per-IP rate limit.
|
|
- The container reports health once all three processes answer their probes, so
|
|
a wedged component shows up in `docker ps` rather than looking up.
|