mirror of
https://github.com/rainerosion/E5SubBotForSQLite.git
synced 2026-06-02 16:43:43 +08:00
:docs: Add english document
This commit is contained in:
rainerosion
parent
ef8bfd1f8e
commit
5e28904491
160
README.md
Normal file
160
README.md
Normal file
@ -0,0 +1,160 @@
|
||||
# E5SubBot For SQLite
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
English | [简体中文](https://github.com/iyear/E5SubBot/blob/master/README_zhCN.md)
|
||||
|
||||
A Simple Telebot for E5 Renewal
|
||||
|
||||
`Golang` + `SQLite`
|
||||
|
||||
DEMO: https://t.me/raindev_bot (This DEMO is for testing only)
|
||||
|
||||
Communication: [Telegram Group](https://t.me/e5subbot)
|
||||
## Introduction
|
||||
The project was modified from [iyear/E5SubBot](https://github.com/iyear/E5SubBot).
|
||||
|
||||
|
||||
## 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](https://docs.microsoft.com/en-us/graph/api/user-list-messages?view=graph-rest-1.0&tabs=http) 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](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channel-connect-telegram?view=azure-bot-service-4.0)
|
||||
|
||||
### Binary Deployment
|
||||
|
||||
Download the binary files of the corresponding system on the [Releases](https://github.com/rainerosion/E5SubBot/releases) page and upload it to the server
|
||||
|
||||
Windows: Start `E5SubBot.exe` in `cmd`
|
||||
|
||||
Linux:
|
||||
|
||||
```bash
|
||||
chmod a+x E5SubBot
|
||||
nohup ./E5SubBot > /tmp/e5sub.log &
|
||||
```
|
||||
Linux Systemd:
|
||||
|
||||
- Edit service file
|
||||
|
||||
```bash
|
||||
vim /etc/systemd/system/e5sub.service
|
||||
```
|
||||
|
||||
- Copy the following text
|
||||
|
||||
```reStructuredText
|
||||
[Unit]
|
||||
Description=Telegram E5Sub Bot
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
WorkingDirectory=/opt/e5sub
|
||||
ExecStart=/opt/e5sub/E5SubBot
|
||||
Restart=always
|
||||
RestartSec=30
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
- Start service
|
||||
|
||||
```bash
|
||||
# Load configuration file
|
||||
systemctl daemon-reload
|
||||
# Start up automatically
|
||||
systemctl enable e5sub
|
||||
# Start service
|
||||
systemctl start e5sub
|
||||
```
|
||||
|
||||
### Compile
|
||||
|
||||
Download the source code and install the GO environment
|
||||
|
||||
```shell
|
||||
go env -w CGO_ENABLED=1
|
||||
go build
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Create `config.yml` in the same directory, encoded as `UTF-8`
|
||||
|
||||
Configuration Template:
|
||||
|
||||
```yaml
|
||||
bot_token: YOUR_BOT_TOKEN
|
||||
socks5: 127.0.0.1:1080
|
||||
notice: "first line\nsecond line"
|
||||
admin: 66666,77777,88888
|
||||
errlimit: 5
|
||||
cron: "1 */3 * * *"
|
||||
bindmax: 3
|
||||
dbfile: "e5sub.db"
|
||||
```
|
||||
|
||||
`bindmax`, `notice`, `admin`, `errlimit` can be hot updated, just update `config.yml` to save.
|
||||
| Configuration | Explanation|
|
||||
| ---- | ---- |
|
||||
| bot_token | Change to your own `BotToken` |
|
||||
| socks5 | `Socks5` proxy,if you do not need ,you should delete it. For example: `127.0.0.1:1080` |
|
||||
|notice|Announcement. Merged into `/help`|
|
||||
|admin|The administrator's `tgid`, go to https://t.me/userinfobot to get it, separated by `,`; Administrator permissions: manually call the task, get the total feedback of the task|
|
||||
|errlimit|The maximum number of errors for a single account, automatically unbind the single account and send a notification when it is full, without limiting the number of errors, change the value to a negative number `(-1)`; all errors will be cleared after the bot restarts|
|
||||
|cron|API call frequency, using `cron` expression|
|
||||
|bindmax|Maximum number of bindable|
|
||||
|dbfile|Database file|
|
||||
|
||||
### 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
|
||||
> Feedback time is not as expected
|
||||
|
||||
Change the server time zone, use `/task` to manually perform a task to refresh time.
|
||||
|
||||
> Long running crash
|
||||
|
||||
Suspected memory leak. Not yet resolved, please run the daemon or restart Bot regularly.
|
||||
|
||||
> Unable to create application via bot
|
||||
|
||||
https://t.me/e5subbot/5201
|
||||
|
||||
## License
|
||||
|
||||
GPLv3
|
||||
Loading…
Reference in New Issue
Block a user