Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
B3H1Z committed Sep 27, 2023
1 parent 94a0710 commit bb6a002
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 36 deletions.
31 changes: 15 additions & 16 deletions README-FA.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,9 @@

با استفاده از این ربات می‌توانید پنل هیدیفای خود را از طریق تلگرام مدیریت کنید.

این ربات را **در همان سرور** پنل هیدیفای خود نصب کنید.

> ما در نسخه آزمایشی (BETA) هستیم و در حال بهبود آن هستیم. لطفاً اگر باگ یا مشکلی دیدید، با ما در ارتباط باشید.
لطفاً توجه داشته باشید که این ربات <b>رسمی نیست</b> و ارتباطی با تیم هیدیفای ندارد.

بعضی از ویژگی‌ها عبارتند از:
- مدیریت چند پنل
- فروش کانفیگ
- افزودن کاربران
- حذف کاربران
- ویرایش کاربران
Expand All @@ -41,6 +37,8 @@
- نمایش پیکربندی‌ها و لینک‌های اشتراک کاربر
- دریافت پشتیبان از پنل شما
- نمایش وضعیت سرور (رم، پردازنده، دیسک)
- چند زبانه (انگلیسی، فارسی)
- ربات کاربران

## نصب
برای نصب ربات دستور زیر را اجرا کنید:
Expand All @@ -54,11 +52,11 @@ sudo bash -c "$(curl -Lfo- https://raw.githubusercontent.com/B3H1Z/Hiddify-Teleg
1. `شناسه تلگرام ادمین` : آن را از ربات[ User Info Bot](https://t.me/userinfobot) بگیرید (مثال: `123456789`)
2. `توکن ربات ادمین` : آن را از ربات [BotFather](https://t.me/BotFather) بگیرید (
مثال: `1234567890:ABCdEfGhIjKlMnOpQrStUvWxYz`)
3. `آدرس پنل هیدیفای` : آدرس پنل هیدیفای خود را وارد کنید (
مثال: `https://panel.example.com/7frgemkvtE0/78854985-68dp-425c-989b-7ap0c6kr9bd4`) <b>دقیقاً مانند این الگو!</b>
4. `زبان ربات` : گزینه‌ها `en` و `fa` می‌باشند [پیش‌فرض `fa`]
5. `توکن ربات کاربران(اختیاری)` : آن را از ربات [BotFather](https://t.me/BotFather) بگیرید (
3. `توکن ربات کاربران` : آن را از ربات [BotFather](https://t.me/BotFather) بگیرید (
مثال: `1234567890:ABCdEfGhIjKlMnOpQrStUvWxYz`)
4. `آدرس پنل هیدیفای` : آدرس پنل هیدیفای خود را وارد کنید (
مثال: `https://panel.example.com/7frgemkvtE0/78854985-68dp-425c-989b-7ap0c6kr9bd4`)
5. `زبان ربات` : گزینه‌ها `en` و `fa` می‌باشند [پیش‌فرض `fa`]

حالا می‌توانید با ارسال دستور `/start` از ربات در تلگرام استفاده کنید.

Expand All @@ -77,22 +75,23 @@ cd /opt/Hiddify-Telegram-Bot/ && chmod +x restart.sh && ./restart.sh
```bash
pkill -9 -f hiddifyTelegramBot.py
```
دریافت لاگ های ربات
مشاهده لاگ های ربات
```bash
cat /opt/Hiddify-Telegram-Bot/Logs/hidyBot.log
```
اطلاعات پیکربندی ربات
```bash
cat /opt/Hiddify-Telegram-Bot/config.json
```
تغییر پیکربندی ربات
مشاهده و تغییر پیکربندی ربات
```bash
cd /opt/Hiddify-Telegram-Bot/ && python3 config.py && chmod +x restart.sh && ./restart.sh
```
نصب مجدد ربات
```bash
cd /opt/ && rm -rf /opt/Hiddify-Telegram-Bot/ && sudo bash -c "$(curl -Lfo- https://raw.githubusercontent.com/B3H1Z/Hiddify-Telegram-Bot/main/install.sh)"
```
حذف ربات
```bash
cd /opt/Hiddify-Telegram-Bot/ && chmod +x uninstall.sh && ./uninstall.sh
```

## اسکرین شات‌ها
#### ربات کاربران
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-u-1.jpg?raw=True" width=35% height=35%>
Expand Down
34 changes: 14 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,9 @@

Hidy Bot is a Telegram bot that allows you to manage your Hiddify panel directly from Telegram.

Install Hidy Bot on the **SAME SERVER** as your Hiddify panel.

**Please note:** This project is currently in BETA, and we are actively working to make it even better. If you encounter any bugs or issues, we appreciate your feedback and bug reports.

> Disclaimer: This bot is **not official** and is not affiliated with Hiddify team.
## Features
- [x] Multi panel support
- [x] Sell config
- [x] Add users
- [x] Remove users
- [x] Edit user details
Expand All @@ -34,8 +30,7 @@ Install Hidy Bot on the **SAME SERVER** as your Hiddify panel.
- [x] Multi language (English, Persian)
- [x] Client bot
- [x] and more...
## To do list
- [ ] Empty

## Installation

To install the bot, run the following command:
Expand All @@ -50,12 +45,11 @@ Make sure you have the following information ready:
1. `Admin Telegram Number ID` : Get it from [User info bot](https://t.me/userinfobot) (Example: `123456789`)
2. `Admin Telgram Bot Token` : Get it from [BotFather](https://t.me/BotFather) (
Example: `1234567890:ABCdEfGhIjKlMnOpQrStUvWxYz`)
3. `Hiddify Panel URL` : The url of your Hiddify panel (
Example: `https://panel.example.com/7frgemkvtE0/78854985-68dp-425c-989b-7ap0c6kr9bd4`) <b>exactly like this
pattern!</b>
4. `Bot Language` : Options are `en` and `fa` [default is `fa`]
5. Optional: `Client(Users) Telegram Bot Token` : Get it from [BotFather](https://t.me/BotFather) (
Example: `1234567890:ABCdEfGhIjKlMnOpQrStUvWxYz`) if you want set up a bot for your users
3. `Client Telegram Bot Token` : Get it from [BotFather](https://t.me/BotFather) (
Example: `1234567890:ABCdEfGhIjKlMnOpQrStUvWxYz`)
4. `Hiddify Panel URL` : The url of your Hiddify panel (
Example: `https://panel.example.com/7frgemkvtE0/78854985-68dp-425c-989b-7ap0c6kr9bd4`)
5. `Bot Language` : Options are `en` and `fa` [default is `fa`]


Now you can use the bot in Telegram by sending the `/start` command.
Expand All @@ -80,18 +74,18 @@ pkill -9 -f hiddifyTelegramBot.py
```bash
cat /opt/Hiddify-Telegram-Bot/Logs/hidyBot.log
```
- ### Get bot configs
```bash
cat /opt/Hiddify-Telegram-Bot/config.json
```
- ### Change bot configs
- ### Edit bot configs
```bash
cd /opt/Hiddify-Telegram-Bot/ && python3 config.py && chmod +x restart.sh && ./restart.sh
```
- ### Reinstall bot
```bash
cd /opt/ && rm -rf /opt/Hiddify-Telegram-Bot/ && sudo bash -c "$(curl -Lfo- https://raw.githubusercontent.com/B3H1Z/Hiddify-Telegram-Bot/main/install.sh)"
```
- ### Uninstall bot
```bash
cd /opt/Hiddify-Telegram-Bot/ && chmod +x uninstall.sh && ./uninstall.sh
```

## Screenshots
#### Users Bot
Expand All @@ -107,4 +101,4 @@ cd /opt/ && rm -rf /opt/Hiddify-Telegram-Bot/ && sudo bash -c "$(curl -Lfo- http
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-a-5.jpg?raw=True" width=35% height=35%>
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-a-3.jpg?raw=True" width=35% height=35%>
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-a-4.jpg?raw=True" width=35% height=35%>
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-a-7.jpg?raw=True" width=35% height=35%>
- <img src="https://github.com/B3H1Z/Hiddify-Telegram-Bot/blob/main/Screenshots/scr-a-7.jpg?raw=True" width=35% height=35%>

0 comments on commit bb6a002

Please sign in to comment.