# Uptime Kuma •

Ensure that all of your services are online through a unified dashboard interface.

# Overview

![Screen Shot 2025-03-10 at 18.57.59.png](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-57-59.png)

[Uptime Kuma](https://uptime.kuma.pet/) is a unified dashboard interface for monitoring your services.

<p class="callout success">Tryout an [Uptime Kuma demo](https://demo.kuma.pet/start-demo).</p>

- Monitor your Docker containers directly or configure with many other protocols like HTTPS, TCP and Ping.
- Receive notifications when a service goes offline and needs attention.
- Build status pages to keep your community up-to-date about service availability.

# Media

## Screenshots

<p class="callout info">Uptime Kuma v1.23.16</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-10 at 18.57.59.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-10-at-18-57-59.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-57-59.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-10 at 18.49.48.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-10-at-18-49-48.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-49-48.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-10 at 18.51.50.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-10-at-18-51-50.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-51-50.png)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-10 at 18.54.43.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-10-at-18-54-43.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-54-43.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-10 at 18.52.34.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-10-at-18-52-34.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-10-at-18-52-34.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">  
</td></tr></tbody></table>

# Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

# Preparation

There are some things we need to do in preparation to install this service.

## Volumes

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

This is where the service will store its own application data and ensures we can quickly update the service image.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-docker-socket-this-p"><summary>Docker Socket</summary>

This provides the service with access to the [Docker socket](https://docs.docker.com/reference/cli/dockerd/#examples), allowing it to see and control other Docker containers.</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
services:
  uptime-kuma:
    image: louislam/uptime-kuma:1
    volumes:
      # Persistent Data
      - /srv/uptime-kuma:/app/data

      # Docker Socket
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 3001:3001
    restart: unless-stopped
```

# Updating

<p class="callout success">Re-Deploy the Stack</p>

This service has been optimized for running in Docker.

This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

# User Manual

# Development

<p class="callout info">This software is released under the [MIT license](https://opensource.org/license/mit). </p>

You can learn more about how to contribute to Uptime Kuma through their [documentation](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md).

The developer also accepts [sponsorships](https://opencollective.com/uptime-kuma).

# Resources

## Official

- [Official Documentation](https://github.com/louislam/uptime-kuma/wiki)
- [Official GitHub Repository](https://github.com/louislam/uptime-kuma)
- [Official Website](https://uptime.kuma.pet/)
- [Installation Guide](https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install)
- [General Troubleshooting](https://github.com/louislam/uptime-kuma/wiki/Troubleshooting)