Uptime Kuma

https://uptimekuma.org/
Admin
Uptime Kuma is an open-source, self-hosted monitoring tool that tracks uptime for websites, servers,...
Tokens:11,148
Snippets:120
Trust Score:7.4
Update:8 months ago
Show doc for...
Tokens:
Raw
### Setup and Run Uptime Kuma with PM2

Source: https://uptimekuma.org/install-uptime-kuma-linux

Navigates to the Uptime Kuma directory, runs the setup script, installs PM2 globally, and then starts Uptime Kuma using PM2. PM2 is used to keep the application running and manage its process, including automatic restarts on server reboot.

```bash
cd /home/uptime-kuma
npm run setup
npm install pm2 -g
pm2 install pm2-logrotate
pm2 start server/server.js --name uptime-kuma
pm2 startup
```

--------------------------------

### Start Uptime Kuma with Node.js

Source: https://uptimekuma.org/install-uptime-kuma-windows

This command starts the Uptime Kuma application after all dependencies have been installed. It will then be accessible via http://localhost:3001 in your web browser.

```bash
npm start
```

--------------------------------

### Install Node.js Dependencies for Uptime Kuma

Source: https://uptimekuma.org/install-uptime-kuma-windows

After cloning the repository, navigate to the Uptime Kuma directory and run this command to install all necessary Node.js dependencies. This requires Node.js and npm to be installed.

```bash
cd uptime-kuma
npm install
```

--------------------------------

### Start Uptime Kuma with Docker Compose

Source: https://uptimekuma.org/install-uptime-kuma-docker

Starts the Uptime Kuma container in detached mode using Docker Compose. This command reads the docker-compose.yml file and brings up the defined services.

```bash
docker-compose up -d
```

--------------------------------

### Install Git and Clone Uptime Kuma Repository

Source: https://uptimekuma.org/install-uptime-kuma-linux

Installs the Git version control system and clones the latest Uptime Kuma repository from GitHub. This step is necessary to obtain the Uptime Kuma source code.

```bash
sudo apt update && sudo apt install -y git
git clone https://github.com/louislam/uptime-kuma.git
```

--------------------------------

### Install Docker and Docker Compose (Linux)

Source: https://uptimekuma.org/install-uptime-kuma-docker

Installs Docker and Docker Compose on a Linux system, typically Ubuntu. These are prerequisites for running Uptime Kuma in a containerized environment.

```bash
curl -fsSL https://get.docker.com | sh
sudo apt install docker-compose -y
```

--------------------------------

### Update System and Install Node.js on Ubuntu

Source: https://uptimekuma.org/install-uptime-kuma-linux

Updates the package list and upgrades installed packages, then installs Node.js from the NodeSource LTS repository. This ensures the system is up-to-date and has the necessary Node.js version for Uptime Kuma.

```bash
sudo apt update
sudo apt upgrade -y
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - && sudo apt install -y nodejs
```

--------------------------------

### Create Uptime Kuma Directory and Navigate (Linux)

Source: https://uptimekuma.org/install-uptime-kuma-docker

Creates a dedicated directory for Uptime Kuma in the user's home directory and changes the current directory to it. This is a preparatory step before creating the Docker Compose configuration file.

```bash
mkdir -p ~/uptime-kuma && cd ~/uptime-kuma
```

--------------------------------

### Clone Uptime Kuma Repository with Git

Source: https://uptimekuma.org/install-uptime-kuma-windows

This command clones the official Uptime Kuma repository from GitHub to your local machine. Ensure Git is installed and accessible in your command prompt or PowerShell.

```bash
git clone https://github.com/louislam/uptime-kuma.git
```

--------------------------------

### Check Running Docker Containers

Source: https://uptimekuma.org/install-uptime-kuma-windows

This command lists all currently running Docker containers, allowing you to verify if the Uptime Kuma container is active. Ensure Docker Desktop is installed and running.

```bash
docker ps
```

--------------------------------

### Pull Uptime Kuma Docker Image

Source: https://uptimekuma.org/install-uptime-kuma-windows

This command downloads the official Uptime Kuma Docker image from Docker Hub. Ensure Docker Desktop is installed and running.

```bash
docker pull louislam/uptime-kuma:1
```

--------------------------------

### Configure Nginx as a Reverse Proxy for Uptime Kuma

