brokeless: fully local by default, and a README for it

- BROKE_OFFLINE=1 (on in Docker) turns off the GitHub update check and the
  exchange-rate fetch, so the server makes no calls out
- auto-update in scripts/start.mjs pulls from your own repo (origin), never upstream
- install.sh points at brokeless; drop the workflow that merged upstream by itself
- compose project and image are named brokeless
- README: what changed from broke, how to run it, how to review upstream

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
MangaValkandClaude Opus 5.5 committed 2026-11-17 14:08:42 +01:00
1 parent 861e65021f
commit cec3b15c2c
9 files changed
+139 -94

No files matched your search

+6 -16
View File
@@ -1,6 +1,6 @@
# Run broke fully on your own server
# brokeless in Docker
Everything runs here: broke, its Postgres database, sign-in and the REST API (the parts of Supabase it uses), a mail catcher for sign-in links, and optionally Ollama for AI. No Supabase cloud, no Vercel, no auto-update.
Everything runs here: the app, its Postgres database, sign-in and the REST API (the parts of Supabase it uses), a mail catcher for sign-in links, and optionally Ollama for AI. No Supabase cloud, no Vercel, no auto-update.
| Container | What it does | Port |
| --- | --- | --- |
@@ -26,7 +26,7 @@ Everything runs here: broke, its Postgres database, sign-in and the REST API (th
docker run --rm -v "$PWD":/w -w /w node:22-alpine node docker/setup.mjs --url http://192.168.1.10:3000
```
On Unraid, edit `docker/.env` and set `DATA_DIR=/mnt/user/appdata/broke`.
On Unraid, edit `docker/.env` and set `DATA_DIR=/mnt/user/appdata/brokeless`.
2. Start it:
@@ -34,7 +34,7 @@ Everything runs here: broke, its Postgres database, sign-in and the REST API (th
docker compose -f docker/docker-compose.yml up -d --build
```
With local AI as well: add `--profile ai`, then pull a model, for example `docker exec broke-ollama-1 ollama pull qwen3:8b`.
With local AI as well: add `--profile ai`, then pull a model, for example `docker exec brokeless-ollama-1 ollama pull qwen3:8b`.
3. Open your address, type your email, then open Mailpit on port 8025 (user `broke`, password `MAIL_PASSWORD` in `docker/.env`) and click the link.
@@ -53,18 +53,8 @@ Install the Compose Manager plugin, add a stack, and point it at this folder's `
- Back up `DATA_DIR/db` and `docker/.env` together. The database is useless without the secrets in `.env`.
- Database changes in `supabase/migrations` apply each time broke starts.
## Updating from upstream
## Updating
This copy never pulls by itself. To see and pick what's new:
```bash
git fetch upstream
```
```bash
git log --oneline main..upstream/main
```
Review, then `git merge upstream/main` (or `git cherry-pick <commit>` for single ones), and rebuild with `up -d --build`.
Nothing updates by itself. See [Update](../README.md#update) in the main README for pulling your own changes and reviewing upstream ones.
`docker/db/*.sql` come from Supabase's self-hosting setup (Apache-2.0).