reworked to distribute via clone, not registry

This commit is contained in:
lichenblankie 2026-06-03 04:39:58 +00:00
parent 495968ae27
commit 4a0214f020

View file

@ -50,34 +50,37 @@ Run the downloaded file — no installation required.
## Docker
Pull and run TinyWeb from the container registry:
TinyWeb is distributed as source. Clone the repo, then build and run with Docker Compose:
```bash
docker run -p 8080:8080 registry.derickphan.com/tinyweb:latest
git clone https://git.derickphan.com/lichenblankie/tinyweb.git
cd tinyweb
docker compose up -d
```
Or with a specific version:
```bash
docker run -p 8080:8080 registry.derickphan.com/tinyweb:v0.1.0
```
### Docker Compose
The bundled `docker-compose.yml` builds the image from source and persists your data in a named volume:
```yaml
services:
tinyweb:
image: registry.derickphan.com/tinyweb:latest
build: .
ports:
- "8080:8080"
volumes:
- tinyweb-data:/data
restart: unless-stopped
volumes:
tinyweb-data:
```
Run with `docker compose up -d`.
After the first build, the image is cached locally and subsequent `docker compose up -d` calls are instant. To update to the latest source:
```bash
git pull && docker compose up -d --build
```
If you're on macOS or need to reach a Reticulum node over TCP, uncomment the `RNS_TCP_HOST` / `RNS_TCP_PORT` block in `docker-compose.yml` and point it at a host running Reticulum. On Linux with LAN auto-discovery, leave it as-is (or switch to `network_mode: host`).
### Storage Estimates
@ -122,13 +125,18 @@ The `/export` page produces a JSON dump of your pages. It's a migration aid —
### Docker
Data is stored in the `/data` volume inside the container. Use a volume mount to persist data:
When you run via `docker compose up` (above), data is stored in the `tinyweb-data` named volume and persists across rebuilds. To inspect or back up:
```bash
docker run -p 8080:8080 -v tinyweb-data:/data registry.derickphan.com/tinyweb:latest
docker compose exec tinyweb ls -la /data
docker compose down # stop without removing the volume
```
Or with docker-compose (see above) — data persists in the named volume.
To reset everything (destroys your index and identity — back up first):
```bash
docker compose down -v
```
### Command line options