Introduction

Uptime Kuma is a self-hosted monitoring tool designed for easy use. With its feature-rich interface, users can monitor uptime for various services such as HTTP(s), TCP, keyword queries, and more. The tool also supports notifications via multiple services like Telegram, Discord, and Slack.

Key Features

• Monitoring uptime for various services (HTTP(s), TCP, etc.)
• Support for custom notification services
• Multi-language support
• Multiple status pages with customizable mapping
• Ping chart and certificate info display
• Proxy and 2FA support

Installation

Uptime Kuma is available in Docker and can be installed using the following command:

docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

This will start the Uptime Kuma service on port 3001. For non-Docker installations, refer to the official documentation for more information.

Try Uptime Kuma today and take advantage of its powerful features for monitoring your services!

Uses and Benefits

Monitoring and Notifications

Uptime Kuma is an easy-to-use self-hosted monitoring tool that provides 20-second interval monitoring for various services, including HTTP(s), TCP, HTTP(s) Keyword, JSON Query, Ping, DNS Record, Push, Steam Game Server, Docker Containers, and more. It supports notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and over 90 other notification services.

Features

• Multi-language support
• Multiple status pages with customizable maps
• Certificate info display
• Proxy support for monitoring behind a proxy server
• Two-factor authentication (2FA) for added security

Benefits

• Self-hosted, allowing you to have full control and customization options
• Easy-to-use interface for monitoring and managing your services
• Flexible notification system with support for multiple platforms
• Scalable and reliable solution for monitoring your infrastructure

Docker Setup

Quick Start Guide for louislam/uptime-kuma

Step 1: Run Uptime Kuma using Docker

docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

This command starts a new container from the louislam/uptime-kuma image, maps port 3001 on your host to port 3001 in the container, and mounts a volume named uptime-kuma at /app/data inside the container.

Step 2: Access Uptime Kuma

Uptime Kuma is now running on http://0.0.0.0:3001. You can access it by visiting this URL in your web browser.

Tips for Common Issues

• Warning: File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.
• Limiting Exposure: If you want to limit exposure to localhost without exposing port 3001, you can expose the port like this:

docker run -d --restart=always -p 127.0.0.1:3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

Non-Docker Requirements

If you prefer to install Uptime Kuma outside of Docker, please refer to the project’s documentation for instructions on how to set it up on your local machine.

Update and Upgrade Instructions

Please consult the project’s wiki for information on updating and upgrading Uptime Kuma. Security Essentials

When running louislam/uptime-kuma in Docker, it’s essential to follow these security best practices:

1. Use a secure Docker image

Always use the official Docker image from the GitHub repository: louislam/uptime-kuma:1. Avoid using images from untrusted sources.

2. Limit exposure to localhost

To prevent exposing the container’s port to other users or hosts, run the container with the -p flag, mapping the port to 127.0.0.1: docker run -d --restart=always -p 127.0.0.1:3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

3. Use a secure volume

When mounting a volume, use a local directory or a secure network share (e.g., NFS with encryption). Avoid using File Systems like NFS without proper encryption.

4. Monitor container logs

Regularly monitor the container’s logs to detect any potential security issues or errors: docker logs -f uptime-kuma

5. Keep Docker and Uptime Kuma up-to-date

Periodically update your Docker installation and the louislam/uptime-kuma image to ensure you have the latest security patches and features.

By following these guidelines, you’ll be able to run louislam/uptime-kuma in a secure and efficient manner within Docker.