English

$\color{gold} \Large \text{Welcome to the CFW-BOT wiki}$

in this page I'm going to explain how this telegram bot works, how you can use it.

How This Bot Works ?

this bot use Wrangler and Cloudflare API to deploy xray builder .js script on CloudFlare Worker and it use simple steps to do this.

1. The majority part of the project, which is related to the Telegram bot and its subset developed by a highly respected Developer named 2ri4eUI, and it Modify the value in template javascript files index.js and subworker.js ( which is created by this Awesome Developer, not me) and exchange them with provided value by user. $\color{silver} \large \text{I thank both honorable individuals.}$

2. it add the provided subdomain by user as a custom Domain for Worker. the process of adding subdomain is automatically create worker Dns record.

3. it will upload the javascript on cloudflare and send back the Vless Config and Subscription link

How To Use it ?

using this telegram bot is really simple and for creating each user you only have to provide this bot there parameters. click on the ➕Add User

➕Add User

1. Name

which will use as your Worker name and it wil automatically add subworker at the beginning of this name which will be use for name of the subscription worker.

in my experiment with CFW, i find out that using Captial word or none alphabetical character in name of worker will cause issue for wrangler to process so keep this in mind when creating a new user

2. Proxy

you can use ip or domain, they can be CloudFlare proxy or they can be a Socks5 proxy. there are lots of tutorial on internet of how you can find them on your own here is my simple solution

not all of proxy you find works, and not all of them are going to work for opening cloudflare's certificated website the best solution so far is creating your own socks5 proxy server or use ones that shared in public.

3. Subdomain

if you already have set a domain (in add site section) on your cloudflare account (same account you are using its id to run bot) you can use it while creating the user. or you can use Worker Domain .

you should send them like this:

• Using Your Domain = subdomain.yourdomain.com
• Using Worker Domain = subdomain.yourworkerdomain.workers.dev

REMEBER that your subdomain must be unique. you can't set multiple worker on same subdomain. you do not need to set a dns record to use your subdomain. just send your desired subdomain in format above and it will do the rest.

if it create or upload worker successfully it will send this message:

🔰Users Panel

here you are going to see all of your created users that saved in cfw.db file you have access to all users links by clicking on them. you have the 🆕 Proxy For USERS which can set a new proxy for all of the users and redeploy one by one. for each user have these options:

• 🗑️Delete : it will delete user from cfw.db and their workers from CloudFlare
• 🔲QR : it will generate QR of Tls and NoTls Configs
• 🆕 New Proxy : you can set a new proxy for each user
• 🔄 Redeploy : you can redeploy your worker to use your new proxy setting.
• 🔧 Worker Status : this redirect you to page of selected worker on cloudflare.

IP_API or 📋Subscriptions ips

i explained this in detail HERE this is a cool feature of CFW bot, you can set your own IP_API by using 📋Subscriptions ips button clicking on Change will ask you a new IP_API value. and clicking on Keep will keeps your current IP_API

in a nutshell: it will use a list of ips that provided in text file URL to create configurations in your generated subscription link. it works dynamically, so any change you made in IP_API , it will going to reflect on your subscription content. in this way if list of ip in your IP_API link get blocks, you just need to change the content of your text file and update the subcription in client app.

🌐Worker Subdomain🌐

here you can see your current Cloudflare account subdomain. and it have a button ✏️ Change Subdomain that direct you to cloudflare page where you can change it.

📊 Workers Status

it redirect you to Worker-Pages Overview page where you can see your daily request of each worker and total request that you still have.

📁CF Proxies

in recent update (0.03) i added a new function (📁CF Proxies) to makes creating user faster now you can add a list of proxy and it will save them in a text file called proxies.txt it will use the content of this .txt file for creating button these button will popup when ever you are going to create a new user or you want to create redeploy a user with new proxy address.

🔄Redeploy

🔄Redeploy button will upload your worker with new selected/sent proxy, you can set this by using 🆕Proxy button right now the only viable option for 🔄Redeploy usage is setting a new proxy for your user

FAQ

1. Why it keep Failing ? you are getting this message:

• if you already have that subdomain as dns record it will fails
• if you already use that subdomain to create a worker it will fails
• if your subdomain include non recognizable characters it will fails
• if your domain does not exist in you cloudflare account it will fails

2. it works but generated link does not connect?

• if your domain is already blocked by GFW it does not Work
• if your proxy is not reachable by cloudflare it does not work

3. my IP_API doesn't work ! why ?

• if you are using PythonAnyWhere , some time you need to set it more than once to make it set on your .env file
• when you change IP_API URL, your previous user IP_API does not change but new users should use your new IP_API url
• if you don't see your IP_API values in your subscripton, it maybe because the format is incorrect or the body of text file have additional data which cause worker to not recognize your url as text file. use github raw link to test this function .

4. bot stoped responding!

• if you are using PythonAnyWhere free plan it may need to restart the bot time to time, there is nothing i could do about it, it may happen every couple of days , you just need to send this command

python3 cfw.py

$\color{gold} \large \text{Be curious. 🤍🪐}$