Skip to content

docs: add docker-compose example to README #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gordonmurray merged 1 commit into from
Apr 6, 2026
Merged

docs: add docker-compose example to README #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,24 @@ docker run --rm -p 8080:8080 \
- **Port:** change host port with `-p 9000:8080`.
- **Read-only mount:** keep `:ro` to avoid accidental writes in future versions.

### Docker Compose

For pipelines or multi-container setups where lance-data-viewer shares a data volume with other services:

```yaml
services:
lance-viewer:
image: ghcr.io/lance-format/lance-data-viewer:lancedb-0.24.3
environment:
DATA_PATH: /data
volumes:
- lance-data:/data:ro
ports:
- "8888:8080"
```

Port 8080 is the default inside the container. The example maps to 8888 on the host to avoid conflicts with services like Airflow or Jenkins that also use 8080.

### Images & registries

- **GitHub Container Registry** (`ghcr.io/gordonmurray/lance-data-viewer:TAG`).
Expand Down
Loading