---
updatedAt: 2026-09-23T12:07:34.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/quick-deploy-apps/llms.txt
---

# Uptime Kuma

Deploy [Uptime Kuma](https://github.com/louislam/uptime-kuma), an open source monitoring tool used to track the availability and performance of services over HTTP/S, TCP, DNS, and other protocols.

## 1. Deploy Uptime Kuma

<div class="aligned">
   <img src="https://techdocs.akamai.com/terraform-images/img/clock.png" alt="" height="25" width="25" />
   <span class="span-header">&nbsp;Estimated deployment time:</span><span>&nbsp;5–10 minutes</span>
</div>

<div><p></p></div>

Follow the [deployment instructions](https://techdocs.akamai.com/quick-deploy-apps/docs/get-started) from the **Get started** section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the [Configuration options](#configuration-options) section.

### Base distribution and plan

* **Supported distribution:** Ubuntu 24.04 LTS
* **Recommended plans:** All plan types and sizes can be used.

### Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (`stackscript_data`) required for automated deployments.

**StackScript ID:** `970523`

<table>
    <thead>
        <tr>
            <th>UI field</th>
            <th>API/CLI key</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td colspan="3">Required options</td>
        </tr>
        <tr>
            <td><b>Limited sudo user</b></td>
            <td><code>user_name</code></td>
            <td>Your preferred username for the limited sudo user, entered without any capital letters, spaces, or special characters.<br /> When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the <code>sudo</code> group, which provides elevated permissions when running commands with the <code>sudo</code> prefix.
                <blockquote>
                    <b>Note:</b> For easier and more secure access with the sudo user, add an <a href="https://techdocs.akamai.com/cloud-computing/docs/manage-ssh-keys">account SSH key</a> for the Cloud Manager user during deployment and select that user as an <code>authorized_user</code>. Their SSH pubkey will be assigned to both the root and limited sudo users.
                </blockquote>
            </td>
        </tr>
        <tr>
            <td><b>Email address (for the Let's Encrypt SSL certificate)</b></td>
            <td><code>soa_email_address</code></td>
            <td>The email used to receive notifications about the renewal of the Let's Encrypt SSL certificate.</td>
        </tr>
        <tr>
            <td><b>Uptime Kuma username</b></td>
            <td><code>kuma_user_name</code></td>
            <td>The username to log in to your Uptime Kuma dashboard, entered without any capital letters, spaces, or special characters.</td>
        </tr>
        <tr>
            <td colspan="3">Advanced options</td>
        </tr>
        <tr>
            <td><b>Disable root access over SSH</b></td>
            <td><code>disable_root</code></td>
            <td><i>Applies to a limited sudo user.</i> To block the root user from logging in over SSH, select <i>Yes</i>. Defaults to <i>No</i>. <br />
                <blockquote>
                    <b>Note:</b> When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the <code>authorized_user</code>, you can still switch to the root user. To do that, log in as root via the <a href="https://techdocs.akamai.com/cloud-computing/docs/access-your-system-console-using-lish">Lish console</a> and run <code>cat /home/$USERNAME/.credentials</code> to view the generated password for the limited sudo user.
                </blockquote>
            </td>
        </tr>
        <tr>
            <td><b>Linode API token</b></td>
            <td><code>token_password</code></td>
            <td><i>Applies to a custom domain.</i> The Linode API token if you want to use Linode's <a href="https://techdocs.akamai.com/cloud-computing/docs/dns-manager">DNS Manager</a> to manage DNS records for your custom domain. Follow <a href="https://techdocs.akamai.com/cloud-computing/docs/manage-personal-access-tokens">Manage personal access tokens</a> to get your token on your account with <code>Read/Write</code> access to <code>Domains</code>.
                <ul>
                    <li>If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API.</li>
                    <li>If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><b>Subdomain</b></td>
            <td><code>subdomain</code></td>
            <td><i>Applies to a custom domain.</i> The subdomain you want to use, like <code>blog</code> for <code>blog.example.com</code>. Use it only if you specify a <i>Domain</i>.</td>
        </tr>
        <tr>
            <td><b>Domain</b></td>
            <td><code>domain</code></td>
            <td><i>Applies to a custom domain.</i> The domain name you want to use, like <code>example.com</code>. Use it only if you specify a <i>Linode API token</i>.</td>
        </tr>
        <tr>
            <td><b>Optional data exporter Add-ons</b></td>
            <td><code>add_ons</code></td>
            <td>An option to include add-ons for your deployment. Possible values are:
                <ul>
                    <li><i>none</i> (default)</li>
                    <li><i>node_exporter</i></li>
                    <li><i>mysqld_exporter</i></li>
                    <li><i>newrelic</i></li>
                </ul>
            </td>
        </tr>
    </tbody>
</table>

> **Notes:**
>
> * After the app deployment completes, the password for your limited sudo user is generated and stored in the `.credentials` file in the home directory, along with application-specific passwords. Log in to your instance as `root` through the Lish console or SSH, then run `cat /home/$USERNAME/.credentials` to view its contents.
> * You can automatically configure a **custom domain** (optional) during deployment. To do that:
>   1. First, configure your domain to use Linode’s name servers via your registrar. See [Configure your domain's authoritative name servers](https://techdocs.akamai.com/cloud-computing/docs/configure-your-domains-authoritative-name-servers) for details.
>   2. Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

### Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and [app-specific fields](#configuration-options) along with the standard Linode deployment configurations.

> **Note:** [Generate a personal access token](https://techdocs.akamai.com/linode-api/reference/get-started#personal-access-tokens) to authenticate your [API](https://techdocs.akamai.com/linode-api/reference/api), [CLI](https://techdocs.akamai.com/cloud-computing/docs/cli-1), or [Terraform](https://registry.terraform.io/providers/linode/linode/latest/docs) requests.

```bash API
curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-2",
        "image": "linode/ubuntu24.04",
        "label": "my-uptime-kuma-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 970523,
        "stackscript_data": {
            "user_name": "jsmith",
            "soa_email_address": "jsmith@example.com",
            "kuma_user_name": "jsmith-admin"
        }
    }'
```
```bash CLI
linode-cli linodes create \
    --region us-east \
    --type g6-standard-2 \
    --label my-uptime-kuma-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 970523 \
    --stackscript_data '{"user_name": "jsmith", "soa_email_address": "jsmith@example.com", "kuma_user_name": "jsmith-admin"}'
```
```json Terraform
resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-2"
    label          = "my-uptime-kuma-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 970523
    stackscript_data = {
        "user_name"         = "jsmith"
        "soa_email_address" = "jsmith@example.com"
        "kuma_user_name"    = "jsmith-admin"
    }
}
```

## 2. Access Uptime Kuma

To get started:

* Open a web browser and navigate to the domain you entered when creating the instance, `https://example.com`.
* If you didn’t create a domain, use your Linode instance’s default rDNS domain, for example, `192-0-2-1.ip.linodeusercontent.com`. To learn more about viewing the rDNS value, see [Manage IP addresses on a Linode](https://techdocs.akamai.com/cloud-computing/docs/managing-ip-addresses-on-a-compute-instance). Make sure to use the `https` prefix in the URL to access the website securely.

## Additional resources

For more information about the installed packages, see their official documentation.

* [Uptime Kuma Repository](https://github.com/louislam/uptime-kuma)

> 📘
>
> Note that we can't vouch for the accuracy or timeliness of externally hosted resources.

# Sibling pages

* [Elastic Stack (cluster)](https://techdocs.akamai.com/quick-deploy-apps/docs/elastic-stack-cluster.md)
* [Prometheus & Grafana](https://techdocs.akamai.com/quick-deploy-apps/docs/prometheus-grafana.md)
* [Zabbix](https://techdocs.akamai.com/quick-deploy-apps/docs/zabbix.md)