Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
docs: suggest the volces registry mirror when ghcr.io is hard to reach (#5099)
t0saki8941acc864ca
diff --git a/deploy/helm/README.md b/deploy/helm/README.mdindex d90a93648..835f27242 100644--- a/deploy/helm/README.md+++ b/deploy/helm/README.md@@ -33,6 +33,9 @@ helm upgrade --install openviking ./deploy/helm/openviking --set image.tag=v0.3.helm upgrade --install openviking ./deploy/helm/openviking --set image.tag=```+We recommend the `ghcr.io` image. If `ghcr.io` is hard to reach, add+`--set image.repository=openviking-cn-beijing.cr.volces.com/volcengine/openviking`.+### Install with Custom ValuesCreate a `my-values.yaml` file:diff --git a/deploy/helm/openviking/values.yaml b/deploy/helm/openviking/values.yamlindex 7e4b157c4..95787f554 100644--- a/deploy/helm/openviking/values.yaml+++ b/deploy/helm/openviking/values.yaml@@ -3,6 +3,8 @@replicaCount: 1image:+ # Prefer ghcr.io. If it is hard to reach, use the mirror:+ # repository: openviking-cn-beijing.cr.volces.com/volcengine/openvikingrepository: ghcr.io/volcengine/openviking# Use Always for the default moving tag. Pin a version and set IfNotPresent if# you want Kubernetes to reuse cached immutable images.diff --git a/docker-compose.yml b/docker-compose.ymlindex 80cc1cf16..63a72470d 100644--- a/docker-compose.yml+++ b/docker-compose.yml@@ -17,6 +17,8 @@ version: "3.8"services:openviking:+ # Prefer ghcr.io. If it is hard to reach, use the mirror:+ # image: openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestimage: ghcr.io/volcengine/openviking:latestcontainer_name: openviking# Direct access (optional — caddy:1934 is the recommended single entrydiff --git a/docs/en/getting-started/02-quickstart.md b/docs/en/getting-started/02-quickstart.mdindex 76152b9d3..5c07b9d34 100644--- a/docs/en/getting-started/02-quickstart.md+++ b/docs/en/getting-started/02-quickstart.md@@ -56,6 +56,7 @@ If you prefer to run OpenViking as a standalone service, Docker is recommended.```yamlservices:openviking:+ # Prefer ghcr.io. If it is hard to reach, use openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestimage: ghcr.io/volcengine/openviking:latestcontainer_name: openvikingports:diff --git a/docs/en/getting-started/04-setup-for-agent.md b/docs/en/getting-started/04-setup-for-agent.mdindex 76f4c04cb..85357fa4a 100644--- a/docs/en/getting-started/04-setup-for-agent.md+++ b/docs/en/getting-started/04-setup-for-agent.md@@ -228,6 +228,7 @@ docker run --rm \```Notes:+- Prefer the `ghcr.io` image; if pulling fails, use `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest` instead- The default config path inside the container is `/app/.openviking/ov.conf`- Inside the container, `HOME=/app`- Prefer mounting host `~/.openviking` to container `/app/.openviking` so config, CLI config, and workspace data persist@@ -236,7 +237,7 @@ Notes:##### Option 2: Use `docker-compose.yml`If the user prefers compose, the repo already includes an example with:-- image: `ghcr.io/volcengine/openviking:latest`+- image: `ghcr.io/volcengine/openviking:latest` (if pulling fails, use `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest`)- ports: `1933:1933`- volume: `~/.openviking:/app/.openviking`diff --git a/docs/en/guides/03-deployment.md b/docs/en/guides/03-deployment.mdindex 87d782af4..3fde1fefb 100644--- a/docs/en/guides/03-deployment.md+++ b/docs/en/guides/03-deployment.md@@ -195,6 +195,8 @@ docker run -d \ghcr.io/volcengine/openviking:latest```+> We recommend the `ghcr.io` image. If `ghcr.io` is hard to reach, use `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest` instead. The same applies to the commands below.+By default, the Docker image starts:- OpenViking HTTP service on port `1933` (bound to `0.0.0.0`), also serving the Web Studio UI at `/studio`- `vikingbot` gatewaydiff --git a/docs/en/guides/06-mcp-integration.md b/docs/en/guides/06-mcp-integration.mdindex fc366d53e..2b55fd037 100644--- a/docs/en/guides/06-mcp-integration.md+++ b/docs/en/guides/06-mcp-integration.md@@ -197,6 +197,7 @@ When the variable is unset and inference is used, the tool response automaticall```yamlservices:openviking:+ # Prefer ghcr.io. If it is hard to reach, use openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestimage: ghcr.io/volcengine/openviking:latestenvironment:OPENVIKING_PUBLIC_BASE_URL: "https://ov.your-domain.com"diff --git a/docs/zh/getting-started/02-quickstart.md b/docs/zh/getting-started/02-quickstart.mdindex 35bcd0de4..0c6100970 100644--- a/docs/zh/getting-started/02-quickstart.md+++ b/docs/zh/getting-started/02-quickstart.md@@ -56,6 +56,7 @@ pipx upgrade openviking```yamlservices:openviking:+ # 推荐优先使用 ghcr.io;如果访问有问题,可改用 openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestimage: ghcr.io/volcengine/openviking:latestcontainer_name: openvikingports:diff --git a/docs/zh/getting-started/04-setup-for-agent.md b/docs/zh/getting-started/04-setup-for-agent.mdindex 1d919eb5f..2a5a7101b 100644--- a/docs/zh/getting-started/04-setup-for-agent.md+++ b/docs/zh/getting-started/04-setup-for-agent.md@@ -228,6 +228,7 @@ docker run --rm \```说明:+- 镜像推荐优先使用 `ghcr.io`;如果拉取失败,改用 `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest`- 容器内默认配置路径是 `/app/.openviking/ov.conf`- 容器内 `HOME=/app`- 建议把宿主机 `~/.openviking` 挂载到容器 `/app/.openviking` 持久化配置、CLI 配置和 workspace 数据@@ -236,7 +237,7 @@ docker run --rm \##### 方案 2:使用 `docker-compose.yml`如果用户希望使用 compose,仓库里已有示例:-- 镜像:`ghcr.io/volcengine/openviking:latest`+- 镜像:`ghcr.io/volcengine/openviking:latest`(拉取失败时改用 `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest`)- 端口:`1933:1933`- volume:`~/.openviking:/app/.openviking`diff --git a/docs/zh/guides/03-deployment.md b/docs/zh/guides/03-deployment.mdindex 093e7d6b0..9dff06169 100644--- a/docs/zh/guides/03-deployment.md+++ b/docs/zh/guides/03-deployment.md@@ -193,6 +193,8 @@ docker run -d \ghcr.io/volcengine/openviking:latest```+> 推荐优先使用 `ghcr.io` 镜像;如果访问有问题,可改用 `openviking-cn-beijing.cr.volces.com/volcengine/openviking:latest`。本节后续命令同理。+Docker 镜像默认会同时启动:- OpenViking HTTP 服务,端口 `1933`(绑定 `0.0.0.0`),同时在 `/studio` 提供 Web Studio 前端- `vikingbot` gatewaydiff --git a/docs/zh/guides/06-mcp-integration.md b/docs/zh/guides/06-mcp-integration.mdindex 8f03a1c3f..03c9eb2ed 100644--- a/docs/zh/guides/06-mcp-integration.md+++ b/docs/zh/guides/06-mcp-integration.md@@ -187,6 +187,7 @@ claude mcp add --transport http openviking \```yamlservices:openviking:+ # 推荐优先使用 ghcr.io;如果访问有问题,可改用 openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestimage: ghcr.io/volcengine/openviking:latestenvironment:OPENVIKING_PUBLIC_BASE_URL: "https://ov.your-domain.com"diff --git a/examples/cloud/GUIDE.md b/examples/cloud/GUIDE.mdindex d23ad0abf..6b866255a 100644--- a/examples/cloud/GUIDE.md+++ b/examples/cloud/GUIDE.md@@ -251,6 +251,7 @@ journalctl -u openviking -f # 查看实时日志# -v 挂载宿主机文件到容器内,格式为 宿主机路径:容器内路径# ov.conf 挂载是必填的,data 目录用于持久化数据(容器删除后不丢失)# --restart 进程崩溃或机器重启后自动拉起+# 镜像推荐优先使用 ghcr.io;如果访问有问题,可改用 openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestdocker run -d \--name openviking \diff --git a/web-studio/README.md b/web-studio/README.mdindex b79216844..aa3335661 100644--- a/web-studio/README.md+++ b/web-studio/README.md@@ -342,6 +342,7 @@ Do not set `VITE_OV_BASE_URL` to `https://ov.example.com/web-studio`. `/web-studThe official OpenViking image can be used as the API server dependency:```bash+# Prefer ghcr.io. If it is hard to reach, use openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestdocker run -d \--name openviking \-p 1933:1933 \diff --git a/web-studio/README_CN.md b/web-studio/README_CN.mdindex 0bd8fe1ae..9eecf9b8b 100644--- a/web-studio/README_CN.md+++ b/web-studio/README_CN.md@@ -341,6 +341,7 @@ server {官方 OpenViking 镜像可以作为 API server 依赖:```bash+# 推荐优先使用 ghcr.io;如果访问有问题,可改用 openviking-cn-beijing.cr.volces.com/volcengine/openviking:latestdocker run -d \--name openviking \-p 1933:1933 \