Documentation

Create proper documentation

README.md

@@ -1,41 +1,36 @@
-## Cloudflare-workers/pages代理脚本
+# 💦 BPB Panel
 
-### 方案一支持workers部署：实现vless+ws+tls与vless+ws两种代理节点
+## Introduction
+This project is dedicated to developing a user panel for the [Cloudflare-workers/pages proxy script](https://github.com/yonggekkk/Cloudflare-workers-pages-vless) created by [yonggekkk](https://github.com/yonggekkk). The panel offers two deployment options: 
+- Option 1: Supports worker deployment
+- Option 2: Supports pages deployment
 
-### 方案二支持pages部署：仅实现vless+ws+tls代理节点
+---
 
-### 详细说明教程请参考[甬哥博客及视频教程](https://ygkkk.blogspot.com/2023/07/cfworkers-vless.html)
---------------------------------
-### CF vless代码默认修改内容
+## Features
 
-1、UUID必须自定义
+1. **Free**: No cost involved.
+2. **User-Friendly Panel**: Designed for easy navigation and usage.
+3. **Support Fragment**: Provides support for fragment functionality.
+4. **Ad Blocking (Optional)**: Option to block ads.
+5. **Direct Iran (Optional)**: Includes an option for direct access to Iran.
+6. **Subscription Link (URL) for Wide Range of Clients**: Offers subscription links for various clients.
+7. **Subscription Link (JSON)**: Provides subscription links in JSON format.
+8. **Singbox**: Features Singbox integration.
+9. **Password-Protected Panel**: Secure your panel with password protection.
+10. **Custom Cloudflare Clean IP**: Ability to set up a custom Cloudflare clean IP.
 
-2、proxyIP已更新支持chatgpt的IP，可直接使用（使用人数过多，不定时失效），可自定义
+---
 
-3、伪装网页已更新为微软www.bing.com，可自定义
+## Stargazers Over Time
+[![Stargazers Over Time](https://starchart.cc/bia-pain-bache/BPB-Worker-Panel.svg?variant=adaptive)](https://starchart.cc/bia-pain-bache/BPB-Worker-Panel)
 
-4、重点对workers与pages、有域名与无域名，这4种情况下的节点分享做了优化显示，方便小白们理解操作
+---
 
----------------------------------
-### CF-CDN优选域名一键脚本，苹果安卓手机平板专用，(请参考教程，在本地网络环境下运行)：
-```
-curl -sSL https://gitlab.com/rwkgyg/CFwarp/raw/main/point/CFcdnym.sh -o CFcdnym.sh && chmod +x CFcdnym.sh && bash CFcdnym.sh
-```
-------------------------------------------------------------------------
-### CF-优选反代IP一键脚本，苹果安卓手机平板专用，(请参考教程，在本地网络环境下运行)：
-```
-curl -sSL https://gitlab.com/rwkgyg/CFwarp/raw/main/point/cfip.sh -o cfip.sh && chmod +x cfip.sh && bash cfip.sh
-```
+### Special Thanks
+- CF-vless code author [3Kmfi6HP](https://github.com/3Kmfi6HP/EDtunnel)
+- CF preferred IP program author [badafans](https://github.com/badafans/Cloudflare-IP-SpeedTest), [XIU2](https://github.com/XIU2/CloudflareSpeedTest)
 
--------------------------------------------------------------
-### 感谢你右上角的star🌟
-[![Stargazers over time](https://starchart.cc/yonggekkk/Cloudflare-workers-pages-vless.svg)](https://starchart.cc/yonggekkk/Cloudflare-workers-pages-vless)
-------------------------------------------------------------------------
-### 感谢：CF-vless代码作者[3Kmfi6HP](https://github.com/3Kmfi6HP/EDtunnel) CF优选IP程序作者[badafans](https://github.com/badafans/Cloudflare-IP-SpeedTest)、[XIU2](https://github.com/XIU2/CloudflareSpeedTest)
+---
 
----------------------------------------
-#### 声明：
-
-#### 其中一键脚本使用base64加密，可自行解密，介意者请勿使用，[加密原因在此](https://ygkkk.blogspot.com/2022/06/github.html)
-
-#### 所有代码来源于Github社区与ChatGPT的整合；如您需要开源代码，请提Issues留下您的联系邮箱
+For a detailed tutorial on the core script, please refer to [Yongge’s blog and video tutorials](https://ygkkk.blogspot.com/2023/07/cfworkers-vless.html).

README_fa.md

@@ -0,0 +1,72 @@
+# 💦 پنل BPB
+<div dir="rtl">
+<a href="README.md">English</a>
+</div>
+## معرفی
+<div dir="rtl">
+
+این پروژه به توسعه یک پنل کاربری برای اسکریپت <a href="https://github.com/yonggekkk/Cloudflare-workers-pages-vless">پروکسی Cloudflare-workers/pages</a> ایجاد شده توسط <a href="https://github.com/yonggekkk">yonggekkk</a> می‌پردازد.
+
+### این پنل دو گزینهٔ راه‌اندازی را ارائه می‌دهد:
+
+گزینه ۱: پشتیبانی از راه‌اندازی worker
+
+گزینه ۲: پشتیبانی از راه‌اندازی صفحات
+
+</div>
+
+---
+
+## ویژگی‌ها
+
+۱. **رایگان**: هزینه‌ای در بر ندارد.
+
+۲. **پنل کاربری دوستانه**: قابلیت آسان تنظیمات و دریافت کانفیگ ها و لینک های اشتراک 
+
+۳. **پشتیبانی از فرگمنت**: قابل استفاده حتی در صورت فیلتر شدن دامنه
+
+۴. **مسدودسازی تبلیغات (اختیاری)**: گزینه‌ای برای مسدودسازی تبلیغات.
+
+۵. **دسترسی مستقیم به ایران (اختیاری)**: شامل یک گزینه برای دسترسی مستقیم به  سایت های ایران بدون قطع VPN.
+
+۶. **لینک اشتراک (URL) برای اکثر نرم افزار ها**: لینک‌های اشتراک را برای انواع مختلف نرم افزار ها ارائه می‌دهد.
+
+۷. **لینک اشتراک (JSON)**: لینک‌های اشتراک را در فرمت JSON فراهم می‌کند.
+
+۸. **پشتیبانی از  Singbox**: تولید کانفیگ مناسب singbox.
+
+۹. **پنل با رمز عبور محافظت شده**: پنل خود را با استفاده از رمز عبور ایمن کنید.
+
+۱۰. **آی‌پی تمیز Cloudflare سفارشی**: قابلیت تنظیم آی‌پی تمیز Cloudflare را دارد.
+
+
+
+---
+
+## استفاده
+[نصب](docs/installation_fa.md)
+
+[پیکربندی](docs/configuration.md)
+
+[رفع اشکال](docs/troubleshooting.md)
+
+[پرسش‌های متداول (FAQ)](docs/faq.md)
+
+---
+
+## تعداد ستاره‌ها به مرور زمان
+[![تعداد ستاره‌ها به مرور زمان](https://starchart.cc/bia-pain-bache/BPB-Worker-Panel.svg?variant=adaptive)](https://starchart.cc/bia-pain-bache/BPB-Worker-Panel)
+
+---
+
+### تشکر ویژه
+<div dir="rtl">
+- نویسنده کد CF-vless <a href="https://github.com/3Kmfi6HP/EDtunnel">3Kmfi6HP</a>
+- نویسنده برنامه IP ترجیحی CF <a href="https://github.com/badafans/Cloudflare-IP-SpeedTest">badafans</a>، <a href="https://github.com/XIU2/CloudflareSpeedTest">XIU2</a>
+</div>
+
+---
+
+<div dir="rtl">
+برای آموزش جزئیات اسکریپت اصلی، لطفاً به <a href="https://ygkkk.blogspot.com/2023/07/cfworkers-vless.html">وبلاگ و آموزش‌های ویدیویی Yongge</a> مراجعه کنید.
+</div>

docs/installation_fa.md

@@ -0,0 +1,77 @@
+# مراحل نصب
+
+
+## نصب به صورت Cloudflare Pages
+### مقدمه
+
+احتمالاً آگاهید که ما دو روش برای ساخت پروکسی روی کلادفلر داریم، Worker و Pages. حالا نکته اینجاست که روش Worker که مرسوم‌تره یه محدودیت داره یعنی روزانه صدهزار Request بیشتر به شما نمیده که برای مصرف ۲-۳ نفر کافیه البته. برای دور زدن این محدودیت ما یه دامنه به ورکر وصل میکردیم (که ظاهرا باگ کلادفلر هست) و اینجوری نامحدود میشد. اما Pages این محدودیت رو نداره. البته چون ما از امکان Pages functions استفاده میکنیم  مثل ورکر محدودیت داره و ممکنه ایمیل بگیرید که ظرفیتش پر شده، ولی طبق تجربه قطع نمیشه. در این روش حتی اگر از دامنه شخصی هم استفاده کنید باز این ایمیل رو دریافت می کنید. ولی در نهایت تجربه نشون داده که سرویس شما قطع نخواهد شد.
+
+مزیت  مهم دیگه‌ش نحوه یروزرسانی هست وقتی آپدیتی برای پروژه میاد، که در ادامه آموزش میدم.
+#### قدم اول - Github:
+شما میرید به آدرس github.com و یه اکانت میسازید مثل هر سایت دیگه. و بعدش لاگین میکنید.
+
+میرید به آدرس گیتهاب BPB:
+
+[BPB-Worker-Panel](https://github.com/bia-pain-bache/BPB-Worker-Panel)
+
+و از اون بالا دکمه Fork رو میزنید.
+
+
+
+تو صفحه‌ی بعدی به هیچی دست نزنید و Create Fork رو بزنید.
+
+
+
+خب کار ما با گیتهاب تموم شد.
+
+#### قدم دوم - ساخت Cloudflare KV:
+فکر کنم همه اینو بلدید، میریم داخل اکانت کلادفلر از منوی سمت چپ میریم به قسمت KV:
+
+میزنیم Create a namespace و یه اسم دلخواه بهش میدیم و Add میکنیم.
+
+#### قدم سوم - Cloudflare Pages:
+حالا وارد قسمت Workers and Pages بشید همونجا که ورکر میساختیم و Create Application رو بزنید. با این تفاوت این دفعه Pages رو انتخاب میکنیم:
+
+اینجا Connect to Git رو میزنید و میرید مرحله بعد:
+
+اینجا روی BPB-Worker-Panel کلیک کنید تا فعال بشه و Begin Setup رو بزنید. مرحله‌ی بعد یه Project Name داره که میشه دامین پنل شما، اونو حتما عوض کنید یه اسم دلخواه بذارید.
+
+حالا اینجا یه فرقی با ورکر داره، یعنی اگر بخواید UUID یا Proxy IP رو عوض کنید دیکه نمیتونید برید توی کد تغییر بدید، تو همین صفحه میاید پایین و قسمت Environment variables (advanced) رو باز میکنید:
+
+اینجا باید مقادیر رو مشخص کنید. یه بار Add variable بزنید و خونه اول رو بنویسید UUID با حروف بزرگ، بعد از این لینک یه UUID بگیرید و بذارید خونه دوم:
+
+[UUID Generator](https://www.uuidgenerator.net/)
+
+حالا یه بار دیگه Add variable بزنید خونه اول PROXYIP با حروف بزرگ، IP رو هم میتونید از لینکای زیر بگیرید:
+
+[Proxy IP](https://www.nslookup.io/domains/cdn.xn--b6gac.eu.org/dns-records/)
+
+[Proxy IP](https://www.nslookup.io/domains/cdn-all.xn--b6gac.eu.org/dns-records/)
+
+دیگه الان میتونید Save and Deploy رو بزنید.
+
+یه چند ثانیه زمان میخواد تا پروژه نصب بشه، صبر کنید تا دکمه‌ی Continue to Project ظاهر بشه و بزنید و برید تو صفحه‌ی پروژه. حالا با توجه به عکس زیر برید قسمت Settings و بعد Functions:
+
+اینجا مثل ورکر تو صفحه قسمت KV namespace bindings رو پیدا کنید، Add binding بزنید و Variable name باید حتما bpb باشه (همینجوری که نوشتم) و KV namespace اون KV رو انتخاب میکنید که مرحله دو ساختید و save میکنید.
+
+خب کارمون با KV تموم شد، حالا فقط باید دوباره Deploy کنیم که تغییرات KV اعمال بشه.
+
+از نوار بالا به قسمت Deployment برگردید و از بخش Production برید به view details:
+
+حالا تو قسمت Deployment detail دکمه‌ی Manage Deployment رو بزنید و Retry deployment:
+
+چند ثانیه صبر میکنید تا مراحلش تموم شه و کار ما تموم شد!
+
+یه Back بزنید و از قسمت Production روی visit site بزنید، بعد یه panel/ تهش اضافه کنید و وارد پنل بشید.
+
+آموزشها و نکات هم که تو آموزش اصلی هست:
+
+[Tutorial Link](https://tinyurl.com/22z4ekr6)
+
+#### قدم چهارم - آپدیت کردن:
+یکی از مزیت‌های Pages نسبت به Worker اینه که وقتی آپدیتی برای کد منتشر میشه دیگه نیازی نیست برید ورژن جدید worker.js رو دانلود کنید و روز از نو روزی از نو! اصلا برای آپدیت دیگه کاری به کلادفلر ندارید. کافیه به گیتهاب خودتون برید وارد ریپازیتوری BPB-Worker-Panel بشید و از اینجا Sync fork رو بزنید:
+
+بعد یه سری تغییرات ورژن جدید رو نشون میده و Update branch رو میزنید. خوبیش اینه که با این کار Cloudflare Pages خودش متوجه میشه و در حدود ۱ دقیقه بعد خودبخود آپدیت میکنه براتون.
+
+
+## نصب به صورت Cloudflare Worker