快速开始

关注微信服务号

在文档首页有二维码了，这里再贴一次吧，如果关注了请继续后边的步骤。

关注后，输入help或者帮助看看一切是否正常。

主动发送通知

给自己发消息是最常用的功能， 在服务号发送 token 命令查看自己的用户 token 。

使用用户 token，您就可以用 API 向公众号发警告消息了：

curl "https://api.letserver.run/message/info?token=YOUR-TOKEN&msg=hello"

PS. 这个 GET 接口是为了调试和轻量使用场景的，在程序中使用的话有更完善的 POST 接口，SDK 也支持主动发消息。

反向控制原理

发送通知的服务很多，Server饭 的特色功能是反向用微信控制服务器做简单的事情。 放心，不需要你提供ssh密钥，为了安全，命令能做什么完全由你定义。

下面是反向控制的大概原理：

graph LR
  IM(服务号对话) --> c{{Server饭}}
  c -- 拉取命令 --> a(Agent)
  a -- 返回结果 --> c
  c --> IM

第一个 Agent

通过命令agent add 它的名字增加一个 Agent。
通过status命令，可以看到你加的这个 Agent 在离线状态。一个 Agent 如果三分钟以上没有心跳就会离线。

我们先使用一个 开源的通用 Agent来上手。
它可以帮你在服务器执行特定的命令。后面我们可以根据需求，自己通过 API 或 SDK，集成 Agent 或自己编写。

假设你的服务器是 Debian/Ubuntu ,如果是别的请参考 安装通用Agent
如果您本身就是 root 用户，麻烦去掉所有命令中的 sudo

# 注册仓库
curl -1sLf \
  'https://dl.cloudsmith.io/public/hackfan/skadi/setup.deb.sh' \
  | sudo -E bash
# 更新
apt update
# 安装
apt install skadi

在安装后，因为还没有 Token，所以并没有自动启动。 我们用 skadi 把之前公众号添加 Agent 得到的 Token 写入配置文件。 你也可以编辑 /etc/skadi/skadi.yml 这个文件自己写入。

# 写入 Token
sudo skadi AGENT-TOKEN
# 启动服务
sudo systemctl start

只有第一次需要配置Token后手动启动服务，服务器重启它是会依靠systemd自己启动的。

试用 Agent

在公众号输入 它的名字 help ，在一分钟之内，命令会被Agent拉走并返回结果。
这个官方的通用 Agent 功能由你部署它的服务器上的 /etc/skadi/skadi.yml 这个配置文件定义。

然后你可以顺次输入名字 date,名字 lsroot,名字 free -m,名字 Hi Fool, 去试用，接下来，更改配置文件就可以完成重启服务，查看状态等简单的动作了。

# 调试模式，打开可以看到更多日志，使用 journalctl -u skadi 查看日志
debug: false
# 可以直接填写token到这里，或者用 skadi TOKEN 命令去写入
token:
# shortcuts 将一个单词精确的翻译为一条命令
# short: 你在公众号输入的消息
# dir: 命令的工作目录，可选。有的命令不需要工作目录就不填。
# cmd: 精确的命令。
shortcuts:
  - short: date
    cmd: "date --rfc-3339=second"
  - short: lsroot
    dir: /
    cmd: ls
# commands 是一个命令白名单，这里列出命令，在公众号使用时可以随意加参数。
# dir: 命令的工作目录，可选。有的命令不需要工作目录就不填。
# prefix: 允许的命令，比如这里允许free，实际使用时可以输入 free -k
commands:
  - prefix: free
# templates 是一个模板引擎，可以预留参数，调用时只用输入参数
# name: 调用时接在 Agent 名称后的第一个词
# dir: 命令的工作目录，可选。有的命令不需要工作目录就不填。
# temp: 模板，用的 golang 的模板引擎
# 示例 name:"Hi" temp:"echo I am not %s!"
# 在公众号输入 [Hi 傻瓜] 会收到结果 [I am not 傻瓜!]
templates:
  - name: Hi
    temp: "echo I am not %s!"

修改完配置文件后，用命令重启服务，它们就生效了。

sudo systemctl restart skadi

编写自己的 Agent

如果是控制集群重启之类的，使用我们的 Agent 就够用了。

如果想实现更多的功能，可能需要你自己根据开放接口写一个 Agent 。

甚至直接在服务中集成一个 Agent 实例，就可以把微信当作简单的业务控制台了。