mirror of
https://github.com/decolua/9router.git
synced 2026-05-08 12:01:28 +00:00
5d3780cfd2
- Replaced `bun run build:bun` with `npm run build` in Dockerfile for consistency. - Enhanced `DOCKER.md` to include `DATA_DIR` environment variable usage for database persistence. - Clarified paths for container and host data storage.
94 lines
1.5 KiB
Markdown
94 lines
1.5 KiB
Markdown
# Docker
|
|
|
|
This project ships with a `Dockerfile` for building and running 9Router in a container.
|
|
|
|
## Build image
|
|
|
|
```bash
|
|
docker build -t 9router .
|
|
```
|
|
|
|
## Start container
|
|
|
|
```bash
|
|
docker run --rm \
|
|
-p 20128:20128 \
|
|
-v "$HOME/.9router:/app/data" \
|
|
-e DATA_DIR=/app/data \
|
|
--name 9router \
|
|
9router
|
|
```
|
|
|
|
The app listens on port `20128` in the container.
|
|
|
|
## What the volume does
|
|
|
|
```bash
|
|
-v "$HOME/.9router:/app/data" \
|
|
-e DATA_DIR=/app/data
|
|
```
|
|
|
|
`9router` stores its database at `path.join(DATA_DIR, "db.json")`.
|
|
Without `DATA_DIR`, the app falls back to the current user's home directory (for example `~/.9router/db.json` on macOS/Linux). In the container, set `DATA_DIR=/app/data` so the bind mount is actually used.
|
|
|
|
With the example above, the database file is:
|
|
|
|
```text
|
|
/app/data/db.json
|
|
```
|
|
|
|
and it is persisted on the host at:
|
|
|
|
```text
|
|
$HOME/.9router/db.json
|
|
```
|
|
|
|
## Stop container
|
|
|
|
```bash
|
|
docker stop 9router
|
|
```
|
|
|
|
## Run in background
|
|
|
|
```bash
|
|
docker run -d \
|
|
-p 20128:20128 \
|
|
-v "$HOME/.9router:/app/data" \
|
|
-e DATA_DIR=/app/data \
|
|
--name 9router \
|
|
9router
|
|
```
|
|
|
|
## View logs
|
|
|
|
```bash
|
|
docker logs -f 9router
|
|
```
|
|
|
|
## Optional environment variables
|
|
|
|
You can override runtime env vars with `-e`.
|
|
|
|
Example:
|
|
|
|
```bash
|
|
docker run --rm \
|
|
-p 20128:20128 \
|
|
-v "$HOME/.9router:/app/data" \
|
|
-e DATA_DIR=/app/data \
|
|
-e PORT=20128 \
|
|
-e HOSTNAME=0.0.0.0 \
|
|
-e DEBUG=true \
|
|
--name 9router \
|
|
9router
|
|
```
|
|
|
|
## Rebuild after code changes
|
|
|
|
```bash
|
|
docker build -t 9router .
|
|
```
|
|
|
|
Then restart the container.
|