Skip to content

docs: recommend pre-built image deployments for production #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
githubsaturn merged 2 commits into from
Sep 13, 2026
Merged

docs: recommend pre-built image deployments for production #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfebc3a
docs: recommend image-based deployments
githubsaturn Sep 13, 2026
71adc62
docs: keep simple quick start first
githubsaturn Sep 13, 2026
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: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Deploy checked-out source, a Docker image, or a prepared tar file to CapRover us

This packages the files committed in the checked-out `HEAD` and submits the deployment to CapRover. Generate an app token from the app's **Deployment** tab in CapRover.

> **Important:** This is the simplest deployment setup, but CapRover builds the Docker image on your server. Builds can consume significant CPU, memory, disk I/O, and storage during deployment. For production workloads, we strongly recommend building the image in GitHub Actions and deploying the pre-built image instead, as shown below.

App tokens and deployment data are sent to the configured server. Use HTTPS unless the server is reached through a trusted private network.

## Deploy a Docker image

Build and push the image with the standard Docker actions, then ask CapRover to deploy it:
For production deployments, this is the recommended approach. Build and push the image with the standard Docker actions, then ask CapRover to deploy it. The image build runs on GitHub Actions instead of consuming resources on your CapRover server.

```yaml
- uses: actions/checkout@v6
Expand Down