使用 ntfy 自建消息推送服务


消息推送有很多现成的平台,比如 Server 酱、微信甚至 E-mail 等等,基本上可以满足大多数场景。不过也有一些缺点,比如发送消息的要求格式固定、推送数据的隐私性问题等,这里以开源 ntfy 搭建一个自己的消息推送服务


配置服务器

使用 docker compose,首先新建一个 yaml 文件然后进行编辑:

mkdir -p /etc/ntfy
nano /etc/ntfy/ntfy.yaml

写入 docker 配置:

version: "3"
services:
  ntfy:
    image: binwiederhier/ntfy
    container_name: ntfy
    command:
      - serve
    environment:
      - TZ=Asia/Shanghai    # optional: set desired timezone
    user: 0:0 # optional: replace with your own user/group or uid/gid
    volumes:
      - /var/cache/ntfy:/var/cache/ntfy
      - /etc/ntfy:/etc/ntfy
      - /var/lib/ntfy:/var/lib/ntfy
    ports:
      - 127.0.0.1:5080:80
    healthcheck: # optional: remember to adapt the host:port to your environment
        test: ["CMD-SHELL", "wget -q --tries=1 http://localhost:80/v1/health -O - | grep -Eo '\"healthy\"\\s*:\\s*true' || exit 1"]
        interval: 60s
        timeout: 10s
        retries: 3
        start_period: 40s
    restart: unless-stopped

按 Ctrl+O 保存,Ctrl+X 退出。

写入 ntfy 配置

可以先运行下 docker compose 把上面的目录建出来,不运行的话,如下手动建,然后创建配置文件:

nano /etc/ntfy/server.yml

然后写入配置:

base-url: "https://ntfy.example.com"
cache-file: "/var/cache/ntfy/cache.db"
attachment-cache-dir: "/var/cache/ntfy/attachments"
attachment-total-size-limit: "5G"
attachment-file-size-limit: "15M"
attachment-expiry-duration: "3h"
visitor-attachment-total-size-limit: "100M"
visitor-attachment-daily-bandwidth-limit: "500M"
auth-file: "/var/lib/ntfy/auth.db"
auth-default-access: "deny-all"
behind-proxy: true
smtp-sender-addr: "smtp.example.com:587"
smtp-sender-user: "ntfy@example.com"
smtp-sender-pass: "xxxxxxxxxx"
smtp-sender-from: "ntfy@example.com"

按 Ctrl+O 保存,Ctrl+X 退出。

官方甚至提供了直接的 https 代理(如果你把证书给它),更多的配置功能可以参考官方文档

最后启动下 docker 容器:

docker compose -f /etc/ntfy.yaml up -d

nginx 反向代理

编辑 nginx 配置文件,加入如下代码(参考):

server {
listen 443 ssl;
listen [::]:443 ssl;
server_name ntfy.example.com;

# ssl证书地址
ssl_certificate /usr/local/nginx/cert/ssl.pem; # pem文件的路径
ssl_certificate_key /usr/local/nginx/cert/ssl.key; # key文件的路径

location / {
proxy_pass http://127.0.0.1:80;
proxy_http_version 1.1;

proxy_set_header Host $http_host;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_connect_timeout 3m;
proxy_send_timeout 3m;
proxy_read_timeout 3m;

client_max_body_size 0; # Stream request body to backend
}
}

编辑完成后保存,重载下 nginx 配置:

nginx -s reload

使用 ntfy

说明

刚上手 ntfy 可能会感觉跟其他的消息推送服务有点不一样,这里简要说明一下!

其他的消息推送服务一般是注册个账号,登录以后会有专属连接,通过连接推送消息。而 ntfy 默认没有账号一说,它通过主题来区分推送的消息,举个例子:

比如 URL 是 https://ntfy.example.com,现在需要接收 nas 推送过来的消息,那么地址可以是 https://ntfy.example.com/nas,需要接收公司推送过来的消息,地址可以是 https://ntfy.example.com/company,地址后面跟着的,就是一个主题,任何人都可以用这个主题来发送消息,也可以用这个主题来接受消息!

