22

Github GitHub - luolongfei/freenom: Freenom域名自动续期。Freenom domain name ren...

 3 years ago
source link: https://github.com/luolongfei/freenom
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

Freenom:freenom域名自动续期

Documentation: English version | 中文版

page_with_curl 前言

众所周知,Freenom是地球上唯一一个提供免费顶级域名的商家,不过需要每年续期,每次续期最多一年。由于我申请了一堆域名,而且不是同一时段申请的, 所以每次续期都觉得折腾,于是就写了这个自动续期的脚本。

lollipop 效果

无论是续期成败或者脚本执行出错,都会收到的程序发出的邮件。如果是续期成败相关的邮件,邮件会包括未续期域名的到期天数等内容。 邮件参考了微信发送的注销公众号的邮件样式。

gift 事前准备

  • 发信邮箱:为了方便理解又称机器人邮箱,用于发送通知邮件。目前支持GmailQQ邮箱以及163邮箱,程序会自动判断发信邮箱类型并使用合适的配置。推荐使用Gmail
  • 收信邮箱:用于接收机器人发出的通知邮件。推荐使用QQ邮箱QQ邮箱唯一的好处只是收到邮件会在QQ弹出消息。
  • VPS:随便一台服务器都行,系统推荐Centos7,另外PHP版本需在php7.1及以上。(注:没有 VPS 也行,本项目支持在 Github Actions 上执行,完全白嫖,具体使用方法请参考「 」)

mailbox_closed 配置发信邮箱

下面分别介绍GmailQQ邮箱以及163邮箱的设置,你只用看自己需要的部分。注意,QQ邮箱163邮箱均使用账户加授权码的方式登录, 谷歌邮箱使用账户加密码的方式登录,请知悉。另外还想吐槽一下,国产邮箱你得花一毛钱给邮箱提供方发一条短信才能拿到授权码。

(点击即可展开或收起)

设置Gmail
设置QQ邮箱
设置163邮箱

Telegram bot

上面介绍了三种邮箱的设置方法,如果你不想使用邮件推送,也可以使用 Telegram bot,灵活配置。在.env文件中, 将TELEGRAM_BOT_ENABLE的值改为true,即可启用 Telegram bot,同样的,将MAIL_ENABLE的值改为false即可关闭邮件推送方式。 Telegram bot 有两个配置项,一个是chatID(对应.env文件中的TELEGRAM_CHAT_ID), 通过使用你的 Telegram 账户发送/start@userinfobot即可以获取自己的id, 另一个是token(对应.env文件中的TELEGRAM_BOT_TOKEN),你的 Telegram bot 令牌,你会创建 Telegram bot 就知道怎么获取, 不多赘述。如何创建一个 Telegram bot 请参考:官方文档


与通知相关的设置到此就完成了,下面可以愉快的配置本程序了 :)

construction 配置脚本

所有操作均在Centos7系统下进行,其它Linux发行版大同小异

$ mkdir -p /data/wwwroot/freenom
$ cd /data/wwwroot/freenom

# clone本仓库源码
$ git clone https://github.com/luolongfei/freenom.git ./
# 复制配置文件模板
$ cp .env.example .env

# 编辑配置文件
$ vim .env

# .env文件里每个项目都有详细的说明,这里不再赘述,简言之,你需要把里面所有项都改成你自己的。需要注意的是多账户配置的格式:
# e.g. MULTIPLE_ACCOUNTS='<账户1>@<密码1>|<账户2>@<密码2>|<账户3>@<密码3>'
# 当然,若你只有单个账户,只配置FREENOM_USERNAME和FREENOM_PASSWORD就够了,单账户和多账户的配置会被合并在一起读取并去重。

# 编辑完成后,按“Esc”回到命令模式,输入“:wq”回车即保存并退出,不会用vim编辑器的问下谷歌大爷:)

balloon 添加计划任务

安装crontabs以及cronie

$ yum -y install cronie crontabs

# 验证crond是否安装及启动
$ yum list cronie && systemctl status crond

# 验证crontab是否安装
$ yum list crontabs $$ which crontab && crontab -l

打开任务表单,并编辑

$ crontab -e

# 任务内容如下
# 此任务的含义是在每天早上9点执行/data/wwwroot/freenom/路径下的run文件
# 注意:某些情况下,crontab可能找不到你的php路径,下面的命令执行后会在freenom_crontab.log文件输出错误信息,你应该指定php路径:把下面的php替换为/usr/local/php/bin/php(根据实际情况)
00 09 * * * cd /data/wwwroot/freenom/ && php run > freenom_crontab.log 2>&1

重启crond守护进程(每次编辑任务表单后都需此步,以使任务生效)

$ systemctl restart crond

若要检查计划任务是否正常,你可以将上面的任务执行时间设置在几分钟后,然后等到任务执行完成, 检查/data/wwwroot/freenom/目录下的freenom_crontab.log文件内容,是否有报错信息。常见的错误信息如下:

  • /bin/sh: php: command not found
  • /bin/sh: /usr/local/php: Is a directory

(点击即可展开或收起)

解决方案

当然,如果你的计划任务能正确找到php路径,没有错误,那你什么也不用做。

至此,所有的配置都已经完成,下面我们验证一下整个流程是否走通:)

coffee 验证

你可以先将.env中的NOTICE_FREQ的值改为1(即每次执行都推送通知),然后执行

$ cd /data/wwwroot/freenom/ && php run

不出意外的话,你将收到一封关于域名情况的邮件。


rofl 本项目最简单的使用方法

上面说了一堆都是基于你有自己的VPS的情况下,如果没有VPS又想自动续期Freenom的域名,或者单纯不想配置那么多东西, 可以直接在Github Actions上跑本项目,Github Actions会为项目创建一个虚拟环境,并在执行后自动销毁。

只需简单 6 步

1、Fork 本仓库

2、在你 Fork 的本仓库下的 Settings -> Secrets 页面追加以下几个secret秘密环境变量

点我查看需要添加的具体秘密变量

3、同意启用 Actions

4、同意启用 Actions 后,参照下图,重新启用 scheduled workflows,即工作流程的计划任务

根据 官方文档When a public repository is forked, scheduled workflows are disabled by default. 故必须有此步骤才能让 fork 的仓库的 Github Actions 的定时任务生效。

5、查看执行详情

6、心里默念作者最帅,给个star并把本项目推荐给更多的人,用的人越多作者更新的动力越足

好了,做完上面六步后就不需要其它任何操作了。现在每天上午十点左右Github Actions会自动触发执行本项目,注意查收域名相关邮件。


遇到任何问题或 Bug 欢迎提 issues (请按模板格式提issues,以便作者更快复现你的问题), 如果Freenom改变算法导致此项目失效,请提 issues 告知,我会及时修复,本项目长期维护。 欢迎star~

beer 信仰

认真是我们参与这个社会的方式,认真是我们改变这个社会的方式。 ——李志

heart 捐赠 Donate

如果你觉得本项目真的有帮助到你并且想回馈作者,感谢你的捐赠。

PayPal: https://www.paypal.me/mybsdc

Every time you spend money, you're casting a vote for the kind of world you want. -- Anna Lappe

你的star或者小额打赏是我长期维护此项目的动力所在,由衷感谢每一位支持者,“每一次你花的钱都是在为你想要的世界投票”。

clipboard 捐赠名单 Donate List

非常感谢「 这些用户 」对本项目的捐赠支持!

new_moon_with_face 作者

tada 鸣谢

kiwi_fruit 开源协议

MIT


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK