docs: README quick-start reflects registry-pull + source types
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014TtR4PP2JM9KadaBkhPGAE
This commit is contained in:
@@ -23,16 +23,29 @@ subscription conversion and API/UI are new.
|
||||
|
||||
## Quick start
|
||||
|
||||
Images are built and pushed to the Gitea container registry by CI, so the
|
||||
default compose pulls them:
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
# edit .env: set ADMIN_PASSWORD and SESSION_SECRET (long random)
|
||||
docker compose up -d --build
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
To build the images locally from source instead of pulling, add the build
|
||||
override:
|
||||
|
||||
```sh
|
||||
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
|
||||
```
|
||||
|
||||
Open http://localhost:8088 and sign in with `ADMIN_USER` / `ADMIN_PASSWORD`.
|
||||
|
||||
Then in the panel:
|
||||
1. **Settings → Sources**: add one or more list URLs (see TODO.md for examples).
|
||||
1. **Settings → Sources**: add one or more list URLs and pick the type
|
||||
(`auto` tries base64 then plain, or force `plain` / `base64`). See TODO.md
|
||||
for example lists.
|
||||
2. **Run check** (top bar) or wait for the scheduled interval.
|
||||
3. Working proxies appear in **Proxies**; build client feeds in **Subscriptions**.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user