Introduction

louislam/uptime-kuma is a self-hosted monitoring tool designed for ease of use, making it perfect for beginners. With features like HTTP(s), TCP, and JSON Query monitoring, Uptime Kuma provides comprehensive uptime checks for your services. Its reactive UI ensures that you can quickly identify issues, while support for over 90 notification services allows for timely alerts via Telegram, Discord, and more.

Using Docker to deploy Uptime Kuma is straightforward, thanks to its lightweight and efficient setup process. Simply run 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 Uptime Kuma on port 3001, accessible via http://0.0.0.0:3001. For enhanced security, you can limit exposure to localhost by changing the port mapping.

Uptime Kuma offers a rich feature set including multi-language support, 2FA, and advanced configuration options, making it a versatile choice for monitoring your applications and services efficiently.

Uses and Benefits

louislam/uptime-kuma in Docker offers several benefits for beginners:

• Ease of Setup: With a single command, you can deploy Uptime Kuma to your server using Docker. This makes it incredibly easy to get started without needing extensive technical knowledge.

• Self-Hosted Monitoring: Unlike paid monitoring services, self-hosting Uptime Kuma allows you to monitor your applications and services at no additional cost beyond the initial setup.

• Rich Feature Set: It supports various monitoring types including HTTP(s), TCP, JSON Query, Ping, DNS, Steam Game Server, Docker Containers, and more. The UI is modern and reactive, making it easy to manage multiple status pages.

• Notification Flexibility: Uptime Kuma can notify you via Telegram, Discord, Slack, Pushover, Email, and many other services. This ensures you are promptly informed about any issues with your services.

• Security and Control: By running Uptime Kuma in Docker, you have full control over how it is exposed to the internet or restricted to local access only. You can also use a reverse proxy for additional security layers.

• Frequent Updates: The Docker image is regularly updated, ensuring that you always have access to the latest features and bug fixes without needing manual updates.

Using Uptime Kuma in Docker allows beginners to set up robust monitoring with minimal effort, making it an excellent choice for personal or small-scale projects.

Docker Setup

To quickly set up louislam/uptime-kuma using Docker, follow these steps:

1. Run Uptime Kuma as a Docker container:

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

   This command starts the Uptime Kuma server and maps port 3001 of your host to the container. The data will be persisted in a local directory.

2. Access the Uptime Kuma Dashboard: Open your web browser and navigate to http://localhost:3001. You should see the login screen where you can set up an initial admin password.

3. Limit Exposure to localhost (Optional): If you only want to access Uptime Kuma from the same machine, 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

4. Common Issues:

   • File System Not Supported: Ensure you map to a local directory or volume, as NFS is not supported.
   • Port Conflicts: If port 3001 is already in use, choose another available port.

By following these steps, you should have Uptime Kuma up and running in no time. Enjoy monitoring your services with this powerful tool!

Security Essentials

To ensure louislam/uptime-kuma runs securely when deployed via Docker, follow these essential steps:

1. Limit Exposure: Expose Uptime Kuma only to trusted networks or localhost by using 127.0.0.1 as the host in your port mapping:

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

2. Use a Reverse Proxy: For better security and management, consider using a reverse proxy like Nginx or Traefik to handle external traffic.

3. Secure Configuration: Ensure that your Docker container’s configuration is secure. This includes setting up proper environment variables and configuring allowed origins for webhooks if applicable.

4. Regular Updates: Keep Uptime Kuma updated by following the official update instructions and staying informed about any security patches or new features.

5. Enable Two-Factor Authentication (2FA): Enhance account security by enabling 2FA in your Uptime Kuma settings, as supported by the application.

6. Secure Volumes: Use encrypted volumes for storing sensitive data such as configuration files and logs to prevent unauthorized access.

By following these steps, you can significantly enhance the security of your self-hosted monitoring tool deployed with Docker.