Skip to content

Commit

Permalink
πŸ”„ Update "Installing CapRover on Hetzner Cloud" (hetzneronline#958)
Browse files Browse the repository at this point in the history
Improve verbage and clarity.
  • Loading branch information
K3das authored and ati-ozgur committed Dec 30, 2024
1 parent d3f1aa1 commit 4803678
Showing 1 changed file with 14 additions and 20 deletions.
34 changes: 14 additions & 20 deletions tutorials/install-caprover/01.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,43 +20,35 @@ cta: "cloud"
## Introduction

CapRover is a sleek new way to easily deploy your own apps or an app from their large selection to a Cloud Server. CapRover has a nice web panel to manage your installation, view metrics, and launch new apps. I wouldn't recommend this if you have multiple people who need to connect to one server, due to there being only one login.
CapRover is a sleek new way to easily deploy your own apps, or prebuilt one-click apps to a Cloud Server. CapRover provides a nice web panel to manage your installation, view metrics, and launch new apps. That being said, CapRover only provides one user account, so it will not work for installations with multiple users.

**Prerequisites**

- A fresh Hetzner Cloud server running Ubuntu 20.04 or Ubuntu 22.04 that you have shell access to
- Any domain

> CapRover's recommended stack is Ubuntu 20.04 and Docker 19.03
> CapRover's recommended stack is Ubuntu 20.04 and Docker 19.03, but has been tested for Ubuntu 22.04
## Step 1 - Install Docker

Since CapRover runs on Docker, we'll need to install it.

First - Update your server and install the required packages by running these commands: (Make sure you're logged into the `root` user, as this tutorial assumes you are)
First, update your server and install the required packages by running these commands: (make sure you're logged into the `root` user, as this tutorial assumes you are)

```bash
apt-get update
apt-get upgrade -y
apt-get install curl apparmor -y
```

Now we can proceed to installing Docker by following "Option 2 - Installing `docker-ce`" in step 1 of "[this tutorial](https://community.hetzner.com/tutorials/howto-docker-install#option-2---installing-docker-ce).

<blockquote>
<details>

<summary>Click here for a quick installation of Docker with the convenience script</summary>
Now we can proceed to installing Docker,

```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sh ./get-docker.sh --dry-run # Check which steps this script will run
sh ./get-docker.sh --dry-run # Verify the script's changes before performing them
sh ./get-docker.sh
```

</details>
</blockquote>

This will install the latest version of Docker. You could now move on to running CapRover.

## Step 2 - Connect your domain
Expand All @@ -72,11 +64,11 @@ Go to your domain's DNS management panel and create a new `A` record pointing to

To verify that you correctly configured your domain, visit <https://mxtoolbox.com/DNSLookup.aspx>, input `foobar.<your_domain.com>` (`foobar.<subdomain_name>.<your_domain.com>` if you used a subdomain) and check if the domain resolves to the IP address you configured in your DNS settings. **DNS propagation can take a few minutes, so if it doesn't work, just wait some more.** It should take under 30 minutes for DNS to fully propagate.

> **Note:** It is critical that a wild card `*` is assigned to the `HOST` in the `A` record. This allows CapRover to create unique addresses for your application(s) running on the server.
> **Note:** It is critical that a wildcard (`*`) is assigned to the host in the `A` record. This allows CapRover to create unique addresses for each application on your server.
## Step 3 - Run CapRover

CapRover simply runs on top of Docker, making it very modular, and can be installed with one command:
CapRover simply runs inside of Docker, making it very modular, and can be installed with one command:

```bash
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
Expand All @@ -86,7 +78,9 @@ Do not change the port mappings, as CapRover will not be able to run on differen

## Step 4 - Setup CapRover

Once the previous command has completed, and you waited 60 seconds for CapRover to fully start, you can attempt to login to the dashboard. You can find it at `http://captain.<your_domain.com>:3000/` (`http://captain.<subdomain_name>.<your_domain.com>:3000/` if you used a subdomain). **Note:** you should only use this URL for the initial setup.
Once the previous command has completed, and CapRover was installed, you could proceed to the dashboard and setup your CapRover instance.

The dashboard could be found at `http://captain.<your_domain.com>:3000/` (`http://captain.<subdomain_name>.<your_domain.com>:3000/` if you used a subdomain), and **this endpoint will only be valid for the for the initial setup**. Note that it could sometimes take up to a minute for CapRover to start and that URL to be accessible.

![CapRover Login Screen](images/caprover_login_screen.png)

Expand All @@ -96,13 +90,13 @@ When you login you'll be greeted by the dashboard:

![CapRover Initial Dashboard](images/caprover_initial_dashboard.png)

Enter your domain (or subdomain) and press "Update Domain". You'll be redirected to `http://captain.<your_domain.com>` - this is where you can now access your dashboard. Press "Enable HTTPS". Enter your email address in the popup (this is required for the Let's Encrypt certificate). Once it's done you can press "Force HTTPS" to make sure every request is redirected to `https://`
Enter your domain (or subdomain) and press "Update Domain". You'll be redirected to `http://captain.<your_domain.com>` - this is where you can now access your dashboard. Press "Enable HTTPS". Enter your email address in the popup (this will be shared with Let's Encrypt, and is required for generating SSL certificates). Once it's done you can press "Force HTTPS" to make sure every request is redirected to `https://`.

Lastly, **don't forget to set a new password by going to "Settings" and filling out the "Change Password" form!**
Lastly, **do not forget to set a new password by going to "Settings" and filling out the "Change Password" form!**

## Conclusion

You know have a working CapRover instance πŸŽ‰! You can use their amazing docs to learn how to deploy existing One-Click Apps, or your own:
You now have a working CapRover instance πŸŽ‰! You can use their docs to learn how to deploy their prebuilt One-Click Apps, or your own:

**Enabling NetData Monitoring:** <https://caprover.com/docs/resource-monitoring.html>

Expand Down Expand Up @@ -137,7 +131,7 @@ By making a contribution to this project, I certify that:
indefinitely and may be redistributed consistent with this project
or the license(s) involved.
Signed-off-by: Michael Pigal <kedas@uncrftd.xyz>
Signed-off-by: Mia Pigal <kedas@yarn.network>
Signed-off-by: Justin Trugman <[email protected]>
-->

0 comments on commit 4803678

Please sign in to comment.