freenom/README_EN.md

[](https://s4.ax1x.com/2022/02/23/b9s5U1.png)

Freenom：Auto-renewal of freenom domain names.

[](https://secure.php.net/) [](https://scrutinizer-ci.com/g/luolongfei/freenom/?branch=master) [](https://github.com/luolongfei/freenom/stargazers) [](https://github.com/luolongfei/freenom/blob/main/LICENSE) Documentation: English version | [中文版](https://github.com/luolongfei/freenom)

📃 Why write this script

🍭 Demo

🎁 Preparation

📪 Setting up Gmail

🤶 Telegram bot

🚧 Configuration script

🎈 Add scheduled task

☕ Verification

❤ Donation

🌚 Author

🎉 Acknowledgements

🥝 Open source agreement

📃 Why write this script

As we all know, Freenom is the only merchant on the planet that provides free top-level domain names, but it needs to be renewed every year for up to one year at a time. Since I applied for a bunch of domain names, and not at the same time, So I felt frustrated every time I renewed, so I wrote this automatic renewal script.

🍭 Demo

Regardless of the success or failure of the renewal or the execution of the script, you will receive emails from the program. In the case of a renewal success or failure email, the email will include the number of days that the domain name has not been renewed.

🎁 Preparation

• Email of robot: Used to send notification emails.
• Your email: Used to receive notification emails sent by robots.
• VPS: Any server can be used. The system recommends Debian, and the PHP version must bephp7.3 or above.
• No more

📪 Setting up Gmail

---

1.In Settings > Forwarding and POP/IMAP, tick

• Enable POP for all messages
• Enable IMAP

Then save your changes.

2.Allow less secure applications

It is recommended that you turn on your browser's privacy mode before logging into gmail to set up your settings, to prevent you from not being able to jump to the correct settings address when you have multiple gmail accounts.

After logging into Google Mail, visit this page and enable the application that is not secure enough.

Also, if prompted

Do not allow access to account

After logging in to Google Mail, go to this page and click Allow. This situation is relatively rare.

Note: Since using gmail directly password to sign in easily triggers Google security mechanism, so we recommend to refer to the official document to enable the application-specific password: https://support.google.com/mail/answer/185833

Sign in with an account+application-specific password, so you won't trigger Google security restrictions even if you change your IP frequently to sign in to gmail.

After the above operation is finished, set MAIL_USERNAME and MAIL_PASSWORD to your mailbox and password (or token) in .env file, set TO to your incoming mailbox, and then set the value of MAIL_ENABLE to 1 to enable the mailbox delivery function.

If you don't want to use email related features, change the value of MAIL_ENABLE in the .env file in the root directory to 0 to turn off the email push method.

🤶 Telegram bot

---

If you don't want to use email push, you can also use Telegram bot. In the .env file, Change the value of TELEGRAM_BOT_ENABLE to 1 to enable the Telegram bot. Similarly, change the value of MAIL_ENABLE to 0 to disable the mail push method. Telegram bot has two configuration items, one is chat_id (corresponding to TELEGRAM_CHAT_ID in .env file), You can get your own id by sending /start to @userinfobot using your Telegram account, The other is token (corresponding to TELEGRAM_BOT_TOKEN in the .env file), your Telegram bot token, how to create a Telegram bot and how to get the token please refer to: Official Document

This completes the settings related to notifications, followed by the configuration related to this program :)

🚧 Configuration script

All operations are performed under Centos7 system, other Linux distributions are similar

Get the source code

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

# clone the repository source
$ git clone https://github.com/luolongfei/freenom.git ./

Configuration process

# Copy configuration file template
$ cp .env.example .env

# Edit configuration file
$ vim .env

# .env Each item in the file has a detailed description, which will not be repeated here. In short, you need to change all the items in it to your own. Note the format of the multi-account configuration:
# e.g. MULTIPLE_ACCOUNTS='<account1>@<password1>|<account2>@<password2>|<account3>@<password3>'
# Of course, if you only have a single account, you only need to configure FREEENOM_USERNAME and FREEENOM_PASSWORD. The configurations of single account and multiple accounts will be read together and duplicated.

# After editing, press "Esc" to return to the command mode, enter ":wq" and press Enter to save and exit. If you don't use vim editor, you can ask Uncle Google. :)

🎈 Add scheduled task

Install crontabs and cronie

$ yum -y install cronie crontabs

# Verify if crond is installed and started
$ yum list cronie && systemctl status crond

# Verify that crontab is installed
$ yum list crontabs $$ which crontab && crontab -l

Open the task form and edit

$ crontab -e

# Task content is as follows
# The meaning of this task is to execute the run file under /data/wwwroot/freenom/ at 9 AM every day
# Note: In some cases, crontab may not find your php path. The following command will output an error message in the freenom_crontab.log file. You should specify the php path: replace the following php with /usr/local/php/bin/php (based on the actual situation)
00 09 * * * cd /data/wwwroot/freenom/ && php run > freenom_crontab.log 2>&1

Restart the crond daemon (This step is required each time you edit the task form for the task to take effect)

$ systemctl restart crond

To check if the Task is normal, you can set the execution time of the above task to a few minutes, and then wait until the task execution is completed, check the contents of the freenom_crontab.log file in the /data/wwwroot/freenom/ directory for errors. Common error messages are as follows:

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

(Click to expand or collapse)

<summary>solution</summary>

execute

> $ whereis php
> # Determine the location of php, the general output is "php: /usr/local/php /usr/local/php/bin/php", we choose: /usr/local/php/bin/php
> ```
> Now we know that php's path is `/usr/local/php/bin/php` (may be different according to the actual situation of your own system),
> and then modify the commands in the form task, change
>
> `00 09 * * * cd /data/wwwroot/freenom/ && php run > freenom_crontab.log 2>&1`
>
> to
>
> `00 09 * * * cd /data/wwwroot/freenom/ && /usr/local/php/bin/php run > freenom_crontab.log 2>&1`
>
> More information: [click here](https://stackoverflow.com/questions/7397469/why-is-crontab-not-executing-my-php-script)
>

</details>

Of course, if your `crontab` can correctly find the `php path` without error, you don't need to do anything.

*So far, all the configurations have been completed, let's verify if the whole process works* :)

### ☕ Verification

You can first change the value of `NOTICE_FREQ` in `.env` to 1 (Push notification every time the script is executed),
and then execute

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

If nothing else, you will receive an email about the domain name.

If you encounter any problems or bugs, please mention issues. If freenom changes the algorithm and causes this project to fail, Please mention issues to inform me that I will fix it in time and maintain this project for a long time. Welcome star ~

❤ Donation

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

🌚 Author

• Main program and framework: @luolongfei
• English document: @肖阿姨

🎉 Acknowledgements

• PHPMailer (Mail sending function depends on this library)
• guzzle (Curl library)

🥝 Open source agreement

MIT