From 2339405f9026512dd0b0ff320f368874af5ce63e Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 19 Aug 2021 14:13:30 +0800 Subject: [PATCH 1/2] Update README.md --- README.md | 64 ++++++++++++------------------------------------------- 1 file changed, 14 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 7984a31aa..0eed7ac42 100644 --- a/README.md +++ b/README.md @@ -19,75 +19,41 @@ It is a self-hosted monitoring tool like "Uptime Robot". ## 🔧 How to Install +### 🚀 Installer via cli + +Interactive cli installer, supports Docker or without Docker. + +```bash +curl -o kuma_install.sh https://raw.githubusercontent.com/louislam/uptime-kuma/master/install.sh && sudo bash kuma_install.sh +``` + ### 🐳 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. +### Advanced Installation -If you want to change **port** and **volume**, or need to browse via a reserve proxy, please read wiki. +If you need more options or need to browse via a reserve proxy, please read: -### 💪🏻 Without Docker (Recommended for x86/x64 only) +https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install -Required Tools: Node.js >= 14, git and pm2. -```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 - -``` - -Browse to http://localhost:3001 after started. - -If you want to change **port** and **hostname**, or need to browse via a reserve proxy, please read wiki. ## 🆙 How to Update -### 🆙🐳 Docker +Please read: -Re-pull the latest docker image and create another container with the same volume. - -For someone who used my "How-to-use" commands to install Uptime Kuma, you can update by this: - -```bash -docker pull louislam/uptime-kuma:1 -docker stop uptime-kuma -docker rm uptime-kuma -docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1 -``` - -PS: For every new release, it takes some time to build the docker image, please be patient if it is not available yet. - -### 🆙 💪🏻 Without Docker - -```bash -cd -git fetch --all -git checkout 1.2.0 --force -npm install -npm run build -pm2 restart uptime-kuma -``` +https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update ## 🆕 What's Next? I will mark requests/issues to the next milestone. + https://github.com/louislam/uptime-kuma/milestones ## 🖼 More Screenshots @@ -122,5 +88,3 @@ If you want to report a bug or request a new feature. Free feel to open a new is If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md English proofreading is needed too, because my grammar is not that great sadly. Feel free to correct my grammar in this Readme, source code or wiki. - -🐻 From 2d36f4cd4a548cf9004ec75d79fee79c58a8d338 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 19 Aug 2021 17:32:57 +0800 Subject: [PATCH 2/2] Create SECURITY.md --- SECURITY.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..47f0786f9 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 1.x.x | :white_check_mark: | + +## Reporting a Vulnerability + +https://github.com/louislam/uptime-kuma/issues