所以主题就成了类似于“密码”的存在,如果需要保密,主题名就不要让其他人猜到!这就是 ntfy 设计的思路,默认消息是共享的,默认服务器不会长时间留存消息记录!

那如果我非要用户名和密码加密呢,别急,也可以设置,往下看设置认证那一节!

现在可以直接访问配置的域名打开 ntfy 了,在 settings 中可以更改语言。

设置认证

任何人都可以订阅主题,这当然有点不安全,因为是自建,所以这里就设定下最简单的规则:

开放一个用户,任何没经过用户名和密码认证的主题都禁止访问!

首先需要编辑 ntfy 的配置文件 /etc/ntfy/server.yml,添加一行配置阻止未授权的用户访问主题:

auth-default-access: "deny-all"
auth-default-access 项默认为 "read-write"

然后保存,重启下容器:

docker compose -f /etc/ntfy.yaml restart

然后进入容器内部:

docker exec -it ntfy /bin/sh

添加用户:

ntfy user add --role=admin admin

这里添加了一个 admin 的用户,回车后,会要求输入密码和重复密码,确认后用户就创建完成了!

我们可以用 ntfy user list 查看下用户信息:

可以看到 admin 可以访问所有的主题,*(匿名用户)禁止所有主题访问就可以了!

[可选] 在后面的推送避免直接传递用户名和密码,可以为用户创建 token 来替代!

为 admin 创建 token:

ntfy token add admin

创建后可以复制出来备用,同样用 ntfy token list 可以查看已经创建的所有 token。

然后回到刚才的网页,此刻再次订阅主题时,就需要输入用户名和密码了。

注意事项

用户名和密码作为参数传递时,需要进行 base64 编码,官方样例:

username   = "testuser"
password   = "fakepassword"
authHeader = "Basic " + base64(username + ":" + password) // -> Basic dGVzdHVzZXI6ZmFrZXBhc3N3b3Jk
authParam  = base64_raw(authHeader) // -> QmFzaWMgZEdWemRIVnpaWEk2Wm1GclpYQmhjM04zYjNKaw (no trailing =)

token 也一样,例:

token      = "tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2"
authHeader = "Bearer " + base64(token) // -> Bearer tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2
authParam  = base64_raw(authHeader) // -> QmVhcmVyIHRrX0FnUWRxN21WQm9GRDM3elFWTjI5Umh1TXpOSXoy

比如要发送到 test 主题,那么连接可能是 https://ntfy.example.com/test?auth=上面生成的 authParam 值。

最终生成的 base64 编码如果末尾包含 = ,则删除

推送样例及说明

官方的样例已经很详细了,这里就不在赘述了,可以参考官方样例

Watchtower – 自动更新 Docker 镜像与容器

 

前言

Docker 容器的部署有一种在手机上装 App 的感觉,但 Docker 容器并不会像手机 App 那样会自动更新,而如果我们需要更新容器一般需要以下四个步骤:
停止容器:docker stop
删除容器:docker rm
更新镜像:docker pull <IMAGE>
启动容器:docker run <ARG> ... <IMAGE>
停止容器这个步骤可以在删除容器时使用 -f 参数来代替,即使这样还是需要三个步骤。如果部署了大量的容器需要更新使用这种传统的方式工作量是巨大的。

Watchtower 是一个可以实现自动化更新 Docker 基础镜像与容器的实用工具。它监视正在运行的容器以及相关的镜像,当检测到 reg­istry 中的镜像与本地的镜像有差异时,它会拉取最新镜像并使用最初部署时相同的参数重新启动相应的容器,一切好像什么都没发生过,就像更新手机上的 App 一样。

快速开始

Watch­tower 本身被打包为 Docker 镜像,因此可以像运行任何其他容器一样运行它:

docker run -d \
    --name watchtower \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower

然后所有容器都会自动更新,也包括 Watch­tower 本身。

选项参数

[collapse title=’点击查看’]

$ docker run --rm containrrr/watchtower -h

