Cách cài đặt Kuma - Self-hosted Uptime Robot Alternative trên Ubuntu 20.04

[theanh]

Uptime-Kuma là một công cụ giám sát mã nguồn mở giống như "Uptime Robot" được viết bằng Nodejs. Đây là một công cụ giám sát tự lưu trữ với bảng điều khiển đẹp mắt, lạ mắt và hỗ trợ nhiều phương thức thông báo. Uptime-Kuma sẽ giám sát thời gian hoạt động của máy chủ hoặc máy chủ lưu trữ thông qua giao thức HTTP(s), TCP và Ping. Nếu không thể truy cập máy chủ thông qua các giao thức này theo định kỳ, máy chủ lưu trữ thời gian hoạt động sẽ gửi thông báo qua Webhooks, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), v.v.

Trong hướng dẫn này, bạn sẽ tìm hiểu cách cài đặt Uptime-Kuma trên máy chủ Ubuntu và sử dụng máy chủ web Apache làm proxy ngược với Chứng chỉ SSL Let's Encrypt miễn phí ở phía trước. Trong quá trình cài đặt, bạn cũng sẽ tìm hiểu về cài đặt nodejs thông qua nvm (trình quản lý phiên bản node).

Điều kiện tiên quyết​

• Máy chủ Ubuntu 20.04.
• Người dùng có quyền root. Bạn sẽ sử dụng người dùng này để cài đặt các gói mới và sửa đổi cài đặt hệ thống.

Thêm người dùng mới​

Trước tiên, bạn sẽ thêm một người dùng mới vào hệ thống Ubuntu. Vì lý do bảo mật, ứng dụng Uptime-Kuma sẽ chạy dưới dạng người dùng không phải root.

1. Thêm một người dùng mới bằng cách thực hiện lệnh bên dưới. Đối với ví dụ này, chúng ta sẽ sử dụng tên người dùng "johndoe". hãy đảm bảo thay đổi tên người dùng bằng tên của riêng bạn.

useradd -m -s /bin/bash johndoe

Các tùy chọn bạn phải biết:

