Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

docs: fix docker deployment (#1332)

MaojiaShengf0c75842d0bc
diff --git a/docker-compose.yml b/docker-compose.yml
index af2edb5eb..4dbc293fd 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -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
diff --git a/docs/en/guides/03-deployment.md b/docs/en/guides/03-deployment.md
index e7cbba92b..427c964be 100644
--- a/docs/en/guides/03-deployment.md
+++ b/docs/en/guides/03-deployment.md
@@ -194,25 +194,33 @@ 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 \
@@ -220,7 +228,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 \
--without-bot
@@ -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 .`
diff --git a/docs/zh/guides/03-deployment.md b/docs/zh/guides/03-deployment.md
index bcadf8b53..6514a40ca 100644
--- a/docs/zh/guides/03-deployment.md
+++ b/docs/zh/guides/03-deployment.md
@@ -187,21 +187,22 @@ 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 镜像默认会同时启动:
@@ -209,6 +210,14 @@ Docker 镜像默认会同时启动:
- OpenViking Console,端口 `8020`
- `vikingbot` gateway
+升级容器的方式
+```bash
+docker stop openviking
+docker pull ghcr.io/volcengine/openviking:latest
+docker rm -f openviking
+# 然后重新 docker run ...
+```
+
如果你希望本次容器启动时关闭 `vikingbot`,可以使用下面任一方式:
```bash
@@ -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
```
@@ -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
```