Watchtower automatically updates running Docker containers whenever a new image is released.
More information available at https://github.com/containrrr/watchtower/.

Usage:
watchtower [flags]

Flags:
-a, --api-version string api version to use by docker client (default "1.24")
-c, --cleanup remove previously used images after updating
-d, --debug enable debug mode with verbose logging
--enable-lifecycle-hooks Enable the execution of commands triggered by pre- and post-update lifecycle hooks
-h, --help help for watchtower
-H, --host string daemon socket to connect to (default "unix:///var/run/docker.sock")
-S, --include-stopped Will also include created and exited containers
-i, --interval int poll interval (in seconds) (default 300)
-e, --label-enable watch containers where the com.centurylinklabs.watchtower.enable label is true
-m, --monitor-only Will only monitor for new images, not update the containers
--no-pull do not pull any new images
--no-restart do not restart any containers
--notification-email-delay int Delay before sending notifications, expressed in seconds
--notification-email-from string Address to send notification emails from
--notification-email-server string SMTP server to send notification emails through
--notification-email-server-password string SMTP server password for sending notifications
--notification-email-server-port int SMTP server port to send notification emails through (default 25)
--notification-email-server-tls-skip-verify
Controls whether watchtower verifies the SMTP server's certificate chain and host name.
Should only be used for testing.

--notification-email-server-user string SMTP server user for sending notifications
--notification-email-subjecttag string Subject prefix tag for notifications via mail
--notification-email-to string Address to send notification emails to
--notification-gotify-token string The Gotify Application required to query the Gotify API
--notification-gotify-url string The Gotify URL to send notifications to
--notification-msteams-data The MSTeams notifier will try to extract log entry fields as MSTeams message facts
--notification-msteams-hook string The MSTeams WebHook URL to send notifications to
--notification-slack-channel string A string which overrides the webhook's default channel. Example: #my-custom-channel
--notification-slack-hook-url string The Slack Hook URL to send notifications to
--notification-slack-icon-emoji string An emoji code string to use in place of the default icon
--notification-slack-icon-url string An icon image URL string to use in place of the default icon
--notification-slack-identifier string A string which will be used to identify the messages coming from this watchtower instance (default "watchtower")
-n, --notifications strings notification types to send (valid: email, slack, msteams, gotify)
--notifications-level string The log level used for sending notifications. Possible values: panic, fatal, error, warn, info or debug (default "info")
--remove-volumes remove attached volumes before updating
--revive-stopped Will also start stopped containers that were updated, if include-stopped is active
-R, --run-once Run once now and exit
-s, --schedule string the cron expression which defines when to update
-t, --stop-timeout duration timeout before a container is forcefully stopped (default 10s)
-v, --tlsverify use TLS and verify the remote

[/collapse]

自动清除旧镜像

官方给出的默认启动命令在长期使用后会堆积非常多的标签为 none 的旧镜像,如果放任不管会占用大量的磁盘空间。要避免这种情况可以加入 –cleanup 选项,这样每次更新都会把旧的镜像清理掉。

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --cleanup

--cleanup 选项可以简写为 -c

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c

选择性自动更新

某些容器可能需要稳定的运行,经常更新或重启可能会造成一些问题,这时我们可以使用一些选项参数来选择与控制容器的更新。

容器更新列表
假设我们只想更新 nginx、redis 这两个容器,我们可以把容器名称追加到启动命令的最后面,就像下面这个例子:

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    nginx redis

博主觉得把需要更新的容器名称写在启动命令中不利于管理,于是想了个更好的方法,建立一个更新列表文件。

$ cat ~/.watchtower.list
aria2-pro
unlockmusic
mtg
...

通过变量的方式去调用这个列表:

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    $(cat ~/.watchtower.list)

这样只需要调整列表后删除 Watch­tower 容器并重新执行上面的命令重新启动 Watch­tower 即可。

设置单个容器自动更新特征

