Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Diana-Cl authored Oct 31, 2024
1 parent 5537e2e commit da94669
Showing 1 changed file with 39 additions and 44 deletions.
83 changes: 39 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
## $$\color{silver} \Large \text{BPB v2.6}$$
<h1 align="center">$$\color{#a5a5a5} \Large \text{BPB PANEL}$$</h1>

> __[🇮🇷Persian](README-fa.md)__ __[🇬🇧English](README.md)__
__*[🇮🇷 Persian](README-fa.md)*__
__*[🇬🇧 English](README.md)*__

<p align="center">
<img src="https://github.com/user-attachments/assets/2687f318-87eb-4af6-a30a-5904f25bd394" width="160px"
style="text-align: center;" alt="https://github/.com/NiREvil/bia-pain-bache"<figcaption> v2.7
</p><br>


<h2>$$\color{#a5a5a5} \Large \text{Table of Contents}$$</h2>

## table of contents
- [Introduction](#Introduction)
- [Features](#Features)
- [How to use](#How-to-use)
- [Variable description](#Variable-description)
- [Panel preview](#Panel-preview)
- [Supported clients](#Supported-clients)

<br><br>

### 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).
<h2>$$\color{#a5a5a5} \Large \text{Introduction}$$</h2>

HUGE THANKS TO
[bia pain bache](https://github.com/bia-pain-bache) for creating these amazing panel
#### $$\color{gray} \large \text{This project is dedicated to developing a user panel for the Cloudflare Workers-Pages proxy-script created by}$$ $$\color{gold} \Large \text{yonggekkk}$$ [^1]
#### $$\color{gray} \large \text{Huge thanks to}$$ $$\color{gold} \Large \text{Bia Pain Bache}$$ [^2] $$\color{gray} \large \text{for creating these amazing panel}$$
<br><br>

The panel offers two deployment options:
- __Worker__ deployment
- __Pages__ deployment
<br>
<h3>$$\color{#a5a5a5} \Large \text{The panel offers two deployment options:}$$</h3>

> [Worker __deployment__](docs/worker_installation_fa.md)
> [Pages __deployment__](docs/pages_installation_fa.md)
<br><br>
## Features

1. __Free__: No cost involved.
2. __User-Friendly Panel:__ Designed for easy navigation, configuration and usage.
3. __Protocols:__ Provides VLESS, Trojan and Wireguard (Warp) protocols.
4. __Warp Pro configs:__ Optimized Warp for crucial circumstances.
5. __Support Fragment:__ Supports Fragment functionality for crucial network situations.
6. __Full routing rules:__ Bypassing Iran/China and LAN, Blocking QUIC, Porn, Ads, Malwares, Phishing...
5. __Bypass Iran and LAN (Optional)__
6. __Full routing rules:__ Bypassing Iran, Blocking Ads, Malwares, Phishing... for Sing-box.
7. __Chain Proxy:__ Capable of adding a chain proxy to fix IP.
8. __Supports Wide Range of Clients:__ Offers subscription links for Xray, Sing-box and Clash core clients.
10. __Subscription Link (JSON):__ Provides subscription link for JSON configs.
11. __Password-Protected Panel:__ Secure your panel with password protection.
12. __Fully customizable:__ Ability to use online scanner and setting up clean IP-domains, Proxy IP, setting DNS servers, choosing ports and protocols, Warp endpoints...
1. **Free**: No cost involved.
2. **User-Friendly Panel:** Designed for easy navigation, configuration and usage.
3. **Protocols:** Provides VLESS, Trojan and Wireguard (Warp) protocols.
4. **Warp Pro configs:** Optimized Warp for crucial circumstances.
5. **Support Fragment:** Supports Fragment functionality for crucial network situations.
6. **Full routing rules:** Bypassing Iran/China/Russia and LAN, Blocking QUIC, Porn, Ads, Malwares, Phishing...
7. **Chain Proxy:** Capable of adding a chain proxy to fix IP.
8. **Supports Wide Range of Clients:** Offers subscription links for Xray, Sing-box and Clash core clients.
9. **Password-Protected Panel:** Secure your panel with password protection.
10. **Fully customizable:** Ability to use online scanner and setting up clean IP-domains, Proxy IP, setting DNS servers, choosing ports and protocols, Warp endpoints...
<br>

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

- [Installation (Worker)](docs/worker_installation_fa.md)

- [Scanning Proxy IP](docs/proxy-ip-scanner.md)

- [How to use](docs/configuration_fa.md)

- [FAQ](docs/faq.md)
<br>


## Variable description
> For further information on how to create variables, please refer to [this link](https://github.com/NiREvil/bia-pain-bache/blob/main/docs/pages_installation_fa.md#3--%D8%AA%D8%BA%DB%8C%DB%8C%D8%B1-%D9%BE%D8%B3%D9%88%D8%B1%D8%AF%D9%87%D8%A7%DB%8C-trojan).
Expand All @@ -67,39 +67,36 @@ HUGE THANKS TO

![rainbow](https://github.com/NiREvil/vless/assets/126243832/1aca7f5d-6495-44b7-aced-072bae52f256)



## Panel preview

<p align="center">
<img src="docs/assets/images/Panel.jpg">
<img src="docs/assets/images/Panel.png">
</p>

<p align="center">
<img src="docs/assets/images/Panel_2.jpg">
<img src="docs/assets/images/Panel_2.png">
</p>

<p align="center">
<img src="docs/assets/images/Panel_3.jpg">
<img src="docs/assets/images/Panel_3.png">
</p>

<p align="center">
<img src="docs/assets/images/Panel_4.jpg">
<img src="docs/assets/images/Panel_4.png">
</p>

<p align="center">
<img src="docs/assets/images/Panel_5.jpg">
<img src="docs/assets/images/Panel_5.png">
</p>

<p align="center">
<img src="docs/assets/images/Panel_6.jpg">
<img src="docs/assets/images/Panel_6.png">
</p>

<br><br>

<br><br>

---
## Supported clients

| Client | Version | Fragment | Warp Pro |
Expand All @@ -121,15 +118,13 @@ HUGE THANKS TO

---

## 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)

---

### 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)
---

- 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).
---

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).
[^1]: [yonggekkk](https://github.com/yonggekkk/Cloudflare-workers-pages-vless)
[^2]: [BPB](https://github.com/bia-pain-bache)

0 comments on commit da94669

Please sign in to comment.