CI / Test (ubuntu-latest) (push) Canceled after 0s
CI / Test (windows-latest) (push) Canceled after 0s
CI / Storage tests on PostgreSQL (push) Canceled after 0s
CI / Complement (federation off) (push) Canceled after 0s
CI / golangci-lint (push) Canceled after 0s
CI / Smoke test the binary (push) Canceled after 0s
CI / Admin panel (push) Canceled after 0s
CI / Web client (push) Canceled after 0s
CI / Desktop client (ubuntu-24.04) (push) Canceled after 0s
CI / Desktop client (windows-latest) (push) Canceled after 0s
The pocketbase driver no longer embeds PocketBase: Warp keeps its data as PocketBase collections on a server of its own and reaches it only through the REST API, the way the postgres driver reaches PostgreSQL. database.connection_string is the server's URL, and Warp signs in as the superuser in WARP_PB_SUPERUSER_EMAIL / WARP_PB_SUPERUSER_PASSWORD (or a WARP_PB_SUPERUSER_FILE of the two). Every SQL table is a superuser-only collection of the same name and columns, created by warp migrate. Reads go through PocketBase's SQL endpoint with the SQL drivers' queries, via a read-only database/sql driver that inlines arguments, moves long ones into warp_params and pages past 1000 rows. Writes are record operations in batch requests under one write lock in the Warp process. Media is a protected file field in warp_media, local or in the S3 bucket Warp writes into PocketBase's settings. Search matches word prefixes with LIKE. The storage tests run against an in-process PocketBase and pass as on SQLite. Docker: the PocketBase stacks get a pocketbase service running tajniak81/pocketbase-docker-root (WARP_PB_IMAGE), with a pb-data volume and its admin UI on loopback; the AIO images run that PocketBase binary as a process beside the homeserver, making up a superuser when none is set. The .env examples, READMEs, docs and warp.yaml.example follow. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
130 lines
4.9 KiB
YAML
130 lines
4.9 KiB
YAML
# Warp on PocketBase with media in an S3 bucket elsewhere: the homeserver,
|
|
# the admin panel and the web client, each in its own container, built from
|
|
# this checkout.
|
|
#
|
|
# cd Docker
|
|
# cp .env.pocketbase.s3.example .env # then edit it
|
|
# docker compose -f docker-compose.pocketbase.s3.yml up -d --build
|
|
#
|
|
# The database is PocketBase's, in pb-data; media goes to the bucket
|
|
# WARP_PB_S3_BUCKET (default warp) on WARP_PB_S3_ENDPOINT, which must already
|
|
# exist: nothing here runs a gateway or creates the bucket. For a gateway on
|
|
# this Docker host, use http://host.docker.internal:8333; the host entry below
|
|
# makes that name resolve. For a SeaweedFS that comes up with the stack, see
|
|
# docker-compose.pocketbase.seaweedfs.yml. Media stored before S3 was on is
|
|
# not moved into the bucket.
|
|
#
|
|
# Homeserver http://localhost:8008, admin panel http://localhost:8009, web
|
|
# client http://localhost:8080.
|
|
#
|
|
# Create the first administrator once the server is up:
|
|
#
|
|
# docker compose -f docker-compose.pocketbase.s3.yml exec warp warp create-account --username admin --admin
|
|
|
|
name: warp-pocketbase-s3
|
|
|
|
services:
|
|
# PocketBase, the homeserver's database: Warp's collections, and media in
|
|
# PocketBase's storage, are in the pb-data volume. The image creates the
|
|
# superuser from .env on its first start, and never changes it after: a
|
|
# new password goes in through the admin UI, then into .env. The admin UI
|
|
# is http://localhost:8070/_/ on loopback; WARP_PB_BIND=0.0.0.0 exposes
|
|
# it, behind a reverse proxy only.
|
|
pocketbase:
|
|
image: ${WARP_PB_IMAGE:-tajniak81/pocketbase-docker-root:latest}
|
|
restart: unless-stopped
|
|
extra_hosts:
|
|
# Lets WARP_PB_S3_ENDPOINT name the Docker host as host.docker.internal:
|
|
# PocketBase is what talks to the bucket.
|
|
- "host.docker.internal:host-gateway"
|
|
environment:
|
|
PB_PORT: "8070"
|
|
PB_ADMIN_EMAIL: ${WARP_PB_SUPERUSER_EMAIL:?set WARP_PB_SUPERUSER_EMAIL in .env}
|
|
PB_ADMIN_PASSWORD: ${WARP_PB_SUPERUSER_PASSWORD:?set WARP_PB_SUPERUSER_PASSWORD in .env}
|
|
volumes:
|
|
- ${WARP_PB_DATA_VOLUME:-pb-data}:/pb/pb_data
|
|
ports:
|
|
- "${WARP_PB_BIND:-127.0.0.1}:${WARP_PB_PORT:-8070}:8070"
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "wget -qO- http://127.0.0.1:8070/api/health >/dev/null || exit 1"]
|
|
interval: 5s
|
|
timeout: 3s
|
|
retries: 20
|
|
start_period: 10s
|
|
|
|
warp:
|
|
build:
|
|
context: ..
|
|
dockerfile: Dockerfile
|
|
image: warp:latest
|
|
restart: unless-stopped
|
|
depends_on:
|
|
pocketbase:
|
|
condition: service_healthy
|
|
extra_hosts:
|
|
# Lets WARP_PB_S3_ENDPOINT name the Docker host as host.docker.internal.
|
|
- "host.docker.internal:host-gateway"
|
|
# The homeserver does not check the endpoint at startup and would only
|
|
# fail on the first upload, so wait up to 30 seconds for it to answer at
|
|
# all (any HTTP status). The signing key is created on first start and
|
|
# kept in the volume: losing it means other servers no longer recognise
|
|
# this one.
|
|
entrypoint: ["/bin/sh", "-c"]
|
|
command:
|
|
- >-
|
|
i=0; until curl -s -o /dev/null --max-time 5 "$$WARP_PB_S3_ENDPOINT"; do
|
|
i=$$((i + 1)); if [ "$$i" -ge 30 ]; then echo "S3 endpoint $$WARP_PB_S3_ENDPOINT does not answer" >&2; exit 1; fi;
|
|
echo "waiting for S3 endpoint $$WARP_PB_S3_ENDPOINT" >&2; sleep 1; done;
|
|
test -f /data/signing.key || warp generate-keys --output /data/signing.key; exec warp serve
|
|
env_file: .env
|
|
environment:
|
|
WARP_DB_DRIVER: pocketbase
|
|
WARP_DB_CONNECTION_STRING: http://pocketbase:8070
|
|
WARP_PB_S3_ENABLED: "true"
|
|
WARP_PB_S3_ENDPOINT: ${WARP_PB_S3_ENDPOINT:?set WARP_PB_S3_ENDPOINT in .env}
|
|
WARP_PB_S3_BUCKET: ${WARP_PB_S3_BUCKET:-warp}
|
|
# SeaweedFS and MinIO ignore the region; the client insists on one.
|
|
WARP_PB_S3_REGION: ${WARP_PB_S3_REGION:-us-east-1}
|
|
WARP_PB_S3_ACCESS_KEY: ${WARP_PB_S3_ACCESS_KEY:?set WARP_PB_S3_ACCESS_KEY in .env}
|
|
WARP_PB_S3_SECRET: ${WARP_PB_S3_SECRET:?set WARP_PB_S3_SECRET in .env}
|
|
# true for SeaweedFS and MinIO, false for AWS S3 proper.
|
|
WARP_PB_S3_FORCE_PATH_STYLE: ${WARP_PB_S3_FORCE_PATH_STYLE:-true}
|
|
volumes:
|
|
- ${WARP_DATA_VOLUME:-warp-data}:/data
|
|
ports:
|
|
- "${WARP_PORT:-8008}:8008"
|
|
|
|
admin:
|
|
build:
|
|
context: ..
|
|
dockerfile: apps/admin/Dockerfile
|
|
image: warp-admin:latest
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- warp
|
|
env_file: .env
|
|
environment:
|
|
WARP_ADMIN_HOMESERVER: http://warp:8008
|
|
ports:
|
|
- "${WARP_ADMIN_PORT:-8009}:8009"
|
|
|
|
web:
|
|
build:
|
|
context: ..
|
|
dockerfile: apps/web/Dockerfile
|
|
image: warp-web:latest
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- warp
|
|
env_file: .env
|
|
environment:
|
|
WARP_WEB_HOMESERVER: http://warp:8008
|
|
ports:
|
|
- "${WARP_WEB_PORT:-8080}:8080"
|
|
|
|
volumes:
|
|
# The homeserver's signing key.
|
|
warp-data:
|
|
# PocketBase's pb_data: the database, and media unless it is in S3.
|
|
pb-data:
|