给容器中添加 com.centurylinklabs.watchtower.enable 这个 LA­BEL 并设置它的值为 false,或者在启动命令中加入 --label com.centurylinklabs.watchtower.enable=false 参数可以排除相应的容器。下面这个例子是博主的 openwrt-mini 镜像的容器启动命令,Watch­tower 将永远忽略它的更新,即使它包含在自动更新列表中。

docker run -d \
    --name openwrt-mini \
    --restart always \
    --network openwrt \
    --privileged \
    --label com.centurylinklabs.watchtower.enable=false \
    p3terx/openwrt-mini \
    /sbin/init

当容器启动命令中加入 --label com.centurylinklabs.watchtower.enable=true 参数,并且给 Watch­tower 加上 --label-enable 选项时,Watch­tower 将只更新这些包含此参数的容器。

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    --label-enable

–label-enable 可以简写为 -e:

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -ce

因为需要在容器启动时进行设置,且设置后就无法直接更改,只能重建容器,所以这种方式的灵活性不如更新列表法。尤其是在设置 com.centurylinklabs.watchtower.enable=false 参数后容器将永远被 Watch­tower 忽略,也包括后面将要提到的手动更新方式,所以一般不推荐这样做,除非你愿意手动重建的原生方式更新。

设置自动更新检查频率

默认情况下 Watch­tower 每 5 分钟会轮询一次,如果你觉得这个频率太高了可以使用如下选项来控制更新检查的频率,但二者只能选择其一。

--interval, -i - 设置更新检测时间间隔,单位为秒。比如每隔 1 个小时检查一次更新:

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    --interval 3600

--schedule, -s - 设置定时检测更新时间。格式为 6 字段 Cron 表达式,而非传统的 5 字段,即第一位是秒。比如每天凌晨 2 点检查一次更新:

docker run -d \
    --name watchtower \
    --restart unless-stopped \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    --schedule "0 0 2 * * *"

每天凌晨1点更新(北京时间)

docker run -d \
    --name watchtower \
    --restart always \
    -e TZ=Asia/Shanghai \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --cleanup \
    -s "0 0 1 * * *"

手动更新

前面的使用方式都是让 Watch­tower 以 detached(后台)模式在运行并自动更新容器,而 Watch­tower 也支持以 foreground(前台)模式来使用,即运行一次退出并删掉容器,来实现手动更新容器。这对于偶尔更新一次那些不在自动更新列表中的容器非常有用。

对于 foreground 模式,需要加上 --run-once 这个专用的选项。下面的例子 Docker 会运行一次 Watch­tower 并检查 aria2-pro 容器的基础镜像更新,最后删掉本次运行创建的 Watch­tower 容器。

docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -c \
    --run-once \
    aria2-pro

--run-once 可以简写为 -R

docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower -cR \
    aria2-pro

需要注意的是当这个容器设置过 com.centurylinklabs.watchtower.enable=false 参数时不会更新。

尾巴

以上是博主在使用 Watch­tower 中总结的一些使用方式和方法,当然它还有一些其它的功能与使用方式,比如电子邮件通知、监视私人注册表的镜像、更新远程主机上的容器等,这些对于一般用户来说可能很少会用到,所以这里就不赘述了,感兴趣的小伙伴可以去研究 Watchtower 官方文档。

PikaPods – 简单的Docker容器化开源应用托管,Beta 期间免费一年

PikaPods 是开源应用程序的托管服务。有很多很棒的应用程序,但许多不提供自己的托管。

PikaPods 希望缩小这一差距,同时与作者分享收入。每月 1 美元即可运行最好的开源网络应用程序,在测试期间注册时免费赠送 50 美元。

暂时只提供欧洲服务器,可以绑定域名和使用SFTP,每个账号限制三个Docker容器。

查看可用的应用程序:https://www.pikapods.com/apps

网站地址:https://www.pikapods.com/

在 Linux 上使用 Docker 安装 Portainer

Portainer是Docker的图形化管理工具,提供状态显示面板、应用模板快速部署、容器镜像网络数据卷的基本操作(包括上传下载镜像,创建容器等操作)、事件日志显示、容器控制台操作、Swarm集群和服务等集中管理和操作、登录用户管理和控制等功能。功能十分全面,基本能满足中小型单位对容器管理的全部需求。

