Skip to content

Commit a3961df

Browse files
authored
docs: correct restore, Compose, and Git deployment instructions (#257)
1 parent a438271 commit a3961df

9 files changed

Lines changed: 24 additions & 18 deletions

File tree

‎content/en/docs-next/deployments/git.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ slug: /deployments/git
1313
5. Add that URL as a **push webhook** in your Git provider.
1414
6. Push a commit. Check the CapRover deployment logs.
1515

16-
**Private repositories:** Use a read-only deploy key or limited service account.
16+
**Private repositories:** Use a read-only SSH deploy key or a limited service account. For SSH, generate a dedicated key with `ssh-keygen -t ed25519 -f ./deploykey -N ""`. Add `deploykey.pub` to the repository as a deploy key. Enter the SSH clone URL and the contents of `deploykey` in CapRover.
17+
18+
**GitHub webhook:** Choose `application/json` and the push event. Leave GitHub’s separate **Secret** field empty.
1719

1820
**Important:**
1921

‎content/en/docs-next/deployments/other/docker-compose.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ slug: /deployments/other/docker-compose
1212
- Other Compose fields are ignored.
1313
- In particular, do not assume `build`, custom `networks`, `secrets`, `configs`, `deploy`, `restart`, or `container_name` behaves like `docker compose`.
1414

15-
Named volumes are managed through the generated CapRover apps. A port mapping needs a `HOST:CONTAINER` form. For stacks that require unsupported Compose behavior, run Compose separately and explicitly connect the service to CapRover's external `captain-overlay-network` only when needed. Services managed outside CapRover remain outside its app lifecycle and backup behavior. See the [support matrix](docker-compose.md).
15+
Named volumes are managed through the generated CapRover apps. For stacks that require unsupported Compose behavior, run Compose separately and explicitly connect the service to CapRover's external `captain-overlay-network` only when needed. Services managed outside CapRover remain outside its app lifecycle and backup behavior. See the [support matrix](docker-compose.md).
1616

1717
<span id="source-reference-docker-compose"></span>
1818

@@ -23,9 +23,9 @@ CapRover's One-Click format accepts a **subset** of Docker Compose service setti
2323
| Service key | Supported input |
2424
| --- | --- |
2525
| `image`, `command`, `hostname`, `cap_add` | Image and selected container options. |
26-
| `volumes` | String mounts; check the target path and persistence. |
27-
| `ports` | String host:container pairs. |
28-
| `environment` | Mapping of variable names to string values. |
26+
| `volumes` | Short `source:target` strings or objects with `type` (`volume` or `bind`), `source`, and `target`. Short-form `:ro` is ignored and long-form `read_only: true` is rejected. |
27+
| `ports` | `HOST:CONTAINER`, `HOST:CONTAINER/tcp`, `HOST:CONTAINER/udp` strings or objects with `published`, `target`, optional `protocol` (`tcp` or `udp`), and optional `mode` (`ingress` or `host`). Without a protocol, CapRover publishes both TCP and UDP. |
28+
| `environment` | A map of scalar values or a list of `KEY=value` strings. Bare keys and null values are omitted. |
2929
| `depends_on` | Service-name array used to order One-Click deployment. |
3030
| `caproverExtra` | CapRover extension for `dockerfileLines`, `containerHttpPort`, `notExposeAsWebApp`, and `websocketSupport`. |
3131

‎content/en/docs-next/server/backup/restore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ slug: /server/backup/restore
3232
caprover/caprover
3333
```
3434

35-
Need Docker? Follow [Getting Started](../../get-started.md) first.
35+
Need Docker? Complete only [Install Docker](../../installation/manual.md#2-install-docker) before running the command above.
3636

3737
3. Watch the installer logs. For clusters, follow [Multi-Node Restore](restore.md) when prompted for node mapping.
3838
4. Point the original wildcard DNS to the new server when ready. For a clone running alongside the original, choose a different root domain.

‎content/es-ES/docs-next/deployments/git.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ slug: /deployments/git
1313
5. Configura esa URL como **push webhook** en tu proveedor Git.
1414
6. Haz push de un commit y consulta los logs del despliegue en CapRover.
1515

16-
**Repositorios privados:** utiliza una deploy key de solo lectura o una cuenta de servicio con permisos limitados.
16+
**Repositorios privados:** Usa una deploy key SSH de solo lectura o una cuenta de servicio con permisos limitados. Para SSH, genera una clave con `ssh-keygen -t ed25519 -f ./deploykey -N ""`. Añade `deploykey.pub` al repositorio como deploy key. Introduce en CapRover la URL de clonación SSH y el contenido de `deploykey`.
17+
18+
**Webhook de GitHub:** Selecciona `application/json` y el evento push. Deja vacío el campo **Secret** de GitHub.
1719

1820
**Importante:**
1921

‎content/es-ES/docs-next/deployments/other/docker-compose.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ slug: /deployments/other/docker-compose
1212
- Se ignoran los demás campos de Compose.
1313
- En particular, no asumas que `build`, las `networks` personalizadas, `secrets`, `configs`, `deploy`, `restart` o `container_name` funcionan igual que con `docker compose`.
1414

15-
Los volúmenes con nombre se administran mediante las aplicaciones de CapRover generadas. El mapeo de puertos debe utilizar el formato `HOST:CONTAINER`. Si necesitas funciones de Compose que CapRover no admite, ejecuta Compose por separado y conecta el servicio a la red externa `captain-overlay-network` de CapRover únicamente cuando sea necesario. Los servicios administrados fuera de CapRover también quedan fuera de su ciclo de vida y del sistema de backups de las aplicaciones. Consulta la [matriz de compatibilidad](docker-compose.md).
15+
Los volúmenes con nombre se administran mediante las aplicaciones de CapRover generadas. Si necesitas funciones de Compose que CapRover no admite, ejecuta Compose por separado y conecta el servicio a la red externa `captain-overlay-network` de CapRover únicamente cuando sea necesario. Los servicios administrados fuera de CapRover también quedan fuera de su ciclo de vida y del sistema de backups de las aplicaciones. Consulta la [matriz de compatibilidad](docker-compose.md).
1616

1717
<span id="source-reference-docker-compose"></span>
1818

@@ -23,9 +23,9 @@ El formato One-Click de CapRover admite un **subconjunto** de los ajustes de ser
2323
| Clave del servicio | Configuración admitida |
2424
| --- | --- |
2525
| `image`, `command`, `hostname`, `cap_add` | Imagen y determinadas opciones del contenedor. |
26-
| `volumes` | Montajes expresados como cadenas; comprueba la ruta de destino y la persistencia. |
27-
| `ports` | Pares host:contenedor expresados como cadenas. |
28-
| `environment` | Mapeo de nombres de variables a valores de texto. |
26+
| `volumes` | Cadenas `source:target` u objetos con `type` (`volume` o `bind`), `source` y `target`. El sufijo `:ro` se ignora y `read_only: true` en formato largo se rechaza. |
27+
| `ports` | Cadenas `HOST:CONTAINER`, `HOST:CONTAINER/tcp`, `HOST:CONTAINER/udp` u objetos con `published`, `target`, `protocol` opcional (`tcp` o `udp`) y `mode` opcional (`ingress` o `host`). Si omites el protocolo, CapRover publica tanto TCP como UDP. |
28+
| `environment` | Un mapa de valores escalares o una lista de cadenas `KEY=value`. Las claves sin valor y los valores nulos se omiten. |
2929
| `depends_on` | Lista de nombres de servicios utilizada para ordenar el despliegue One-Click. |
3030
| `caproverExtra` | Extensión de CapRover para `dockerfileLines`, `containerHttpPort`, `notExposeAsWebApp` y `websocketSupport`. |
3131

‎content/es-ES/docs-next/server/backup/restore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ slug: /server/backup/restore
3232
caprover/caprover
3333
```
3434

35-
Si necesitas instalar Docker, sigue primero la guía de [Primeros pasos](../../get-started.md).
35+
Si necesitas Docker, completa solo el paso [Instalar Docker](../../installation/manual.md#2-instalar-docker) antes de ejecutar el comando anterior.
3636

3737
3. Comprueba los logs del instalador. Para clústeres, sigue la [restauración multinodo](restore.md) cuando aparezca la solicitud de mapeo de nodos.
3838
4. Cuando esté preparado el cambio, apunta el wildcard DNS original al nuevo servidor. Si vas a ejecutar una copia en paralelo con el original, utiliza otro dominio raíz.

‎content/zh-CN/docs-next/deployments/git.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ slug: /deployments/git
1313
5. 在 Git 托管服务中将该 URL 配置为 **push webhook**。
1414
6. 推送一次 commit,并查看 CapRover 部署日志。
1515

16-
**私有仓库:**建议使用只读 deploy key,或权限受限的 service account。
16+
**私有仓库:**使用只读 SSH deploy key 或权限受限的服务账号。如果使用 SSH,请运行 `ssh-keygen -t ed25519 -f ./deploykey -N ""` 生成专用密钥。将 `deploykey.pub` 添加到仓库的 deploy keys,并在 CapRover 中填写 SSH 克隆 URL 和 `deploykey` 的内容。
17+
18+
**GitHub webhook:**选择 `application/json` 和 push 事件,将 GitHub 单独的 **Secret** 字段留空。
1719

1820
**注意:**
1921

‎content/zh-CN/docs-next/deployments/other/docker-compose.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ slug: /deployments/other/docker-compose
1212
- 其他 Compose 字段会被忽略。
1313
- 尤其需要注意:`build`、自定义 `networks`、`secrets`、`configs`、`deploy`、`restart`、`container_name` 等字段的行为不能直接按 `docker compose` 推断。
1414

15-
命名卷由生成的 CapRover 应用管理。端口映射必须使用 `HOST:CONTAINER` 格式。如果需要 CapRover 暂不支持的 Compose 功能,可以单独运行 Compose,并仅在必要时将相关服务显式连接到 CapRover 的外部网络 `captain-overlay-network`。CapRover 不负责管理这些外部服务的应用生命周期或备份。详情见[支持矩阵](docker-compose.md)。
15+
命名卷由生成的 CapRover 应用管理。如果需要 CapRover 暂不支持的 Compose 功能,可以单独运行 Compose,并仅在必要时将相关服务显式连接到 CapRover 的外部网络 `captain-overlay-network`。CapRover 不负责管理这些外部服务的应用生命周期或备份。详情见[支持矩阵](docker-compose.md)。
1616

1717
<span id="source-reference-docker-compose"></span>
1818

@@ -23,9 +23,9 @@ CapRover 的 One-Click 模板支持 Docker Compose 服务配置的一个**子集
2323
| 服务配置项 | 支持的内容 |
2424
| --- | --- |
2525
| `image`、`command`、`hostname`、`cap_add` | 镜像及部分容器参数。 |
26-
| `volumes` | 字符串形式的挂载配置;需核对容器内路径及数据持久化行为。 |
27-
| `ports` | host:container 形式的端口映射字符串。 |
28-
| `environment` | 环境变量名称到字符串值的映射。 |
26+
| `volumes` | 支持 `source:target` 字符串或包含 `type`(`volume` 或 `bind`)、`source` 和 `target` 的对象。短格式的 `:ro` 后缀会被忽略,长格式的 `read_only: true` 会被拒绝。 |
27+
| `ports` | 支持 `HOST:CONTAINER`, `HOST:CONTAINER/tcp`, `HOST:CONTAINER/udp` 字符串或包含 `published`、`target`、可选 `protocol`(`tcp` 或 `udp`)及可选 `mode`(`ingress` 或 `host`)的对象。省略协议时,CapRover 会同时发布 TCP 和 UDP 端口。 |
28+
| `environment` | 支持标量值映射或 `KEY=value` 字符串列表。没有值的键和 null 值会被忽略。 |
2929
| `depends_on` | 用于确定 One-Click 部署顺序的服务名数组。 |
3030
| `caproverExtra` | CapRover 扩展配置,包括 `dockerfileLines`、`containerHttpPort`、`notExposeAsWebApp` 和 `websocketSupport`。 |
3131

‎content/zh-CN/docs-next/server/backup/restore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ slug: /server/backup/restore
3232
caprover/caprover
3333
```
3434

35-
还没有安装 Docker?先参阅[快速入门](../../get-started.md)。
35+
如果尚未安装 Docker,请仅完成[安装 Docker](../../installation/manual.md#2-安装-docker)一节,再运行上面的命令。
3636

3737
3. 检查安装日志。恢复多节点集群时,根据提示执行[多节点恢复](restore.md),完成节点映射。
3838
4. 准备切换时,将原有 wildcard DNS 指向新服务器。如果新旧服务器要同时运行,请给副本设置不同的根域名。

0 commit comments

Comments
 (0)