# CapRover

Generated on 2 Dec 2024 from [the CapRover catalog page](https://marketplace.digitalocean.com/apps/caprover)

CapRover is an easy to use PaaS with a dashboard. It helps you to take your app from http://localhost:3000 to [https://awesomeapp.com](https://awesomeapp.com) in seconds. It makes HTTPS enabling as simple as clicking on a button. It makes database (MongoDB, MySQL, Postgres and etc) deployment available with a single click. No more manual nginx configurations, or building everything from scratch. See [https://caprover.com/docs/get-started.html#caprover-setup](https://caprover.com/docs/get-started.html#caprover-setup) for setup documentation. If you are using this One-Click droplet, you should skip step 1 in the guide.

## Software Included

| Package | Version | License |
|---|---|---|
| Docker CE | [19.03](https://docs.docker.com/release-notes/docker-ce/) | [Apache 2](https://github.com/docker/docker/blob/master/LICENSE) |
| CapRover | [1.13.3](https://github.com/caprover/caprover/releases) | [Apache 2](https://github.com/caprover/caprover/blob/master/LICENSE) |

## Creating an App using the Control Panel

Click the **Deploy to DigitalOcean** button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/droplets/new?image=caprover-18-04)

## Creating an App using the API

In addition to creating a Droplet from the CapRover 1-Click App using the control panel, you can also use the [DigitalOcean API](https://docs.digitalocean.com/reference/api). As an example, to create a 4GB CapRover Droplet in the SFO2 region, you can use the following `curl` command. You need to either save your [API access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/index.html.md) to an environment variable or substitute it in the command below.

```shell
curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image":"caprover-18-04"}' \
        "https://api.digitalocean.com/v2/droplets"
```

## Getting Started After Deploying CapRover

For best user experience, make sure to read the [Getting Started section of the docs](https://caprover.com/docs/get-started.html#caprover-setup) After installation, simply visit http://IP-ADDRESS:3000 to see your dashboard! You can SSH to your instance to view your instance info including password.

The easiest way to finish the setup process is to [follow the guide using CapRover CLI](https://caprover.com/docs/get-started.html#step-3-install-caprover-cli). You will be presented with a guided setup flow. You can also see the documentation from the DOCS link in the web dashboard top menu.