介绍

Portainer 由两个元素组成,Portainer ServerPortainer Agent。这两个元素在 Docker 引擎上作为轻量级 Docker 容器运行。本文档将帮助您在 Linux 环境中安装 Portainer Server 容器。要将新的 Linux 环境添加到现有的 Portainer 服务器安装,请参阅Portainer 代理安装说明

安装准备条件

  • 最新版本的 Docker 已安装并运行
  • 在将托管您的 Portainer 服务器实例的机器上进行 sudo 访问
  • 默认情况下,Portainer Server 将通过 port 公开 UI,9443并通过 port 公开 TCP 隧道服务器8000。后者是可选的,仅当您计划将边缘计算功能与边缘代理一起使用时才需要。

安装说明还对您的环境做出以下假设:

  • 您的环境符合我们的要求。虽然 Portainer 可以与其他配置一起使用,但它可能需要更改配置或功能有限。
  • 您正在通过 Unix 套接字访问 Docker。或者,您也可以通过 TCP 连接。
  • SELinux 在运行 Docker 的机器上被禁用。如果您需要 SELinux,则需要--privileged在部署 Portainer 时将标志传递给 Docker。
  • Docker 以 root 身份运行。使用无根 Docker 的 Portainer 有一些限制,需要额外的配置

部署

首先,创建 Portainer Server 用于存储其据库的卷:

docker volume create portainer_data

然后,下载并安装 Portainer Server 容器:

docker run -d -p 8000:8000 -p 9443:9443 --name portainer \
--restart=always \
-v /var/run/docker.sock:/var/run/docker.sock \
-v portainer_data:/data \
portainer/portainer-ce:2.11.1

Portainer 服务器现已安装完毕。您可以通过运行检查 Portainer Server 容器是否已启动docker ps

root@server:~# docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 
de5b28eb2fa9 portainer/portainer-ce:2.11.1 "/portainer" 2 weeks ago Up 9 days 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp, 0.0.0.0:9443->9443/tcp, :::9443->9443/tcp portainer

登录

现在安装已完成,您可以通过打开 Web 浏览器并转到以下位置登录您的 Portainer 服务器实例

https://localhost:9443

官方站点https://www.portainer.io/

安装 Docker 引擎:https://docs.docker.com/engine/install/

PM2实用入门指南

PM2 是一个守护进程管理器,它将帮助您管理和保持您的应用程序在线。PM2 入门很简单,它以简单直观的 C​​LI 形式提供,可通过 NPM 安装。

PM2是node进程管理工具,可以利用它来简化很多node应用管理的繁琐任务,如性能监控、自动重启、负载均衡等,而且使用非常简单。

下面就对PM2进行入门性的介绍,基本涵盖了PM2的常用的功能和配置。

简介

PM2是node进程管理工具,可以利用它来简化很多node应用管理的繁琐任务,如性能监控、自动重启、负载均衡等,而且使用非常简单。

下面就对PM2进行入门性的介绍,基本涵盖了PM2的常用的功能和配置。

安装

全局安装,简直不能更简单。

npm install -g pm2

同类工具

同类工具有Supervisor、Forever等。

目录介绍

pm2安装好后,会自动创建下面目录。看文件名基本就知道干嘛的了,就不翻译了。

  • $HOME/.pm2 will contain all PM2 related files
  • $HOME/.pm2/logs will contain all applications logs
  • $HOME/.pm2/pids will contain all applications pids
  • $HOME/.pm2/pm2.log PM2 logs
  • $HOME/.pm2/pm2.pid PM2 pid
  • $HOME/.pm2/rpc.sock Socket file for remote commands
  • $HOME/.pm2/pub.sock Socket file for publishable events
  • $HOME/.pm2/conf.js PM2 Configuration

入门教程

挑我们最爱的express应用来举例。一般我们都是通过npm start启动应用,其实就是调用node ./bin/www。那么,换成pm2就是

