跳到主要内容

Self-Hosting with Docker

Run your own private instance of B1 Admin, the B1 member portal, the API, and a MySQL database on any machine with Docker — a home server, a $5 VPS, or an on-prem box. One docker compose up builds and starts everything. If you'd rather not manage a server at all, see Self-Hosting on Railway for the managed alternative.

Quick Start​

What You Need

  • Docker Engine with Compose v2 (included in Docker Desktop)
  • ~4 GB of RAM available during the initial build (the web apps are built from source)
  • Git, or just the raw docker-compose.yml file
git clone https://github.com/ChurchApps/B1Admin.git
cd B1Admin
docker compose up -d

The first run takes 10–20 minutes: it builds B1Admin from your clone and builds the API and B1App directly from their GitHub repositories. Subsequent starts are seconds.

When all four services are up:

  1. Open http://localhost:3101 (B1 Admin).
  2. Click Register and create your account. The first account is automatically a server admin.
  3. Follow the in-app prompts to create your first church.

Database schemas are created automatically by the API container's startup migration — no manual SQL required.

ServiceURL
B1Admin (staff/admin)http://localhost:3101
B1App (member portal / website)http://localhost:3000
APIhttp://localhost:8084
MySQLinternal only (mysql:3306 on the compose network)

Configuration​

All settings live in a .env file next to docker-compose.yml. Every variable has a working default for localhost, so the file is optional until you customize.

# .env — everything is optional; shown with defaults
MYSQL_ROOT_PASSWORD=churchapps
JWT_SECRET=please-change-this-jwt-secret
ENCRYPTION_KEY=PleaseChangeThisDockerDefaultKey   # exactly 32 characters

# Public URLs (change these when exposing beyond localhost)
API_URL=http://localhost:8084
B1ADMIN_URL=http://localhost:3101
B1APP_URL=http://localhost:3000
SOCKET_URL=ws://localhost:8084

# Email — see the Railway guide's Email section for provider walkthroughs
MAIL_SYSTEM=
SMTP_HOST=
SMTP_USER=
SMTP_PASS=
SMTP_SECURE=false
SUPPORT_EMAIL=noreply@yourchurch.org

Before real use, change MYSQL_ROOT_PASSWORD, JWT_SECRET, and ENCRYPTION_KEY (any 32-character string).

注意

The *_URL values are baked into the web apps at build time (standard Vite/Next.js behavior). Changing them in .env requires a rebuild, not just a restart:

docker compose up -d --build

Changing the MySQL password after first launch requires updating the password inside MySQL too — the volume keeps the old credentials.

Exposing It to the Internet​

Put any reverse proxy in front and give each service a hostname. With Caddy it's this:

admin.yourchurch.org { reverse_proxy localhost:3101 }
app.yourchurch.org   { reverse_proxy localhost:3000 }
api.yourchurch.org   { reverse_proxy localhost:8084 }

Then set the URLs in .env and rebuild:

API_URL=https://api.yourchurch.org
B1ADMIN_URL=https://admin.yourchurch.org
B1APP_URL=https://app.yourchurch.org
SOCKET_URL=wss://api.yourchurch.org
docker compose up -d --build

The WebSocket used for chat and live notifications shares the API's port, so SOCKET_URL is just the API URL with wss://.

Email, Giving, Multi-Site, and Integrations​

These work identically to the Railway deployment — the same environment variables, set in your .env file instead of the Railway dashboard (the compose file passes them through to the API):

  • Email / SMTP — strongly recommended; without it members can't reset passwords
  • Multi-site — unlimited churches per instance, managed in the admin UI
  • Online giving — configured per-church in the admin UI, not via env vars
  • Optional integrations — OPENAI_API_KEY, YOUTUBE_API_KEY, PEXELS_KEY, VIMEO_TOKEN, API_BIBLE_KEY, WEB_PUSH_PUBLIC_KEY/WEB_PUSH_PRIVATE_KEY, GOOGLE_RECAPTCHA_SECRET_KEY

Data, Backups, and File Storage​

Two named Docker volumes hold all state:

VolumeContents
mysql-dataAll database schemas
api-contentUploaded files — photos, documents, website images (mounted at /app/content)

Back up the database with a one-liner (schedule it with cron):

docker compose exec mysql mysqldump -uroot -p"$MYSQL_ROOT_PASSWORD" --all-databases > backup-$(date +%F).sql

Back up uploaded files by copying the volume:

docker run --rm -v b1admin_api-content:/data -v "$PWD":/backup alpine tar czf /backup/content-$(date +%F).tgz -C /data .

For large media libraries you can switch file storage to S3 instead of the local volume — set FILE_STORE=S3 plus the AWS_* variables described in the Railway guide's File Storage section.

Updating​

The API and B1App build from the main branch of their GitHub repos; B1Admin builds from your local clone.

git pull                              # update B1Admin
docker compose build --pull           # rebuild all images against latest main
docker compose up -d

Database migrations run automatically when the API container starts.

To pin versions instead of tracking main, point the build contexts at a tag in .env:

API_CONTEXT=https://github.com/ChurchApps/Api.git#v1.2.3
B1APP_CONTEXT=https://github.com/ChurchApps/B1App.git#v1.2.3

Developers can point the same variables at local checkouts (e.g. API_CONTEXT=../Api).

Troubleshooting​

SymptomLikely causeFix
api container restarts in a loopMySQL not ready or migration failuredocker compose logs api — the migration prints which module failed
Login redirects to api.churchapps.orgWeb app built without the custom stage argsRebuild: docker compose build --no-cache b1admin b1app
Changed a URL in .env but nothing happenedURLs are baked at build timedocker compose up -d --build
"Check your email" but no email arrivesMAIL_SYSTEM=SMTP with bad credentialsFix credentials, or unset MAIL_SYSTEM to disable email
Chat / live features silentSOCKET_URL unreachable from the browserMust be wss:// behind HTTPS and proxied to port 8084
Build dies on a small VPSOut of memory during next buildAdd swap, or build on another machine and docker save/load

Still stuck? Open an issue at github.com/ChurchApps/ChurchAppsSupport/issues with the output of docker compose logs.