Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
XRaySup authored Apr 7, 2024
1 parent b94db39 commit 058c187
Show file tree
Hide file tree
Showing 25 changed files with 145 additions and 44 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 💦 BPB Panel

![Panel](docs/assets/Panel.png)
![Panel](docs/assets/images/Panel.png)

<div dir="rtl">
<a href="README_fa.md">Farsi</a>
Expand Down Expand Up @@ -29,9 +29,11 @@ This project is dedicated to developing a user panel for the [Cloudflare-workers
---

## How to use:
[Installation](docs/installation_fa.md)
[Installation (Pages)](docs/pages_installation_fa.md)

[Configuration](docs/configuration_fa.md)
[Installation (Worker)](docs/worker_installation_fa.md)

[how to use](docs/configuration_fa.md)

[Troubleshooting](docs/troubleshooting.md)

Expand Down
8 changes: 5 additions & 3 deletions README_fa.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 💦 پنل BPB

![Panel](docs/assets/Panel.png)
![Panel](docs/assets/images/Panel.png)

<div dir="rtl">
<a href="README.md">English</a>
Expand Down Expand Up @@ -48,9 +48,11 @@
---

## استفاده
[نصب](docs/installation_fa.md)
[نصب به صورت Pages](docs/pages_installation_fa.md)

[پیکربندی](docs/configuration.md)
[نصب به صورت Worker](docs/worker_installation_fa.md)

[نحوه استفاده از پنل](docs/configuration.md)

[رفع اشکال](docs/troubleshooting.md)

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/assets/images/IP_Proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/assets/images/clean_ip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/desktop_fragment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/fragment_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/mobile_fragment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/navigate_worker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/panel_fragment_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
32 changes: 11 additions & 21 deletions docs/configuration_fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,17 @@

### 1- کانفیگ های نرمال (بدون فرگمنت)

![Normal Configs](assets/Normal_config.png)
![Normal Configs](assets/images/Normal_config.png)

از این بخش شروع کردم چون خیلیا بدون فرگمنت هم میتونن استفاده کنن.

این بخش لینک سابسکریپشن کانفیگای معمولی Worker رو میده (بدون Fragment). بر اساس کلاینت خودتون لینک رو بردارید و اسنفاده کنید.
این بخش لینک اشتراک کانفیگ‌های معمولی Worker رو میده (بدون Fragment). بر اساس کلاینت خودتون لینک رو بردارید و اسنفاده کنید.

این لینک 6 تا کانفیگ بهتون میده. (از بخش تنظیمات IP تمیز میتونید تعداد کانفیگها رو زیاد کنید) حالا فرق این 6 تا کانفیگ چیه؟ چطور میشه تعدادشون رو اضافه کرد؟ توضیحات و تنظیمات بیشتر رو [اینجا](#تنظیمات-ip-تمیز) توضیح دادیم.

**نکته مهم:** برای استفاده از این کانفیگ ها Mux رو از تنظیمات هر اپلیکیشنی که استفاده میکنید خاموش کنید.

**اخطار:** با استفاده از این Worker مرتب IP دیوایس شما تغییر میکنه، بنابراین برای کارهایی مثل ترید و PayPal و حتی سایتهایی مثل Hetzner که حساس هستن ازش استفاده نکنید، امکان Ban شدن هست. در مورد نحوه فیکس کردن IP در جای دیگه ای صحبت خواهیم کرد
در مورد فیک کردن IP [اینجا](#آموزش-تکمیلی---فیکس-کردن-ip) بیشتر توضیح دادیم.
**اخطار:** با استفاده از این Worker مرتب IP دیوایس شما تغییر میکنه، بنابراین برای کارهایی مثل ترید و PayPal و حتی سایتهایی مثل Hetzner که حساس هستن ازش استفاده نکنید، امکان Ban شدن هست. در مورد فیکس کردن IP [اینجا](#آموزش-تکمیلی---فیکس-کردن-ip) بیشتر توضیح دادیم.

### 2 - کانفیگ های فرگمنت (json)

Expand All @@ -46,11 +45,12 @@

**استفاده روی موبایل**

![Image](https://telegra.ph/file/d1af5cfa899211beae347.png)
![Image](assets/images/mobile_fragment.png)

قبل از هر چیزی بگم برای استفاده از این کانفیگا اول باید برنامه‌تون آپدیت باشه و همینطور باید Geo asset files برنامه V2rayNG آپدیت باشه. وارد این قسمت بشید و اون علامت ابر یا دانلود رو بزنید تا آپدیت بشن، اگر آپدیت ناموفق باشه وصل نمیشید. اگر هر کاری کردید آپدیت نشد دو تا فایل از دو تا لینک زیر دانلود کنید و بجای آپدیت زدن، دکمه اضافه کردن رو بزنید و این دوتا فایل رو وارد کنید:
قبل از هر چیزی بگم برای استفاده از این کانفیگ‌ها اول باید برنامه‌تون آپدیت باشه و همینطور باید Geo asset files برنامه V2rayNG آپدیت باشه. وارد این قسمت بشید و اون علامت ابر یا دانلود رو بزنید تا آپدیت بشن، اگر آپدیت ناموفق باشه وصل نمیشید. اگر هر کاری کردید آپدیت نشد دو تا فایل از دو تا لینک زیر دانلود کنید و بجای آپدیت زدن، دکمه اضافه کردن رو بزنید و این دوتا فایل رو وارد کنید:

[https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat](https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat)

[https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat](https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat)

خب حالا یه جدول داریم که دو تا ساب میده و برای اپلیکیشن‌های v2rayNG و Streisand هست.
Expand All @@ -70,11 +70,11 @@
Nekobox کلا فرگمنت رو پشتیبانی نمیکنه. برای برنامه‌ی Hiddify Next اول کانفیگای Normal رو از لینک سابسکریپشن لود
کنید، بعد از تنظیمات خودشون باید Fragment رو اینجوری فعال کنید:

![Image](https://telegra.ph/file/26d5d24d1aa61423d9410.png)
![Image](assets/images/fragment_settings.png)

**استفاده در DESKTOP**

![Image](https://telegra.ph/file/175a895e203db5d1409c1.png)
![Image](assets/images/desktop_fragment.png)

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

Expand Down Expand Up @@ -113,7 +113,7 @@ Nekobox کلا فرگمنت رو پشتیبانی نمیکنه. برای برن

خب حالا اگر خواستید علاوه بر اون 6 تا کانفیگ دیگه ای اضافه کنید که با IP تمیز خودتون باشه، مطابق عکس IP یا دامین‌های تمیز خودتون رو با ویرگول وارد کنید و Apply بزنید:

![Image](https://telegra.ph/file/14a43a87a6252ff96eaaa.png)
![Image](assets/images/clean_ip.png)

الان اگر توی اپلیکیشن Update subscription بزنید میبینید که کانفیگای جدید اضافه شدن.

Expand All @@ -122,9 +122,9 @@ Nekobox کلا فرگمنت رو پشتیبانی نمیکنه. برای برن

#### تنظیمات فرگمنت

![Image](https://telegra.ph/file/55705e28355c841160fb9.png)
![Image](assets/images/panel_fragment_settings.png)

این قسمت برای تنظیمات کانفیگای Fragment هست و تاثیری روی کانفیگ ها بخش نرمتا نداره.
این قسمت برای تنظیمات کانفیگای Fragment هست و تاثیری روی کانفیگ ها بخش نرمال نداره.

کانفیگای Fragment چند تا مقدار پیشفرض دارن که تقریبا روی همه اپراتورا جواب میدن. ولی حالا فرض کنید طبق تجربه شما تنظیماتی دارید که روی اپراتور خودتون همیشه بهتر جواب میده و میخواید اعمال کنید. اینا رو میتونید عوض کنید:

Expand All @@ -151,14 +151,4 @@ Nekobox کلا فرگمنت رو پشتیبانی نمیکنه. برای برن
نحوه‌ی استفاده از این کانفیگا رو در 2 بخش بعدی بخونید.


### آموزش تکمیلی - فیکس کردن IP

ما یک مشکل داریم که VPN مرتباً برای سایت‌های پشت Cloudflare (بخش وسیعی از وب) تغییر آدرس IP می‌دهد. برای حل این مشکل، به خطوط 11 و 12 کد نگاه کنید. من دو لینک را قرار داده‌ام. آن‌ها را باز کنید و چندین آدرس IP مشخص شده را بررسی کنید. یکی از آن‌ها را انتخاب کرده و آن را در خط 13 قرار دهید.

![Image](https://telegra.ph/file/f06d228610558b806154f.png)

متن اول خط 13 به این صورت است:

```javascript
const proxyIPs = ['cdn.xn--b6gac.eu.org', 'cdn-all.xn--b6gac.eu.org', 'edgetunnel.anycast.eu.org'];

48 changes: 31 additions & 17 deletions docs/installation_fa.md → docs/pages_installation_fa.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# مراحل نصب
# مراحل نصب


## نصب به صورت Cloudflare Pages
Expand All @@ -14,20 +14,26 @@

حالا به آدرس گیتهاب [BPB-Worker-Panel](https://github.com/bia-pain-bache/BPB-Worker-Panel) میرید و از اون بالا دکمه Fork رو میزنید.

![Fork](assets/Frok.png)
![Fork](assets/images/Frok.png)


تو صفحه‌ی بعدی به هیچی دست نزنید و Create Fork رو بزنید. خب کار ما با گیتهاب تموم شد.

#### قدم دوم - ساخت Cloudflare KV:
اگر اکانت کلود فلر ندارید اینجا یک اکانت بسازید (اینجا هم فقط یک ایمیل برای ثبت نام لازم دارید) در اکانت کلادفلرتون از منوی سمت چپ میریم به قسمت KV:
![Fork](assets/KV-Menu.png)

![KV](assets/images/KV-Menu.png)

روی Create a namespace کلیک میکنیم و یه اسم دلخواه بهش میدیم و Add میکنیم.

#### قدم سوم - Cloudflare Pages:
حالا وارد قسمت Workers and Pages بشید همونجا که ورکر میساختیم و Create Application رو بزنید. با این تفاوت این دفعه Pages رو انتخاب میکنیم:
![Create Page](assets/Create-Pages-1.png)

![Create Page](assets/images/Create-Pages-1.png)

اینجا Connect to Git رو میزنید و میرید مرحله بعد:
![Connect to Git](assets/Connect-Git.png)

![Connect to Git](assets/images/Connect-Git.png)

اینجا روی BPB-Worker-Panel کلیک کنید تا فعال بشه و Begin Setup رو بزنید. مرحله‌ی بعد یه Project Name داره که میشه دامین پنل شما، اونو حتما عوض کنید یه اسم دلخواه بذارید.

Expand All @@ -36,28 +42,32 @@

حالا با توجه به عکس زیر برید قسمت Settings و بعد Functions:

![Link to KV](assets/Func-Setting.png)
![Link to KV](assets/images/Func-Setting.png)


اینجا مثل ورکر تو صفحه قسمت KV namespace bindings رو پیدا کنید، Add binding بزنید و Variable name باید حتما `bpb` باشه (همینجوری که نوشتم) و KV namespace اون KV رو انتخاب میکنید که مرحله دو ساختید و save میکنید.
![Link to KV](assets/KV-link.png)

![Link to KV](assets/images/KV-link.png)

خب کارمون با KV تموم شد، حالا فقط باید دوباره Deploy کنیم که تغییرات KV اعمال بشه.

از نوار بالا به قسمت Deployment برگردید و از بخش Production برید به view details:
![Deploy](assets/Redeploy.png)

![Deploy](assets/images/Redeploy.png)

حالا تو قسمت Deployment detail دکمه‌ی Manage Deployment رو بزنید و Retry deployment:
![Deploy](assets/Redeploy-1.png)

![Deploy](assets/images/Redeploy-1.png)

چند ثانیه صبر میکنید تا مراحلش تموم شه و کار ما تموم شد!

یه Back بزنید و از قسمت Production روی visit site بزنید، بعد یه `panel/` تهش اضافه کنید و وارد پنل بشید.

آموزشها و نکات هم که تو آموزش اصلی هست:

[Tutorial Link](https://tinyurl.com/22z4ekr6)
[Tutorial Link](configuration_fa.md)

نصب به پایان رسیده و توضیحاتی که در ادامه اومده شاید برای عموم لازم نباشه. !

#### تنظیمات پیشرفته (اختیاری)
شاید تا الان متوجه شده باشید که در مورد تغییر UUID و Proxy IP چیزی نگفتیم.
Expand All @@ -70,12 +80,14 @@

برای تغییر UUID و Proxy IP
تو همین صفحه میاید پایین و قسمت Environment variables (advanced) رو باز میکنید:
![Environment variables](assets/Env-Var.png)

![Environment variables](assets/images/Env-Var.png)

اینجا باید مقادیر رو مشخص کنید. یه بار Add variable بزنید و خونه اول رو بنویسید `UUID` با حروف بزرگ، بعد از این لینک یه UUID بگیرید و بذارید خونه دوم:

[UUID Generator](https://www.uuidgenerator.net/)
![UUID Generator](assets/uuid-generator.png)

![UUID Generator](assets/images/uuid-generator.png)

حالا یه بار دیگه Add variable بزنید خونه اول `PROXYIP` با حروف بزرگ، IP رو هم میتونید از لینک‌های زیر بگیرید:

Expand All @@ -86,10 +98,12 @@
حالا لازمه دوباره تغییرات رو اعمال کنیم.

از نوار بالا به قسمت Deployment برگردید و از بخش Production برید به view details:
![Deploy](assets/Redeploy.png)

![Deploy](assets/images/Redeploy.png)

حالا تو قسمت Deployment detail دکمه‌ی Manage Deployment رو بزنید و Retry deployment:
![Deploy](assets/Redeploy-1.png)

![Deploy](assets/images/Redeploy-1.png)

چند ثانیه صبر میکنید تا مراحلش تموم شه و کار ما تموم شد!

Expand All @@ -99,8 +113,8 @@

#### به روز رسانی:
یکی از مزیت‌های Pages نسبت به Worker اینه که وقتی آپدیتی برای کد منتشر میشه دیگه نیازی نیست برید ورژن جدید worker.js رو دانلود کنید و روز از نو روزی از نو! اصلا برای آپدیت دیگه کاری به کلادفلر ندارید. کافیه به گیتهاب خودتون برید وارد ریپازیتوری BPB-Worker-Panel بشید و از اینجا Sync fork رو بزنید:
![Update](assets/Update.png)
بعد یه سری تغییرات ورژن جدید رو نشون میده و Update branch رو میزنید. خوبیش اینه که با این کار Cloudflare Pages خودش متوجه میشه و در حدود ۱ دقیقه بعد خودبخود آپدیت میکنه براتون.

![Update](assets/images/Update.png)

بعد یه سری تغییرات ورژن جدید رو نشون میده و Update branch رو میزنید. خوبیش اینه که با این کار Cloudflare Pages خودش متوجه میشه و در حدود ۱ دقیقه بعد خودبخود آپدیت میکنه براتون.

## نصب به صورت Cloudflare Worker
Loading

0 comments on commit 058c187

Please sign in to comment.