注意,这里用了--watch参数,意味着当你的express应用代码发生变化时,pm2会帮你重启服务,多贴心。

pm2 start ./bin/www --watch

入门太简单了,没什么好讲的。直接上官方文档:http://pm2.keymetrics.io/docs/usage/quick-start

常用命令

启动

参数说明:

  • --watch:监听应用目录的变化,一旦发生变化,自动重启。如果要精确监听、不见听的目录,最好通过配置文件。
  • -i --instances:启用多少个实例,可用于负载均衡。如果-i 0或者-i max,则根据当前机器核数确定实例数目。
  • --ignore-watch:排除监听的目录/文件,可以是特定的文件名,也可以是正则。比如--ignore-watch="test node_modules "some scripts""
  • -n --name:应用的名称。查看应用信息的时候可以用到。
  • -o --output <path>:标准输出日志文件的路径。
  • -e --error <path>:错误输出日志文件的路径。
  • --interpreter <interpreter>:the interpreter pm2 should use for executing app (bash, python…)。比如你用的coffee script来编写应用。

完整命令行参数列表:地址

pm2 start app.js --watch -i 2

重启

pm2 restart app.js

停止

停止特定的应用。可以先通过pm2 list获取应用的名字(–name指定的)或者进程id。

pm2 stop app_name|app_id

如果要停止所有应用,可以

pm2 stop all

删除

类似pm2 stop,如下

pm2 stop app_name|app_id
pm2 stop all

查看进程状态

pm2 list

查看某个进程的信息

[root@server]# pm2 describe 0
Describing process with id 0 - name oc-server
┌───────────────────┬──────────────────────────────────────────────────────────────┐
│ status            │ online                                                       │
│ name              │ oc-server                                                    │
│ id                │ 0                                                            │
│ path              │ /data/file/qiquan/over_the_counter/server/bin/www            │
│ args              │                                                              │
│ exec cwd          │ /data/file/qiquan/over_the_counter/server                    │
│ error log path    │ /data/file/qiquan/over_the_counter/server/logs/app-err-0.log │
│ out log path      │ /data/file/qiquan/over_the_counter/server/logs/app-out-0.log │
│ pid path          │ /root/.pm2/pids/oc-server-0.pid                              │
│ mode              │ fork_mode                                                    │
│ node v8 arguments │                                                              │
│ watch & reload    │                                                              │
│ interpreter       │ node                                                         │
│ restarts          │ 293                                                          │
│ unstable restarts │ 0                                                            │
│ uptime            │ 87m                                                          │
│ created at        │ 2016-08-26T08:13:43.705Z                                     │
└───────────────────┴──────────────────────────────────────────────────────────────┘

配置文件

简单说明

  • 配置文件里的设置项,跟命令行参数基本是一一对应的。
  • 可以选择yaml或者json文件,就看个人洗好了。
  • json格式的配置文件,pm2当作普通的js文件来处理,所以可以在里面添加注释或者编写代码,这对于动态调整配置很有好处。
  • 如果启动的时候指定了配置文件,那么命令行参数会被忽略。(个别参数除外,比如–env)

例子

举个简单例子,完整配置说明请参考官方文档

{
  "name"        : "fis-receiver",  // 应用名称
  "script"      : "./bin/www",  // 实际启动脚本
  "cwd"         : "./",  // 当前工作路径
  "watch": [  // 监控变化的目录,一旦变化,自动重启
    "bin",
    "routers"
  ],
  "ignore_watch" : [  // 从监控目录中排除
    "node_modules", 
    "logs",
    "public"
  ],
  "watch_options": {
    "followSymlinks": false
  },
  "error_file" : "./logs/app-err.log",  // 错误日志路径
  "out_file"   : "./logs/app-out.log",  // 普通日志路径
  "env": {
      "NODE_ENV": "production"  // 环境参数,当前指定为生产环境
  }
}

自动重启

前面已经提到了,这里贴命令行,更多点击这里

pm2 start app.js --watch