Source: https://uptimekuma.org/install-uptime-kuma-linux

Installs Nginx and creates a configuration file to set up a reverse proxy. This allows Uptime Kuma to be accessed via a domain name and handles WebSocket connections for real-time updates. The configuration includes basic security and performance enhancements.

```bash
apt install nginx -y
vi /etc/nginx/conf.d/uptime-kuma.conf
```

```nginx
server {
    listen 80;
    server_name uptime-kuma.yourdomainname.com;

    location / {
        proxy_pass         http://localhost:3001;
        proxy_http_version 1.1;
        proxy_set_header   Upgrade $http_upgrade;
        proxy_set_header   Connection "upgrade";
        proxy_set_header   Host $host;
        proxy_set_header   X-Real-IP $remote_addr;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto $scheme;

        # Added WebSocket support
        proxy_set_header   Sec-WebSocket-Key $http_sec_websocket_key;
        proxy_set_header   Sec-WebSocket-Version $http_sec_websocket_version;
        proxy_set_header   Sec-WebSocket-Extensions $http_sec_websocket_extensions;

        # Improve performance of this reverse proxy
        proxy_buffering    off;
    }

    # Redirect HTTP to HTTPS if needed for encryption
    # Uncomment the following lines if you have SSL enabled
    # return 301 https://$host$request_uri;
}

```

```bash
systemctl restart nginx
```

--------------------------------

### Run Uptime Kuma Docker Container

Source: https://uptimekuma.org/install-uptime-kuma-windows

This command runs the Uptime Kuma Docker container, mapping the host's port 3001 to the container's port 3001 and mounting a local directory for data persistence. Ensure Docker Desktop is installed and running.

```bash
docker run -d --restart=always -p 3001:3001 -v C:\YourUserName\UptimeKuma\logs:/app/data louislam/uptime-kuma:1
```

--------------------------------

### Deploy Uptime Kuma with Docker Compose

Source: https://uptimekuma.org/download

This YAML file defines the service for deploying Uptime Kuma using Docker Compose. It specifies the image, restart policy, port mapping, and volume for data persistence.

```yaml
version: "3"

services:
  uptime-kuma:
    image: louislam/uptime-kuma:1
    container_name: uptime-kuma
    restart: always
    ports:
      - 3001:3001
    volumes:
      - uptime-kuma:/app/data

volumes:
  uptime-kuma:
```

--------------------------------

### Manage Uptime Kuma Docker Container Commands

Source: https://uptimekuma.org/install-uptime-kuma-docker

Provides essential Docker commands for managing the Uptime Kuma container. This includes viewing logs, restarting the container (both via Docker Compose and direct Docker command), stopping and removing the container, stopping all services defined in Docker Compose, and removing Docker volumes.

```bash
docker logs -f uptime-kuma
```

```bash
docker-compose restart
```

```bash
docker restart uptime-kuma
```

```bash
docker stop uptime-kuma && docker rm uptime-kuma
```

```bash
docker-compose down
```

```bash
docker volume rm uptime-kuma
```

--------------------------------

### Run Uptime Kuma with Docker

Source: https://uptimekuma.org/download

This command allows you to run Uptime Kuma as a Docker container. It ensures the container restarts automatically, maps port 3001, and persists data using a Docker volume named 'uptime-kuma'.

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

--------------------------------

### Uptime Kuma Docker Compose Configuration

Source: https://uptimekuma.org/install-uptime-kuma-docker

Defines the service configuration for Uptime Kuma using Docker Compose. This YAML file specifies the image to use, container name, restart policy, port mapping, persistent storage, timezone, file permissions, network settings, health checks, and logging options.

```yaml
version: "3.8"

services:
  uptime-kuma:
    image: louislam/uptime-kuma:latest
    container_name: uptime-kuma
    restart: always
    ports:
      - "3001:3001"  # This maps the container port "3001" to the host port "3001"
    volumes:
      - /path/to/data:/app/data  # Configuring persistent storage
    environment:
      - TZ=UTC  # Set the timezone (change to your preferred local timezone so monitoring times are the same)
      - UMASK=0022  # Set your file permissions manually
    networks:
      - kuma_network  # add your own custom network config
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3001"]
      interval: 30s
      retries: 3
      start_period: 10s
      timeout: 5s
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"

networks:
  kuma_network:
    driver: bridge
```
Tokens:
Raw