Skip to content
Next Hat
All Statefiles
Nanocl v0.17Statefile 0.1.0

Uptime Kuma

Deploy an Uptime Kuma instance with a proxy rule.

Description

Uptime Kuma is a self-hosted monitoring tool that allows you to monitor the uptime of your services. This cargo deploys an Uptime Kuma instance and creates a proxy rule to access it via a specified domain. The instance data is stored on the host for persistence.

Synopsis

SH
nanocl state apply -s nr.next-hat.com/v0.17/uptime-kuma -- [--help] ARGUMENTS
nanocl state rm -s nr.next-hat.com/v0.17/uptime-kuma -- [--help] ARGUMENTS

Arguments

ArgumentTypeDescriptionDefault
--name
Required
StringName of the cargo and the data folder.—
--domain
Required
StringDomain name to access Uptime Kuma.—
--namespace
Optional
StringNanocl namespace where to deploy the cargo.global
--network
Required
StringNanocl network to use for the proxy rule.—

Render locally

Render this Statefile and save the result to Statefile.yml for review before applying it.

Pass any required Statefile arguments after --.

SH
nanocl state render -s nr.next-hat.com/v0.17/uptime-kuma -o Statefile.yml

Content

YAML
ApiVersion: v0.17
Args:
  - Name: name
    Kind: String
    Required: true
    Description: Name of the cargo and the data folder.
  - Name: domain
    Kind: String
    Required: true
    Description: Domain name to access Uptime Kuma.
  - Name: namespace
    Kind: String
    Default: global
    Description: Nanocl namespace where to deploy the cargo.
  - Name: network
    Kind: String
    Required: true
    Description: Nanocl network to use for the proxy rule.
Namespace: ${{ Args.namespace }}
Cargoes:
  - Name: ${{ Args.name }}
    Container:
      Image: louislam/uptime-kuma:1
      HostConfig:
        Binds:
          - /opt/containers/${{ Args.name }}:/app/data
Resources:
  - Name: http.${{ Args.domain }}
    Kind: ncproxy.io/rule
    Data:
      Rules:
        - Domain: ${{ Args.domain }}
          Network: ${{ Args.network }}
          Locations:
            - Path: /
              Target:
                Key: uptime-kuma.${{ Args.namespace }}.c
                Port: 3001