这里是监控整个项目的文件,如果只想监听指定文件和目录,建议通过配置文件的watchignore_watch字段来设置。

环境切换

在实际项目开发中,我们的应用经常需要在多个环境下部署,比如开发环境、测试环境、生产环境等。在不同环境下,有时候配置项会有差异,比如链接的数据库地址不同等。

对于这种场景,pm2也是可以很好支持的。首先通过在配置文件中通过env_xx来声明不同环境的配置,然后在启动应用时,通过--env参数指定运行的环境。

环境配置声明

首先,在配置文件中,通过env选项声明多个环境配置。简单说明下:

  • env为默认的环境配置(生产环境),env_devenv_test则分别是开发、测试环境。可以看到,不同环境下的NODE_ENVREMOTE_ADDR字段的值是不同的。
  • 在应用中,可以通过process.env.REMOTE_ADDR等来读取配置中生命的变量。
  "env": {
    "NODE_ENV": "production",
    "REMOTE_ADDR": "http://www.example.com/"
  },
  "env_dev": {
    "NODE_ENV": "development",
    "REMOTE_ADDR": "http://wdev.example.com/"
  },
  "env_test": {
    "NODE_ENV": "test",
    "REMOTE_ADDR": "http://wtest.example.com/"
  }

启动指明环境

假设通过下面启动脚本(开发环境),那么,此时process.env.REMOTE_ADDR的值就是相应的 http://wdev.example.com/ ,可以自己试验下。

pm2 start app.js --env dev

负载均衡

命令如下,表示开启三个进程。如果-i 0,则会根据机器当前核数自动开启尽可能多的进程。

pm2 start app.js -i 3 # 开启三个进程
pm2 start app.js -i max # 根据机器CPU核数,开启对应数目的进程 

参考文档:点击查看

日志查看

除了可以打开日志文件查看日志外,还可以通过pm2 logs来查看实时日志。这点对于线上问题排查非常重要。

比如某个node服务突然异常重启了,那么可以通过pm2提供的日志工具来查看实时日志,看是不是脚本出错之类导致的异常重启。

pm2 logs

指令tab补全

运行pm2 --help,可以看到pm2支持的子命令还是蛮多的,这个时候,自动完成的功能就很重要了。

运行如下命令。恭喜,已经能够通过tab自动补全了。细节可参考这里

pm2 completion install
pm2 completion >> ~/.bashrc # or ~/.zshrc

开机自动启动

可以通过pm2 startup来实现开机自启动。细节可参考。大致流程如下

  1. 通过pm2 save保存当前进程状态。
  2. 通过pm2 startup [platform]生成开机自启动的命令。(记得查看控制台输出)
  3. 将步骤2生成的命令,粘贴到控制台进行,搞定。

传入node args

直接上例子,分别是通过命令行和配置文件。

命令行:

pm2 start app.js --node-args="--harmony"

配置文件:

{
  "name" : "oc-server",
  "script" : "app.js",
  "node_args" : "--harmony"
}

实例说明

假设是在centos下,那么运行如下命令,搞定。强烈建议运行完成之后,重启机器,看是否设置成功。

[root@iZ94wb7tioqZ option_analysis]# pm2 save
[root@iZ94wb7tioqZ option_analysis]# pm2 startup centos
[PM2] Generating system init script in /etc/init.d/pm2-init.sh
[PM2] Making script booting at startup...
[PM2] /var/lock/subsys/pm2-init.sh lockfile has been added
[PM2] -centos- Using the command:
      su -c "chmod +x /etc/init.d/pm2-init.sh; chkconfig --add pm2-init.sh"
[PM2] Done.
[root@iZ94wb7tioqZ option_analysis]# pm2 save
[PM2] Dumping processes

远程部署

可参考官方文档,配置也不复杂,用到的时候再来填写这里的坑。TODO

官方文档:http://pm2.keymetrics.io/docs/usage/deployment/#getting-started

监控(monitor)


PM2 为您提供了一种简单的方法来监控应用程序的资源使用情况。您可以直接从终端轻松监控内存和 CPU:

