Update Readme
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 3m27s

Signed-off-by: Daniel Henry <iamdanhenry@gmail.com>
This commit is contained in:
2026-03-31 18:40:32 -05:00
parent bcb4714778
commit 4820888ff9

View File

@@ -44,7 +44,39 @@ docker run --rm -p 8080:8080 --env-file .env notebook-tools:local
`LLAMA_BASE_URL` / `PAPERLESS_BASE_URL` must be reachable **from inside the container** (use `host.docker.internal` on Docker Desktop, or your LAN IP, not `127.0.0.1` for services on the host). `LLAMA_BASE_URL` / `PAPERLESS_BASE_URL` must be reachable **from inside the container** (use `host.docker.internal` on Docker Desktop, or your LAN IP, not `127.0.0.1` for services on the host).
CI: on push to `main`, [.gitea/workflows/build-docker.yml](.gitea/workflows/build-docker.yml) builds and pushes using the same secrets pattern as your other Gitea repos (`DOCKER_REGISTRY`, `DOCKER_USERNAME`, `DOCKER_PASSWORD`). For Docker Hub, set `DOCKER_REGISTRY` to `docker.io` (or leave per your runner docs). ### Docker Compose
Save as `compose.yaml` (any directory with your `.env`):
```yaml
services:
notebook-tools:
image: git.danhenry.dev/daniel/notebook-tools:latest
ports:
- "8080:8080"
env_file:
- .env
# Lets the container reach services bound on the host (e.g. llama on :9292).
# Linux: requires Docker 20.10+ / Compose v2; omit on Docker Desktop if already available.
extra_hosts:
- "host.docker.internal:host-gateway"
```
```bash
docker compose pull && docker compose up
```
Log in to `git.danhenry.dev` first if the registry requires auth: `docker login git.danhenry.dev`.
For llama running **on the host**, set in `.env`:
```bash
LLAMA_BASE_URL="http://host.docker.internal:9292"
```
`PAPERLESS_BASE_URL` can stay a normal `https://…` URL if the container has network access to it.
CI: on push to `main`, [.github/workflows/build-docker.yml](.github/workflows/build-docker.yml) builds and pushes using the same secrets pattern as your other Gitea repos (`DOCKER_REGISTRY`, `DOCKER_USERNAME`, `DOCKER_PASSWORD`). For Docker Hub, set `DOCKER_REGISTRY` to `docker.io` (or leave per your runner docs).
## Example `.env` ## Example `.env`