Add Docker setup instructions

This commit is contained in:
lichenblankie 2026-04-11 07:20:52 +00:00
parent 26b5d899ae
commit 552311b730

View file

@ -14,7 +14,7 @@ A personal, decentralized search engine built on the [Reticulum](https://reticul
## Download (pre-built binaries) ## Download (pre-built binaries)
Download the latest release for your platform from the [GitHub Releases](https://github.com/anomalyco/tinyweb/releases) page: Download the latest release for your platform from the [Releases](https://git.derickphan.com/lichenblankie/tinyweb/releases) page:
| Platform | File | | Platform | File |
|----------|------| |----------|------|
@ -24,8 +24,41 @@ Download the latest release for your platform from the [GitHub Releases](https:/
Run the downloaded file — no installation required. Run the downloaded file — no installation required.
## Docker
Pull and run TinyWeb from the container registry:
```bash
docker run -p 8080:8080 registry.derickphan.com/tinyweb:latest
```
Or with a specific version:
```bash
docker run -p 8080:8080 registry.derickphan.com/tinyweb:v0.1.0
```
### Docker Compose
```yaml
services:
tinyweb:
image: registry.derickphan.com/tinyweb:latest
ports:
- "8080:8080"
volumes:
- tinyweb-data:/data
volumes:
tinyweb-data:
```
Run with `docker compose up -d`.
## Data storage ## Data storage
### Local (Python/binary)
Your data is stored in `~/.tinyweb/`: Your data is stored in `~/.tinyweb/`:
| File | Description | | File | Description |
@ -37,6 +70,16 @@ Your data is stored in `~/.tinyweb/`:
This allows your data to persist between upgrades and stay separate from the application. This allows your data to persist between upgrades and stay separate from the application.
### Docker
Data is stored in the `/data` volume inside the container. Use a volume mount to persist data:
```bash
docker run -p 8080:8080 -v tinyweb-data:/data registry.derickphan.com/tinyweb:latest
```
Or with docker-compose (see above) — data persists in the named volume.
### Command line options ### Command line options
```bash ```bash