pm2 monit

看到类似输出

[root@oneday-dev0 server]# pm2 monit 
​PM2 monitoring (To go further check out https://app.keymetrics.io) [ ] 0 % 
​PM2 monitoring (To go further check o[||||||||||||||| ] 196.285 MB 
​● fis-receiver [ ] 0 % [1] [fork_mode] [||||| ] 65.773 MB 
​● www [ ] 0 % [2] [fork_mode] [||||| ] 74.426 MB 
​● oc-server [ ] 0 % [3] [fork_mode] [|||| ] 57.801 MB 
​● pm2-http-interface [ ] stopped 
[4] [fork_mode] [ ] 0 B 
​● start-production 
[5] [fork_mode]

内存使用超过上限自动重启

如果想要你的应用,在超过使用内存上限后自动重启,那么可以加上--max-memory-restart参数。(有对应的配置项)

pm2 start big-array.js --max-memory-restart 20M

更新pm2

官方文档:http://pm2.keymetrics.io/docs/usage/update-pm2/#updating-pm2

pm2 save # 记得保存进程状态
npm install pm2 -g
pm2 update

pm2 + nginx

无非就是在nginx上做个反向代理配置,直接贴配置。

upstream my_nodejs_upstream {
    server 127.0.0.1:3001;
}
 
server {
    listen 80;
    server_name my_nodejs_server;
    root /home/www/project_root;
    
    location / {
    	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    	proxy_set_header Host $http_host;
    	proxy_set_header X-NginX-Proxy true;
    	proxy_http_version 1.1;
    	proxy_set_header Upgrade $http_upgrade;
    	proxy_set_header Connection "upgrade";
    	proxy_max_temp_file_size 0;
    	proxy_pass http://my_nodejs_upstream/;
    	proxy_redirect off;
    	proxy_read_timeout 240s;
    }
}

官方文档:http://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup

在线监控系统

收费服务,使用超级简单,可以方便的对进程的服务情况进行监控。可以试用下,地址在这里

这里贴个项目中试用的截图。

pm2编程接口

如果想把pm2的进程监控,跟其他自动化流程整合起来,pm2的编程接口就很有用了。细节可参考官方文档:
http://pm2.keymetrics.io/docs/usage/pm2-api/

模块扩展系统

pm2支持第三方扩展,比如常用的log rotate等。可参考官方文档

写在后面

pm2的文档已经写的很好了,学习成本很低,即使是没用过pm2的小伙伴,基本上照着getting started的例子就可以把项目给跑起来,所以文中不少地方都是建议直接参看官方文档。

Ubuntu 20.04 Docker 安装并配置

Docker 的使用能极大地方便我们的开发,减少环境搭建,依赖安装等繁琐且容易出错的问题。

安装 Docker

Ubuntu 20.04 官方 apt 源中就有 Docker,我们可以直接通过 apt 来安装

sudo apt update
sudo apt install docker.io
docker --version

配置

不使用 Sudo

默认情况下,普通用户没有权限执行 docker 相关操作

需要将普通用户加入到 docker 用户组,并退出 shell 重新登录,即可不使用 sudo 来运行 docker 相关操作

sudo usermod -aG docker $USER
docker info

国内源

由于 docker 默认镜像仓库在海外,所以需要配置国内源来加快镜像拉取速度

修改 /etc/docker/daemon.json (如果该文件不存在,则创建)

{
	"registry-mirrors": [
		"https://hub-mirror.c.163.com"
	]
}

内网自签源

一般内网的源都是自签证书,docker login 会报错

{
	"insecure-registries": [
		"10.0.17.100"
	]
}

重启 docker 守护进程

sudo systemctl restart docker

查看是否生效

docker info | grep -E "Registry|http"

运行 Hello World

docker run hello-world
docker ps -a

后记

按照官方的教程 Install Docker Engine on Ubuntu ,需要手动添加 Docker 源,并且包的名称为 docker-ce。

想要学习更多关于 Docker 的信息,查阅官方 Docker 文档

退出移动版