Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ services:
- "8020:8020"
volumes:
# Mount the configuration and data directory to persist state
- /var/lib/openviking/ov.conf:/app/ov.conf
- /var/lib/openviking/data:/app/data
- ~/.openviking/ov.conf:/app/ov.conf
- ~/.openviking/data:/app/data
healthcheck:
test: ["CMD-SHELL", "curl -fsS http://127.0.0.1:1933/health || exit 1"]
interval: 30s
Expand Down
26 changes: 17 additions & 9 deletions docs/en/guides/03-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,33 +194,41 @@ curl http://localhost:1933/api/v1/fs/ls?uri=viking:// \
### Docker

OpenViking provides pre-built Docker images published to GitHub Container Registry:
> ~/.openviking/ov.conf need to be configured correctly first.

```bash
# Note: ov.conf needs to set storage.workspace to /app/data for data persistence
docker run -d \
--name openviking \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:latest
```

By default, the Docker image starts:
- OpenViking HTTP server on `1933`
- OpenViking Console on `8020`
- OpenViking HTTP service on port `1933`
- OpenViking Console on port `8020`
- `vikingbot` gateway

If you want to disable `vikingbot` for a specific container run, use either of the following:
Upgrade the container:
```bash
docker stop openviking
docker pull ghcr.io/volcengine/openviking:latest
docker rm -f openviking
# Then re-run docker run ...
```

If you want to disable `vikingbot` for a specific container run, you can use either of the following:

```bash
docker run -d \
--name openviking \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:latest \
--without-bot
Expand All @@ -233,19 +241,19 @@ docker run -d \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:latest
```

You can also use Docker Compose with the `docker-compose.yml` provided in the project root:
You can also use Docker Compose, which provides a `docker-compose.yml` in the project root:

```bash
docker compose up -d
```

After startup, you can access:
- API server: `http://localhost:1933`
- API service: `http://localhost:1933`
- Console UI: `http://localhost:8020`

To build the image yourself: `docker build -t openviking:latest .`
Expand Down
21 changes: 15 additions & 6 deletions docs/zh/guides/03-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,28 +187,37 @@ curl http://localhost:1933/api/v1/fs/ls?uri=viking:// \
-H "X-API-Key: your-key"
```

## 云上部署
## 云原生部署

### Docker

OpenViking 提供预构建的 Docker 镜像,发布在 GitHub Container Registry:

```bash
# 注意 ov.conf 需要指定 storage.workspace 为 /app/data 以确保数据持久化
docker run -d \
--name openviking \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:main
ghcr.io/volcengine/openviking:latest
```

Docker 镜像默认会同时启动:
- OpenViking HTTP 服务,端口 `1933`
- OpenViking Console,端口 `8020`
- `vikingbot` gateway

升级容器的方式
```bash
docker stop openviking
docker pull ghcr.io/volcengine/openviking:latest
docker rm -f openviking
# 然后重新 docker run ...
```

如果你希望本次容器启动时关闭 `vikingbot`,可以使用下面任一方式:

```bash
Expand All @@ -217,9 +226,9 @@ docker run -d \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:main \
ghcr.io/volcengine/openviking:latest \
--without-bot
```

Expand All @@ -230,7 +239,7 @@ docker run -d \
-p 1933:1933 \
-p 8020:8020 \
-v ~/.openviking/ov.conf:/app/ov.conf \
-v /var/lib/openviking/data:/app/data \
-v ~/.openviking/data:/app/data \
--restart unless-stopped \
ghcr.io/volcengine/openviking:latest
```
Expand Down
Loading