aiastia/e5sub repository overview

⁠E5SubBot

English | 简体中文⁠

A Simple Telebot for E5 Renewal

Golang + MySQL

DEMO: https://t.me/E5Sub_bot⁠ (all new functions will be tested in DEMO)

Communication: Telegram Group⁠

⁠Preview

⁠Feature

• Automatically Renew E5 Subscription(Customizable Frequency)
• Manageable Simple Account System
• Available Task Execution Feedback
• Convenient Authorization

⁠Principle

E5 subscription is a subscription for developers, as long as the related API is called, it may be renewed

Calling Outlook ReadMail API⁠ to renew, does not guarantee the renewal effect.

⁠Usage

1. Type /bind in the robot dialog
2. Click the link sent by the robot and register the Microsoft application, log in with the E5 master account or the same domain account, and obtain client_secret. Click to go back to Quick Start, get client_id
3. Copy client_secret and client_id and reply to bot in the format of client_id(space)client_secret (Pay attention to spaces)
4. Click on the authorization link sent by the robot and log in with the E5 master account or the same domain account
5. After authorization, it will jump to http://localhost/e5sub…… (will prompt webpage error, just copy the link)
6. Copy the link, and reply link(space)alias (used to manage accounts) in the robot dialog For example: http://localhost/e5sub/?code=abcd MyE5, wait for the robot to bind and then complete

⁠Deploy Your Own Bot

Bot creation tutorial : Microsoft⁠

⁠Docker Deployment

Thanks to @kzw200015⁠ for providing help in Dockerfile and Docker

If it fails to start for the first time, use docker-compose restart to restart

mkdir ./e5bot && wget --no-check-certificate -O ./e5bot/config.yml https://raw.githubusercontent.com/iyear/E5SubBot/master/config.yml.example
vi ./e5bot/config.yml
wget --no-check-certificate https://raw.githubusercontent.com/iyear/E5SubBot/master/docker-compose.yml
docker-compose up -d

⁠Binary Deployment

Download the binary files of the corresponding system on the Releases⁠ page and upload it to the server

Windows: Start E5SubBot.exe in cmd

Linux:

screen -S e5sub
chmod 773 E5SubBot
./E5SubBot
(Ctrl A+D)

⁠Compile

Download the source code and install the GO environment

go build

⁠Configuration

Create config.yml in the same directory, encoded as UTF-8

Configuration Template:

bot_token: YOUR_BOT_TOKEN
socks5: 127.0.0.1:1080
notice: "first line \n second line"
admin: 66666,77777,88888
errlimit: 5
cron: "1 */3 * * *"
bindmax: 3
mysql:
  host: 127.0.0.1
  port: 3306
  user: e5sub
  password: e5sub
  database: e5sub

bindmax, notice, admin, errlimit can be hot updated, just update config.yml to save.

⁠Command

/my View bound account information
/bind Bind new account
/unbind Unbind account
/export Export account information (JSON format)
/help help
/task Manually execute a task (Bot Administrator)
/log Get the most recent log file (Bot Administrator)

⁠Others

Change the server time zone, use /task to manually perform a task to refresh time.

Failure to close db leads to triggering mysql concurrency limit, please update to v0.1.9.

Suspected memory leak. Not yet resolved, please run the daemon or restart Bot regularly.

https://t.me/e5subbot/5201⁠

⁠Third-Party

• Telebot⁠
• Mysql_driver⁠
• Gjson⁠
• Cron⁠
• Viper⁠
• Goreleaser⁠

⁠Contributing

• Provide documentation in other languages
• Provide help for code operation
• Suggests user interaction
• ……

⁠More Functions

If you still want to support new features, please use FeatHub to vote. We will consider the voting results and other factors to determine the development priority.

⁠License

GPLv3