🔧-How-to-Install.md

🐳 Docker

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

Uptime Kuma is now running on http://localhost:3001

Warning

Filesystem support for POSIX file locks is required to avoid SQLite database corruption. Be aware of possible file locking problems such as those commonly encountered with NFS. Please map the /app/data-folder to a local directory or volume.

Browse to http://localhost:3001 after started.

Changing Port or Volume

docker run -d --restart=unless-stopped -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1

Docker Tags Description

Tag(s)	Description
1	Latest stable (👍Recommended Tag)
latest, 1, 1.*	Latest stable - debian
debian, 1-debian, 1.*-debian	Latest stable - debian
❌alpine, 1-alpine, 1.*-alpine	(❌Deprecated due to DNS issues) Latest stable - alpine
nightly*	Development build, unstable

🐳 Docker Compose

Example docker-compose template: https://github.com/louislam/uptime-kuma/blob/1.23.X/docker/docker-compose.yml

docker compose up -d

💪🏻 Non-Docker

Requirements:

• Platform
  • ✅ Major Linux distros such as Debian, Ubuntu, CentOS, Fedora and ArchLinux etc.
  • ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
  • ❌ Replit / Heroku
• Node.js 14 / 16 / 18 / 20.4
• npm >= 9
• Git
• pm2 - For running Uptime Kuma in the background

git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup

# Option 1. Try it
node server/server.js

# (Recommended) Option 2. Run in the background using PM2
# Install PM2 if you don't have it:
npm install pm2 -g && pm2 install pm2-logrotate

# Start Server
pm2 start server/server.js --name uptime-kuma

Uptime Kuma is now running on http://localhost:3001

More useful PM2 Commands

# If you want to see the current console output
pm2 monit

# If you want to add it to startup
pm2 save && pm2 startup

(Optional) One more step for Reverse Proxy

This is optional for someone who want to use a reverse proxy.

Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more headers "Upgrade" and "Connection" in order to reverse proxy WebSocket.

Please read wiki for more info: https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy

Videos

• Learn Uptime Kuma in 5 Minutes by DEVOPS UNLOCKED Install with the docker run command
• Meet Uptime Kuma, a Fancy Open Source Uptime Monitor by Techno Tim Install with docker-compose
• Monitor Status with Uptime Kuma - Let's install Uptime Kuma with Docker by Geeked Install with Portainer

Unofficial & Experimental

Warning

The following installation methods are provided by the community. They are not tested officially and may be broken in the future release. Use at your own risk.

☸️ OpenShift 4 and Kubernetes Helm 3 Chart (Unofficial)

Note

This Chart relies on a repackaged OCI Container Image, which lets uptime-kuma run as non-root user. The entire repackage process is automated via GitHub Actions and renovate-bot keeps everything up to date. (feel free to audit it yourself)

The Containerfile used to rebundle uptime-kuma: rootless Containerfile

https://github.com/k3rnelpan1c-dev/uptime-kuma-helm

Ansible (Unofficial)

https://github.com/louislam/uptime-kuma/tree/ansible-unofficial/ansible

Home Assistant add-on (Unofficial)

https://github.com/hassio-addons/addon-uptime-kuma

Also check out the corresponding custom integration: https://github.com/meichthys/uptime_kuma (WIP).

Install on Synology NAS (Unofficial)

Unofficial tutorial by Marius Bogdan Lixandru:

https://mariushosting.com/how-to-install-uptime-kuma-on-your-synology-nas/

One-Click Hosting on PikaPods

Run with one click on PikaPods.com. Free for about 3 months with welcome credit. PikaPods have produced a getting started video if you like consuming information in this form.

Install on Azure Container Instance with TLS endpoint

Unofficial tutorial by Stefan: https://haci.io/posts/uptime-kuma-azure-container-instance/

Install on Azure AppService Container

Unofficial tutorial by Leandro: https://www.leandroscardua.com/blog/deploy-uptime-kuma-on-azure/

Install on Azure AppService with persistent storage

Unofficial bicep deployment script by Yannick Zwijsen: https://github.com/yzwijsen/deploy-uptime-kuma-azure

SQLite S3 persistent storage with Litestream.io

Run uptime-kuma with S3 persistent sqlite database: https://github.com/fluential/litestream-uptime-kuma/

One-Click Deployment on Alibaba Cloud

Follow the deployment guide to deploy Uptime Kuma on Alibaba Cloud. Both domestic site and internationl sites are supported.

• Deployment Guide in English
• 中文部署文档

uptime-kuma-helper

@mkgeeky has created uptime-kuma-helper a bash script to install and update easy

Install on Zeabur

Run with one click on Zeabur.

https://docs.zeabur.com/marketplace/uptime-kuma

Install on Dome

To try the self-hosted uptime-kuma, 🚀 one-click deploy with Dome with a free trial.

Deploy to Fly.io

You can host uptime-kuma with a single command at Fly.io and run on its included Hobby Plan usage.

Deploy to FlashPanel

You can host uptime-kuma with FlashPanel (a server management control panel) for free on one server with up to 10 websites.