From a9d15a8714ea9d792e0cfca3b3a7c317cc8a1beb Mon Sep 17 00:00:00 2001
From: Louis Lam <louislam@users.noreply.github.com>
Date: Wed, 11 Aug 2021 22:03:49 +0800
Subject: [PATCH] Created Installation (markdown)

---
 Installation.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Installation.md

diff --git a/Installation.md b/Installation.md
new file mode 100644
index 0000000..b50db74
--- /dev/null
+++ b/Installation.md
@@ -0,0 +1,62 @@
+## Manual Installation
+
+### Docker
+
+```bash
+# 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
+
+```bash
+docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1
+```
+
+### Without Docker (x86/x64 only)
+
+Required Tools: Node.js >= 14, git and pm2.
+
+(**Not recommanded for ARM CPU users.** Since there is no prebuilt for node-sqlite3, it is hard to get it running)
+
+```bash
+git clone https://github.com/louislam/uptime-kuma.git
+cd uptime-kuma
+npm run setup
+
+# Option 1. Try it
+npm run start-server
+
+# (Recommended)
+# Option 2. Run in background using PM2
+# Install PM2 if you don't have: npm install pm2 -g
+pm2 start npm --name uptime-kuma -- run start-server
+
+# Listen to different port or hostname
+pm2 start npm --name uptime-kuma -- run start-server -- --port=80 --hostname=0.0.0.0
+
+```
+
+More useful commands if you have installed.
+
+```bash
+pm2 start uptime-kuma
+pm2 restart uptime-kuma
+pm2 stop uptime-kuma
+```
+
+Browse to http://localhost:3001 after started.
+
+### (Optional) One more step for Reverse Proxy
+
+This is optional for someone who want to do 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