Skip to content

Commit 4f8fdd4

Browse files
authored
update readme
更换新的下载地址,及支持TSL的二进制包
1 parent c156445 commit 4f8fdd4

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,24 @@ mail-provider
55

66
## 安装方法
77

8-
1.二进制安装(推荐)
8+
1.二进制安装(推荐)
9+
sha256sum
10+
```bash
11+
7f714c8e4542670833505c274c420be1c89c5247dd8c72121cf0baa1d33edd49 falcon-mail-provider.tar.gz
12+
```
13+
914
下载编译好的二进制
1015
```bash
11-
wget https://dl.cactifans.com/open-falcon/mail-provider.tar.gz
12-
mkdir -p mail-provider
13-
tar zxvf mail-provider.tar.gz -C mail-provider
14-
cd mail-provider
16+
wget https://dl.cactifans.com/open-falcon/falcon-mail-provider.tar.gz
17+
mkdir -p falcon-mail-provider
18+
tar zxvf falcon-mail-provider.tar.gz -C falcon-mail-provider
19+
cd falcon-mail-provider
1520
```
1621
修改cfg.json文件相关信息,使用
1722
```bash
1823
./control start
1924
```
20-
即可启动客户端
25+
即可启动
2126

2227
2.源码编译(如无科学上网方法,请勿尝试)
2328
下载之后为源码,安装golang环境,环境配置参考[golang环境配置](http://book.open-falcon.org/zh/quick_install/prepare.html)
@@ -35,21 +40,32 @@ go get ./...
3540
```bash
3641
./control start
3742
```
38-
即可启动
43+
即可启动
3944

4045

4146
## 使用方法
42-
43-
测试发送
47+
启动之后使用以下命令测试:
4448
```
45-
curl http://$ip:4000/sender/mail -d "tos=a@a.com,b@b.com&subject=xx&content=yy"
49+
curl http://127.0.0.1:4000/sender/mail -d "tos=a@a.com,b@b.com&subject=xx&content=yy"
4650
```
47-
在Alarm组件里修改配置mail地址为
51+
是否能收到邮件,如收到邮件,表示配置成功,如未收到邮件,使用
52+
```bash
53+
./control tail
4854
```
49-
"mail": "http://127.0.0.1:4000/sender/mail",
55+
查看日志。
56+
在Alarm组件的配置文件里,配置对应地址即可
57+
```json
58+
...
59+
"api": {
60+
...
61+
"mail": "http://127.0.0.1:4000/sender/mail",
62+
...
63+
},
64+
...
5065
```
66+
5167
## FAQ
5268

53-
1.此插件目前不支持smtp SSL协议
69+
1.如使用自建邮件系统请设置 skipVerify 为 true 以避免证书校验错误,即使未开启TLS。(因为默认会尝试StartTLS)
5470

5571
2.对于126.163等邮箱请控制发信频率以免被封

0 commit comments

Comments
 (0)