Deployment Overview of CapRover on Server¶

Prerequisites and Basic Requirements¶

To ensure a successful deployment, the following requirements must be met:

• Operating System: Debian-based Linux distribution.

• Privileges: Root or sudo access is required for package installation and Docker management.

• Network Ports: The following ports must be open in the firewall to allow traffic and management:

• 80/tcp (HTTP)

• 443/tcp (HTTPS)

• 3000/tcp (CapRover Management Panel)

FQDN of the final panel on the hostkey.in domain¶

The CapRover management interface is accessible via a specific subdomain template based on your unique Server ID.

Application installation process¶

The application is installed using a combination of system package management and Docker. The installation follows these steps:

1. System Update: The local package index is updated and existing packages are upgraded via the apt package manager.

2. Docker Engine Installation: The Docker runtime environment is installed on the host system to support containerized services.

3. CapRover Deployment: The CapRover application is deployed as a Docker container using the following command:

docker run -p 80:80 -p 443:443 -p 3000:3000 \
-e ACCEPTED_TERMS=true \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /captain:/captain \
caprover/caprover

Docker Containers and Their Deployment¶

The deployment consists of a single primary application container:

CapRover Container

• Image: caprover/caprover

• Ports:

• 80:80 (HTTP)

• 443:443 (HTTPS)

• 3000:3000 (Management UI)

• Volumes:

• /var/run/docker.sock:/var/run/docker.sock (Allows CapRover to manage other Docker containers on the host)

• /captain:/captain (Persistent storage for CapRover data)

• Environment Variables: ACCEPTED_TERMS=true

• Restart Policy: Managed by the Docker runtime.

Application Update Instructions¶

To update the CapRover application, you must pull the latest image and restart the container:

docker pull caprover/caprover
# Note: Manual intervention may be required to recreate the container with the new image 
# while preserving the /captain volume.

Location of configuration files and data¶

Data persistence for the CapRover application is maintained in the following directory on the host machine:

• CapRover Data Directory: /captain

Available ports for connection¶

The following ports are utilized by the application: