You can use this CLI tool to deploy your apps. Before anything, install the CLI tool using npm:
npm install -g caprover
The very first thing you need to do is to setup your Captain server. You can either do this by visiting
HTTP://IP_ADDRESS_OF_SERVER:3000 in your browser, or the recommended way which is the command line tool. Simple run
Follow the steps as instructed, enter IP address of server. Enter the root domain to be used with this Captain instance. If you don't know what Captain root domain is, please visit www.caprover.com for documentation. This is a very crucial step. After that, you'll be asked to enter your email address. This should be a valid email address as it will be used in your SSL certificate. After HTTPS is enabled, you'll be asked to change your password. And... Your are done! Go to Deploy section below to read more about app deployment.
If you've done the "Server Setup" process through the command line. You can skip "Login" step because "server setup" automatically logs you in as the last step of setup.
The very first thing you need to do is to login to your Captain server. It is recommended that at this point you have already set up your HTTPS. Login over insecure, plain HTTP is not recommended.
To log in to server, simply run the following line and answer the questions.
If operation finishes successfully, you will be prompted with a success message.
NOTE: You can be logged in to several Captain servers at the same time. This is particularly useful if you have separate staging and production servers.
In order to deploy your application, you first need to create a captain-definition file and place it in the root of your project folder. In case of a nodejs application, this would sit in the same folder as your package.json.
A simple captain-definition file for a nodejs application is:
See Captain Definition File for more details on the Captain Definition file.
After making sure that this file exists, run the following command and answer the questions given:
You will then see your application being uploaded and, after that, your application getting built. Note that the build process can take several minutes, so please be patient!
To use the previously-entered values for the current directory, without being asked again, use the
caprover deploy -d
Alternatively, you can use the stateless mode and supply the CapRover server information inline:
caprover deploy -h https://captain.root.domain.com -p password -b branchName -a app-name
This can be useful if you want to integrate CI/CD pipeline.
List logged in servers
To see a list of servers you are currently logged in to, run the following line:
Run the following command: