Skip to content

Latest commit

 

History

History
188 lines (121 loc) · 5.94 KB

🔧-How-to-Install.md

File metadata and controls

188 lines (121 loc) · 5.94 KB

🚀 Installer via CLI

[Ubuntu/CentOS] Interactive CLI installer, supports Docker or without Docker.

curl -o kuma_install.sh http://git.kuma.pet/install.sh && sudo bash kuma_install.sh

Advanced Installation

🐳 Docker

# Create a volume
docker volume create uptime-kuma

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

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

Change Port and Volume

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

⚠️ Please use a local volume only. Other types such as NFS are not supported.

Docker Tags Description

Tag(s) Description
latest, 1, 1.*latest stable - debian
debian, 1-debian, 1.*-debianlatest stable - debian
❌alpine, 1-alpine, 1.*-alpine(❌Deprecated due to DNS issues) latest stable - alpine
nightly*development build, unstable

💪🏻 Without Docker (Recommended for x86/x64 only)

It should supports Linux/Windows/MacOS.

Required Tools:

# Update your npm to the latest version
npm install npm -g

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 background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start server/server.js --name uptime-kuma

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

# Listen to different port or hostname
pm2 start server/server.js --name uptime-kuma -- --port=80 --host=0.0.0.0

Useful Commands

pm2 start uptime-kuma
pm2 stop uptime-kuma
pm2 restart uptime-kuma

# Run at startup
pm2 startup

Docker Compose Example

https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml

(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

Unofficial & Experimental

⚠ ⚠ ⚠ Warning: Generally, I only test Docker and Node.js. All installation methods here may be broken in the future release. I don't maintain them. Use at your own risk.

☸️ Kubernetes (Unofficial)

⚠ Warning: K8s deployment is provided by contributors. I have no experience with K8s and I can't fix error in the future.

See more here

☸️ 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

Open this add-on in your Home Assistant instance.

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

Termux (Unofficial/Experiment)

Do you have an old Android phone? You could install Uptime Kuma on it!

louislam/uptime-kuma#423

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/

SQLite S3 persistent storage with Litestream.io

Deploy on Railway

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