• -m = tự động tạo thư mục home cho tên người dùng, thư mục này sẽ có trong thư mục '/home'.
• -s = định nghĩa đường dẫn của shell cho người dùng, hầu hết Linux đều có shell `/bin/bash.

2. Sau đó, chạy lệnh sau để thiết lập mật khẩu cho người dùng "johndoe".

passwd johndoe

Bây giờ hãy nhập một mật khẩu mạnh mới và lặp lại, sau đó nhấn "Enter" để xác nhận.

3. Tiếp theo, thêm người dùng "johndoe" vào nhóm "sudo" bằng lệnh bên dưới.

usermod -aG sudo johndoe

Bằng cách thêm người dùng vào nhóm "sudo", người dùng có thể thực thi lệnh "sudo su" và nhận được quyền root.

Cài đặt NVM (Node Version Manager)​

NVM hay Node Version Manager là một công cụ dòng lệnh để cài đặt nhiều phiên bản nodejs trên một hệ thống. Công cụ này cho phép bạn cài đặt phiên bản nodejs cụ thể cho các ứng dụng của mình, giúp môi trường phát triển và triển khai của bạn trở nên linh hoạt.

Trong giai đoạn này, bạn sẽ cài đặt nvm dưới người dùng không phải root "johndoe".

1. Từ shell gốc của bạn, hãy đăng nhập vào người dùng "johndoe" bằng lệnh sau.

su - johndoe

2. Tải xuống và thực thi tập lệnh cài đặt nvm như sau.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash

3. Sau khi thành công, hãy tải lại môi trường bash bằng lệnh bên dưới.

source ~/.bashrc

4. Bây giờ hãy xác minh cài đặt "nvm" bằng cách chạy lệnh bên dưới.

command -v nvm

Nếu cài đặt thành công, bạn sẽ thấy kết quả "nvm". Nếu không, bạn sẽ không thấy gì hoặc kết quả sẽ trống.

Bây giờ hãy thực hiện lệnh nvm như bên dưới.

nvm --help

Và bạn sẽ thấy trang trợ giúp thủ công của lệnh nvm.

Node Version Manager (v0.38.0)

Lưu ý:  đề cập đến bất kỳ chuỗi phiên bản nào mà nvm hiểu được. Bao gồm:
 - số phiên bản đầy đủ hoặc một phần, bắt đầu bằng "v" tùy chọn (0.10, v0.1.2, v1)
 - bí danh mặc định (tích hợp sẵn): node, stable, unstable, iojs, system
 - bí danh tùy chỉnh mà bạn định nghĩa bằng `nvm alias foo`

Bất kỳ tùy chọn nào tạo ra đầu ra có màu phải tuân thủ tùy chọn `--no-colors`.

Cách sử dụng:
 nvm --help Hiển thị thông báo này
 --no-colors Bỏ đầu ra có màu

.....

Lưu ý:
 để xóa, xóa hoặc gỡ cài đặt nvm - chỉ cần xóa thư mục `$NVM_DIR` (thường là `~/.nvm`)

Cài đặt phiên bản Nodejs LTS​

Để cài đặt ứng dụng uptime-Kuma, bạn cần cài đặt nodejs >= 14, git và pm2. Đối với điểm này, bạn sẽ cài đặt phiên bản nodejs LTS mới nhất bằng lệnh nvm.

1. Thực hiện lệnh nvm bên dưới để cài đặt phiên bản nodejs LTS mới nhất.

nvm install --lts

Sau khi cài đặt thành công, bạn sẽ thấy đầu ra tương tự như bên dưới.



Phiên bản nodejs đầu tiên bạn cài đặt sẽ trở thành phiên bản mặc định trên môi trường phát triển của bạn.

2. Bây giờ hãy chạy lệnh sau để xác minh cài đặt nodejs.

node --version
npm --version

Nếu cài đặt thành công, bạn sẽ thấy đầu ra tương tự như bên dưới.

# nodejs version
v14.17.4

# npm version
6.14.14

Tải xuống và cài đặt Uptime-Kuma​

Lúc này, bạn đã sẵn sàng cài đặt ứng dụng Uptime-Kuma.

1. Sao chép mã nguồn uptime-Kuma bằng lệnh git bên dưới.

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

2. Sau đó, hãy thay đổi thư mục làm việc thành "uptime-kuma/" và thực hiện lệnh npm để cài đặt tất cả các gói cần thiết cho uptime-kuma.

cd uptime-kuma/
npm run setup

Và bạn sẽ thấy đầu ra tương tự như bên dưới.

Thiết lập Uptime-Kuma bằng pm2​

PM2 là gì? Đây là trình quản lý quy trình nodejs giúp bạn quản lý và duy trì ứng dụng nodejs của mình mãi mãi. pm2 có một số tính năng tích hợp giúp triển khai ứng dụng nodejs dễ dàng, cho phép bạn theo dõi trạng thái ứng dụng, nhật ký và thậm chí thiết lập tệp dịch vụ cho ứng dụng của mình.

1. Cài đặt gói pm2 bằng lệnh npm bên dưới.

npm install pm2

2. Sau khi cài đặt hoàn tất, hãy thực thi lệnh pm2 bên dưới để khởi động ứng dụng uptime-kuma.

pm2 start npm --name uptime-kuma -- run start-server -- --port=3001 --hostname=127.0.0.1

Và bạn sẽ thấy các thông báo đầu ra như bên dưới.



Như trong hình, tên ứng dụng "uptime-kuma" đang chạy với trạng thái "online".

3. Để kiểm tra trạng thái ứng dụng của bạn trên pm2, hãy chạy các lệnh sau bên dưới.

Kiểm tra trạng thái ứng dụng nodejs.

trạng thái pm2

Kiểm tra nhật ký ứng dụng nodejs.

nhật ký pm2

Giám sát ứng dụng nodejs theo thời gian thực.

pm2 monit

4. Tiếp theo, thực hiện lệnh pm2 sau để tạo tệp dịch vụ cho ứng dụng uptime-kuma.

pm2 startup

Sau đó, bạn nên chạy lệnh theo thứ tự trên đầu ra.

sudo env PATH=$PATH:/home/johndoe/.nvm/versions/node/v14.17.4/bin /home/johndoe/.nvm/versions/node/v14.17.4/lib/node_modules/pm2/bin/pm2 startup systemd -u johndoe --hp /home/johndoe

Hãy đảm bảo sử dụng lệnh "sudo" và nhập đúng mật khẩu cho người dùng của bạn để có được quyền root.

Sau khi lệnh hoàn tất, bạn sẽ thấy đầu ra sau.



Như đã thấy trên ảnh chụp màn hình, pm2 tạo một dịch vụ systemd dựa trên người dùng, trong ví dụ này là "pm2-johndoe.service".

Bây giờ hãy thực hiện lệnh sau để tạo và lưu trạng thái ứng dụng uptime-kuma. Lệnh này rất quan trọng để ứng dụng uptime-kuma luôn chạy ở chế độ nền, ngay cả sau khi khởi động hệ thống.

pm2 save

5. Để xác minh dịch vụ 'pm2-johndoe', hãy chạy lệnh bên dưới.

sudo systemctl is-enabled pm2-johndoe

Bạn sẽ thấy đầu ra `enabled`, nghĩa là ứng dụng uptime-kuma sẽ tự động chạy sau khi khởi động hệ thống.

Ngoài ra, bạn có thể thử khởi động lại hệ thống và đăng nhập lại vào máy chủ, sau đó kiểm tra dịch vụ uptime-kuma.

sudo systemctl status pm2-johndoe

Bạn sẽ thấy đầu ra tương tự như bên dưới.

? pm2-johndoe.service - Trình quản lý quy trình PM2
 Đã tải: đã tải (/etc/systemd/system/pm2-johndoe.service; enabled; vendor preset: enabled)
 Đang hoạt động: đang hoạt động (đang chạy) kể từ Tue 2021-08-10 01:52:37 UTC; 3 phút 57 giây trước
 Tài liệu: https://pm2.keymetrics.io/
 PID chính: 745 (PM2 v5.1.0: God)
 Nhiệm vụ: 34 (giới hạn: 2343)
 Bộ nhớ: 120,4M
 CGroup: /system.slice/pm2-johndoe.service
 ??745 PM2 v5.1.0: God Daemon (/home/johndoe/.pm2)
 ??772 npm
 ??873 sh -c node server/server.js "--port=3001" "--hostname=127.0.0.1"
 ??874 node server/server.js --port=3001 --hostname=127.0.0.1

10 tháng 8 01:52:36 ubuntu64 pm2[633]: [PM2] Đang tạo daemon PM2 với pm2_home=/home/johndoe/.pm2
10 tháng 8 lúc 01:52:37 ubuntu64 pm2[633]: [PM2] Đã tạo daemon PM2 thành công
10 tháng 8 lúc 01:52:37 ubuntu64 pm2[633]: [PM2] Đang hồi sinh
10 tháng 8 lúc 01:52:37 ubuntu64 pm2[633]: [PM2] Đang khôi phục các tiến trình nằm trong /home/johndoe/.pm2/dump.pm2
10 tháng 8 lúc 01:52:37 ubuntu64 pm2[633]: [PM2] Tiến trình /home/johndoe/.nvm/versions/node/v14.17.4/bin/npm đã được khôi phục

"pm2-johndoe.service" đang hoạt động khi khởi động hệ thống.

Thiết lập Apache làm Proxy ngược​

Đối với hướng dẫn này, bạn sẽ cài đặt và cấu hình máy chủ web Apache làm proxy ngược cho ứng dụng uptime-Kuma.

1. Thực hiện lệnh sau để cài đặt các gói máy chủ web Apache.

sudo apt install apache2

Gõ "y" và nhấn "Enter" để cài đặt máy chủ web Apache.

2. Sau đó, hãy bật một số mô-đun Apache bằng lệnh bên dưới.

sudo a2enmod ssl proxy proxy_ajp proxy_wstunnel proxy_http rewrite deflate headers proxy_balancer proxy_connect proxy_html

3. Tiếp theo, tạo cấu hình máy chủ ảo mới 'uptime-kuma.conf' bằng lệnh trình chỉnh sửa nano bên dưới.

sudo nano /etc/apache2/sites-available/uptime-kuma.conf

Dán cấu hình sau vào shell thiết bị đầu cuối của bạn và thay đổi tên miền "uptime.example.net" bằng tên miền của bạn, chẳng hạn như "domain.com".

 ServerName uptime.example.net

 ProxyPass / http://localhost:3001/
 RewriteEngine on
 RewriteCond %{HTTP:Nâng cấp} websocket [NC]
 RewriteCond %{HTTP:Kết nối} nâng cấp [NC]
 RewriteRule ^/?(.*) "ws://localhost:3001/$1" [P,L]

Nhấn "Ctrl+x" và nhập "Y" để lưu cấu hình.

4. Bây giờ hãy kích hoạt cấu hình máy chủ ảo apache "uptime-kuma" bằng lệnh bên dưới.

sudo a2ensite uptime-kuma

Sau đó, hãy thực hiện lệnh sau để xác minh cấu hình apache và đảm bảo rằng bạn không gặp bất kỳ lỗi nào.

sudo apachectl configtest

5. Bây giờ hãy áp dụng cấu hình mới bằng cách khởi động lại dịch vụ Apache bằng lệnh bên dưới.

sudo systemctl restart apache2

Bảo mật Uptime-kuma bằng SSL Letsencrypt​

Để bảo mật quyền truy cập Uptime-Kuma, bạn sẽ thiết lập SSL từ Letsencrypt cho máy chủ web Apache.

1. Trước hết, hãy cài đặt công cụ certbot bằng cách chạy lệnh sau.

sudo apt install python3-certbot-apache

Gõ "y" và nhấn "Enter" để bắt đầu cài đặt.

2. Sau khi cài đặt, hãy tạo SSL Let's encrypt bằng lệnh certbot như bên dưới.

sudo certbot --apache yourdomain.com

Nhập địa chỉ email của bạn để đăng ký Letsencrypt và nhấn "Enter" để tiếp tục. Letsencrypt sẽ gửi email đến địa chỉ email của bạn bất cứ khi nào chứng chỉ SSL của bạn hết hạn.

```
Lưu nhật ký gỡ lỗi vào /var/log/letsencrypt/letsencrypt.log
Các plugin đã chọn: Authenticator apache, Installer apache
Nhập địa chỉ email (dùng để gia hạn khẩn cấp và thông báo bảo mật) (Nhập 'c' để
hủy): [emailprotected]

