Skip to content

Commit a59b0c8

Browse files
authored
docs: simplify common CapRover workflows (#254)
* docs: simplify common CapRover workflows * docs: clarify update, image upgrade, and rollback steps
1 parent 6607869 commit a59b0c8

22 files changed

Lines changed: 89 additions & 123 deletions

File tree

‎content/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ Optimize documentation for fast scanning:
113113
- Put prerequisites in brief bullet lists. Name the requirement, then the value.
114114
- Use numbered steps for procedures and bullets for options, requirements, and caveats.
115115
- Put commands, configuration examples, and tables near the action they support.
116+
- Lead with the shortest supported workflow. Keep optional checks and advanced recovery in their own sections.
117+
- Put warnings next to the action they apply to and state the specific risk.
116118
- Explain unusual ports, flags, and risks inline. Skip explanations of self-evident steps.
117119
- Prefer imperative sentences: **Set the root domain** instead of **You can set the root domain**.
118120
- Keep bullets focused on one idea. Split dense bullets into steps, tables, or smaller bullets.

‎content/en/docs-next/data-persistence/deploy-databases.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ title: Deploy Databases
44
slug: /data-persistence/deploy-databases
55
---
66

7-
- A database on CapRover is an app that needs storage, credentials, and a network path for its clients.
87
- The [One-Click Apps](../one-click-apps/index.md) catalog can create a supported database service, or you can deploy a database image yourself.
98

109
1. Choose the database and image version. Create its app with **Has Persistent Data** enabled and leave **Do not expose as web app** selected; databases generally do not serve HTTP through NGINX.
1110
2. Configure the database's required username, password, and database name through its app settings or One-Click installer. Use unique credentials and keep them out of source control.
1211
3. Mount a named volume or bind path at the database image's actual data directory. Place the app on the node holding that storage.
1312
4. Deploy and read the service logs until the database reports it is ready. Restart or redeploy once to confirm its data remains present.
14-
5. Connect another app by the database service name and internal container port. Publish a host port only if an external client needs it; follow the [external connection guide](deploy-databases.md) for its firewall and security steps.
13+
5. Connect another app by the database service name and internal container port. Publish a host port only if an external client needs it; follow the [external connection guide](#connect-to-databases-externally) for its firewall and security steps.
1514
6. Schedule database-aware backups and test a restore. The CapRover configuration backup does not contain the database records.
1615

1716
Check the chosen database image's storage path and initialization variables; they differ between PostgreSQL, MySQL, Redis, and other services.
@@ -40,10 +39,7 @@ Check the chosen database image's storage path and initialization variables; the
4039

4140
### Prepare the database
4241

43-
- Deploy the database as a persistent, non-web app.
44-
- Configure its data volume or bind mount, credentials, and database name.
45-
- Verify it is ready in its service logs and that a CapRover app can reach it internally by app name and container port.
46-
- Back up the database data separately from the CapRover configuration.
42+
Deploy the database as described above and check its logs for readiness before opening access.
4743

4844
### Publish a restricted port
4945

‎content/en/docs-next/deployments/builds-logs.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ slug: /deployments/builds-logs
1919

2020
## Versions and Rollback
2121

22-
- CapRover records image versions for an app.
23-
- From the app's deployment history, choose a previously deployed version to roll back its image.
24-
- Check the result and app health before resuming traffic.
22+
In the app’s **Deployment** tab, open **Version History**, click **Revert to this version** on the row for the image you want, and confirm.
2523

2624
- Rollback does **not** restore earlier environment variables, domains, volume contents, or database schema.
2725
- If the newer version changed persistent data, confirm the older image remains compatible before rolling back.

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,7 @@ slug: /deployments
1212
- To deploy an archive, package the project with its `captain-definition` file at the expected path and upload the tar file.
1313
- The dashboard also accepts a Captain Definition pasted into its text input when no source files are needed.
1414

15-
For example, paste this definition to deploy an existing public image:
16-
17-
```json
18-
{"schemaVersion":2,"imageName":"nginx:stable-alpine"}
19-
```
20-
21-
- Start the deployment, watch the build or pull status, then verify the app's container HTTP port and its default domain.
22-
- For a private image, configure registry credentials first.
23-
- See [Deploy a Docker Image](index.md).
15+
[Deploy an existing Docker image](#deploy-a-docker-image)
2416

2517
<span id="source-deployments-docker-image"></span>
2618

‎content/en/docs-next/get-started.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,12 @@ On the server:
2222
```bash
2323
sudo apt update && sudo apt install -y curl
2424
curl -fsSL https://get.caprover.com -o caprover-install.sh
25-
sudo bash caprover-install.sh --check
2625
sudo bash caprover-install.sh
2726
```
2827

29-
- [Installer source and options](https://github.com/caprover/caprover/tree/master/scripts/user/installer). Review the downloaded script before running it as root.
30-
- `--check`: read-only checks for OS, RAM, disk, Docker, Swarm, ports, and firewall conflicts. Resolve blocking issues before installing.
31-
- The installer installs Docker Engine when absent and preserves existing Docker workloads.
32-
- On an active UFW firewall, it allows TCP 80/443/3000. It leaves inactive UFW and hosting-provider firewalls unchanged.
33-
- After installation, it checks external port reachability and reports warnings. DNS, dashboard configuration, and HTTPS remain manual.
28+
[Installer source and options](https://github.com/caprover/caprover/tree/master/scripts/user/installer)
29+
30+
For a read-only check, run `sudo bash caprover-install.sh --check`.
3431

3532
**Other methods:** [Manual Setup](installation/manual.md) (Docker and CapRover commands), [DigitalOcean Marketplace](installation/index.md), or [Advanced Installation](installation/advanced/index.md) for private networks, existing Swarms, and custom ports.
3633

‎content/en/docs-next/one-click-apps/index.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,9 @@ One-Click templates create ordinary CapRover apps. Each template may provision m
3939

4040
## Upgrades
4141

42-
- Read the upstream application's migration instructions and back up its data before upgrading.
43-
- A template can use a custom image or initialization scripts. Replacing it with a plain upstream image may lose essential configuration.
44-
- Image changes do not perform every database or application-schema migration.
45-
- Preserve and verify existing volumes when recreating or migrating stateful apps.
42+
For apps that support an image-only upgrade, follow the upstream instructions for any required backups or migrations. If the template uses a custom image or initialization scripts, check how the upgrade will preserve that configuration.
43+
44+
In the app’s **Deployment** tab, open **Method 6: Deploy via ImageName**, enter the new image and tag, and deploy.
4645

4746
<span id="source-one-click-apps-custom-repositories"></span>
4847

‎content/en/docs-next/server/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /server
88

99
## Server Settings
1010

11-
Use the dashboard's **Settings** area to manage the root domain, account password, updates, and CapRover backups. Back up the server before changing its domain or upgrading.
11+
Open **Settings** to manage the root domain and account password. Open **Maintenance** to [update CapRover](upgrade.md) or [download a configuration backup](backup/index.md).
1212

1313
### Root domain
1414

‎content/en/docs-next/server/upgrade.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,25 @@ title: Upgrade CapRover
44
slug: /server/upgrade
55
---
66

7-
Before upgrading, [download a CapRover backup](backup/index.md) and separately back up application data and volumes. Check the release notes and confirm your Docker host has enough free disk space.
7+
In the dashboard, open **Maintenance → CapRover Updates** and click **Install Update** when a stable update is available. On older dashboards, look under **Settings**.
88

9-
- In the dashboard, open **Settings** and inspect the current version, available version, and change log.
10-
- Use the dashboard update action when it reports that an update is available.
11-
- CapRover pulls the selected image and updates the `captain-captain` Docker service.
12-
- Allow the service time to restart, then verify the dashboard, deployed apps, registry, and HTTPS.
9+
Run these commands on the Swarm manager.
1310

14-
- If the update fails, check `docker service ps captain-captain --no-trunc` and `docker service logs captain-captain --tail 100` on the manager node.
15-
- Preserve a backup and the previous image tag before attempting a rollback; see [Diagnostics](../troubleshooting/diagnostics.md).
11+
<span id="testing-an-edge-image"></span>
1612

17-
## Testing an edge image
13+
## Switch to edge
1814

19-
- For an advanced, temporary test of a fix available only in the edge image, record the exact current image from `docker service inspect captain-captain`, back up CapRover and app data, and then update the service image to a **specific tested edge tag or digest** using `docker service update captain-captain --image IMAGE`.
20-
- This bypasses the dashboard's normal version flow.
21-
- Edge images may not support downgrading to the currently released version; wait for a compatible release or restore a tested backup before switching back.
22-
- Verify dashboard, apps, and service logs after any manual update.
15+
```bash
16+
docker pull caprover/caprover-edge:latest
17+
docker service update captain-captain --image caprover/caprover-edge:latest
18+
```
19+
20+
## Switch back to stable
21+
22+
```bash
23+
docker service update captain-captain --image caprover/caprover:latest
24+
```
25+
26+
Switching back may fail if the edge release introduced changes incompatible with the stable release.
27+
28+
If the update fails, see [Diagnostics](../troubleshooting/diagnostics.md).

‎content/es-ES/docs-next/data-persistence/deploy-databases.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ title: Desplegar bases de datos
44
slug: /data-persistence/deploy-databases
55
---
66

7-
- En CapRover, una base de datos es una aplicación que necesita almacenamiento persistente, credenciales y conectividad de red para sus clientes.
87
- Puedes instalar una base de datos mediante el catálogo de [One-Click Apps](../one-click-apps/index.md) o desplegar directamente una imagen compatible.
98

109
1. Elige el motor y la versión de la imagen. Crea la aplicación con **Has Persistent Data** activado y **Do not expose as web app** seleccionado; normalmente las bases de datos no sirven HTTP a través de NGINX.
1110
2. Configura el usuario, la contraseña y el nombre de la base de datos mediante los ajustes de la aplicación o el instalador One-Click. Utiliza credenciales únicas y mantenlas fuera del repositorio.
1211
3. Monta un volumen con nombre o un bind mount en el directorio de datos real de la imagen. Asigna la aplicación al nodo que contiene ese almacenamiento.
1312
4. Despliega la base de datos y consulta los logs hasta que esté lista para aceptar conexiones. Reinicia o vuelve a desplegar una vez para comprobar que los datos persisten.
14-
5. Desde otra aplicación, conecta usando el nombre del servicio y el puerto interno del contenedor. Publica un puerto del host solo si necesitas clientes externos; sigue los pasos de firewall y seguridad de la [guía de conexión externa](deploy-databases.md).
13+
5. Desde otra aplicación, conecta usando el nombre del servicio y el puerto interno del contenedor. Publica un puerto del host solo si necesitas clientes externos; sigue los pasos de firewall y seguridad de la [guía de conexión externa](#conectar-a-bases-de-datos-desde-fuera-de-caprover).
1514
6. Programa backups específicos para ese motor de base de datos y prueba una restauración. El backup de configuración de CapRover no incluye los registros de la base de datos.
1615

1716
Consulta la documentación de la imagen elegida para verificar rutas de datos y variables de inicialización; pueden variar entre PostgreSQL, MySQL, Redis y otros servicios.
@@ -40,10 +39,7 @@ Consulta la documentación de la imagen elegida para verificar rutas de datos y
4039

4140
### Preparar la base de datos
4241

43-
- Despliega la base de datos como una aplicación persistente sin exposición web.
44-
- Configura el volumen o bind mount, las credenciales y el nombre de la base de datos.
45-
- Comprueba en los logs que está lista y verifica que otra aplicación de CapRover pueda conectarse mediante el nombre del servicio y el puerto interno.
46-
- Haz una copia de seguridad de los datos de la base de datos por separado de la configuración de CapRover.
42+
Despliega la base de datos como se describe arriba y comprueba en los logs que esté lista antes de habilitar el acceso.
4743

4844
### Publicar un puerto restringido
4945

‎content/es-ES/docs-next/deployments/builds-logs.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ slug: /deployments/builds-logs
1919

2020
## Versiones y rollback
2121

22-
- CapRover guarda el historial de versiones de imágenes de cada aplicación.
23-
- Desde el historial de despliegues, elige una versión anterior para hacer rollback de la imagen.
24-
- Comprueba el resultado y la salud de la aplicación antes de reanudar el tráfico.
22+
En **Deployment**, abre **Version History**, haz clic en **Revert to this version** en la fila de la imagen que quieres restaurar y confirma.
2523

2624
- Un rollback **no** restaura variables de entorno anteriores, dominios, datos de volúmenes ni el esquema de la base de datos.
2725
- Si la nueva versión modificó datos persistentes, comprueba la compatibilidad de la imagen anterior antes de hacer rollback.

0 commit comments

Comments
 (0)