Đối với TOS (Điều khoản dịch vụ) của Letsencrypt, hãy nhập "A" để đồng ý và nhấn "Enter" để tiếp tục.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Vui lòng đọc Điều khoản dịch vụ tại
https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf. Bạn phải
đồng ý để đăng ký với máy chủ ACME tại
https://acme-v02.api.letsencrypt.org/directory
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(Đồng ý/(Hủy bỏ: A

Đối với việc chia sẻ email với EFF (Electronic Frontier Foundation), bạn có thể nhập "Y" cho đồng ý và "N" cho không. Đối với ví dụ này, chúng tôi sẽ không chia sẻ địa chỉ email với EFF.

Bạn có sẵn lòng chia sẻ địa chỉ email của mình với Electronic Frontier
Foundation, đối tác sáng lập của dự án Let's Encrypt và là tổ chức phi lợi nhuận phát triển Certbot không? Chúng tôi muốn gửi cho bạn email về công việc của chúng tôi
mã hóa web, tin tức EFF, các chiến dịch và cách hỗ trợ tự do kỹ thuật số.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(C)es/(K)o: Không

Bây giờ công cụ certbot sẽ tạo SSL Letsencrypt cho tên miền Uptime-Kuma. Ngoài ra, nó sẽ thêm một số cấu hình bổ sung cho cấu hình máy chủ ảo apache.

Bạn sẽ được yêu cầu thiết lập chuyển hướng tự động từ HTTP sang HTTPS. Nhập số "2" để thiết lập chuyển hướng tự động apache HTTP sang HTTPS và nhấn "Enter".

```
Vui lòng chọn có chuyển hướng lưu lượng HTTP sang HTTPS hay không, xóa quyền truy cập HTTP.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1: Không chuyển hướng - Không thực hiện thêm bất kỳ thay đổi nào đối với cấu hình máy chủ web.
2: Chuyển hướng - Chuyển hướng tất cả các yêu cầu đến quyền truy cập HTTPS an toàn. Chọn tùy chọn này cho
các trang web mới hoặc nếu bạn tin chắc rằng trang web của mình hoạt động trên HTTPS. Bạn có thể hoàn tác thay đổi này
bằng cách chỉnh sửa cấu hình máy chủ web của bạn.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chọn số thích hợp [1-2] sau đó [enter] (nhấn 'c' để hủy): 2

Sau khi quá trình triển khai thành công, bạn sẽ thấy đầu ra tương tự như bên dưới.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Xin chúc mừng! Bạn đã bật thành công https://uptime.example.net

Bạn nên kiểm tra cấu hình của mình tại:
https://www.ssllabs.com/ssltest/analyze.html?d=uptime.example.net
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

LƯU Ý QUAN TRỌNG:
- Xin chúc mừng! Chứng chỉ và chuỗi của bạn đã được lưu tại:
 /etc/letsencrypt/live/uptime.example.net/fullchain.pem
 Tệp khóa của bạn đã được lưu tại:
 /etc/letsencrypt/live/uptime.example.net/privkey.pem
 Chứng chỉ của bạn sẽ hết hạn vào ngày 2021-10-10. Để có phiên bản
 chứng chỉ mới hoặc đã chỉnh sửa trong tương lai, chỉ cần chạy lại certbot
 với tùy chọn "certonly". Để gia hạn không tương tác *tất cả* các
 chứng chỉ của bạn, hãy chạy "certbot renew"
- Thông tin đăng nhập tài khoản của bạn đã được lưu trong thư mục cấu hình Certbot
 của bạn tại /etc/letsencrypt. Bây giờ bạn nên sao lưu an toàn thư mục này. Thư mục cấu hình này
 cũng sẽ
 chứa các chứng chỉ và khóa riêng do Certbot thu được, do đó
 việc sao lưu thường xuyên thư mục này là lý tưởng.
- Nếu bạn thích Certbot, vui lòng cân nhắc hỗ trợ công việc của chúng tôi bằng cách:

 Quyên góp cho ISRG / Let's Encrypt: https://letsencrypt.org/donate
 Quyên góp cho EFF: https://eff.org/donate-le

- Chúng tôi không thể đăng ký cho bạn vào danh sách gửi thư EFF vì địa chỉ
 email của bạn có vẻ không hợp lệ. Bạn có thể thử lại sau bằng cách
 truy cập https://act.eff.org.

Xác minh cài đặt Uptime-Kuma​

1. Mở trình duyệt web của bạn và nhập URL cài đặt Uptime-Kuma vào thanh địa chỉ.

https://uptime.example.net/

Bạn sẽ được chuyển hướng đến kết nối bảo mật HTTPS.

2. tạo người dùng quản trị mới cho Uptime-kuma trên trang đầu tiên. Nhập người dùng quản trị và mật khẩu của bạn, sau đó nhấp vào nút "Tạo"



3. Sau đó, đăng nhập bằng tên người dùng và mật khẩu mới của bạn, sau đó nhấp vào nút "Đăng nhập".



Bây giờ, bạn sẽ thấy bảng điều khiển uptime-kuma.

4. Để thêm máy chủ mới vào màn hình, hãy nhấp vào nút "Thêm màn hình mới".



5. Đối với ví dụ này, bạn sẽ theo dõi trang web, vì vậy hãy chọn "Loại màn hình" là "HTTP(s)", nhập địa chỉ URL của trang web, nhấp vào "Thông báo thiết lập" để được hỗ trợ thông báo, sau đó bạn nhấp vào nút "Lưu" ở cuối trang.



6. Bạn sẽ được chuyển hướng đến bảng điều khiển uptime-Kuma và thấy máy chủ của bạn trên trang bảng điều khiển.



Dưới đây là một ví dụ khác sau khi thêm loại mới "TCP/IP" với các cổng đã đóng và kết quả là "ENCONNREFUSED" hoặc lỗi kết nối vì cổng bị từ chối/đóng.

Kết luận​

Xin chúc mừng! Bạn đã cài đặt thành côngUptime-Kuma với máy chủ web Apache làm proxy ngược và bảo mật triển khai Uptime-Kuma bằng SSL Letsencrypt.Đối với giai đoạn tiếp theo, bạn có thể thêm máy chủ của mình và kích hoạt thông báo về bất kỳ sự cố ngừng hoạt động nào.