Skip to content

Commit 52d1c65

Browse files
authored
Update README.md
1 parent 64f6127 commit 52d1c65

File tree

1 file changed

+355
-2
lines changed

1 file changed

+355
-2
lines changed

README.md

Lines changed: 355 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,355 @@
1-
# wizwiz-xui-timebot
2-
Bot showing the volume and remaining subscription x-ui panel
1+
2+
# WizWiz
3+
4+
![](https://img.shields.io/github/v/release/wizwizdev/wizwizxui-timebot.svg)
5+
![](https://visitor-badge.glitch.me/badge?page_id=wizwizdev.wizwizdev)
6+
7+
8+
### [ترجمه به فارسی](README-persian.md)
9+
10+
<br>
11+
<br>
12+
13+
### support me
14+
<br>
15+
16+
Bank Sepe: Turan
17+
18+
```
19+
5892101222351344
20+
```
21+
22+
Tron: (TRX)
23+
24+
```
25+
TY8j7of18gbMtneB8bbL7SZk5gcntQEemG
26+
```
27+
28+
Bitcoin:
29+
30+
```
31+
bc1qcnkjnqvs7kyxvlfrns8t4ely7x85dhvz5gqge4
32+
```
33+
34+
Dogecoin:
35+
36+
```
37+
DMyGMghEh4W55P3VeVHntCN3vYAFtshvVH
38+
```
39+
40+
<br>
41+
42+
43+
## Installation
44+
45+
- cpanel host or Linux server
46+
- domain + ssl
47+
48+
<br>
49+
50+
51+
52+
<br>
53+
54+
## default settings
55+
56+
- Panel port and host or server must be 80-8080-54321
57+
- If you encounter the following message or if the server inside the robot is not registered, please give a ticket to the hosting to open the desired ports.
58+
59+
````
60+
Failed to connect to yourdomain.com port 80 after 340 ms: Couldn't connect to server
61+
````
62+
63+
This error means that port 8080 of your panel is not open on the host or server and you need to open it
64+
65+
66+
<br>
67+
68+
## Installation
69+
70+
````
71+
https://github.com/wizwizdev/wizwizxui-timebot/archive/refs/heads/main.zip
72+
````
73+
74+
75+
> **Important note: After extracting the whole project, upload it directly from the wizwizxui-timebot-main folder to public_html**
76+
77+
78+
<br>
79+
80+
## Database wizwiz.sql
81+
82+
- First, after creating the database, import the wizwiz.sql file into the created database
83+
84+
<br>
85+
86+
87+
### Setting the baseInfo.php file
88+
89+
90+
91+
````
92+
error_reporting(0);
93+
$botToken = ''; //Replace the bot token
94+
$dbUserName = ''; //Replace the database username
95+
$dbPassword = ''; //Replace the database password
96+
$dbName = ''; //Enter the database name
97+
$admin = ; // Get the numeric ID or user ID of the admin account from this bot and replace it with get_id_bot
98+
$channelLock = ""; //Replace the channel id with @ to force lock
99+
$botUrl = "https://yourdomain.com/"; //Replace your domain
100+
$walletwizwiz = ""; //Replace your card or wallet number
101+
````
102+
103+
- To create a bot and receive a token via @bothfather bot, create a bot and replace the token
104+
- To get an ID, get a number from the @chatIDrobot robot and then replace it
105+
- For the channel, please replace the channel ID with @ (must be the channel manager robot to lock the channel)
106+
- Also replace your domain with yourdomain.com
107+
- And you can also put your Volt card or wallet number in "".
108+
109+
110+
111+
<br>
112+
113+
### cron job setting:
114+
115+
116+
- Select Once Per Minute (* * * * *) mode in the Common Settings section
117+
- In the Command field, please enter the following address:
118+
````
119+
/usr/bin/php -q address1 >/dev/null 2>&1
120+
````
121+
- Instead of addres1, you should put the address of the messagewizwiz.php file and save it. Example:
122+
````
123+
/usr/bin/php -q /home/yourfolder/public_html/yordomain.com/messagewizwiz.php >/dev/null 2>&1
124+
````
125+
or
126+
````
127+
/usr/bin/php -q /home/yourfolder/public_html/messagewizwiz.php >/dev/null 2>&1
128+
````
129+
130+
<br>
131+
132+
133+
- Repeat the same steps for the warnUsage.php file:
134+
135+
````
136+
/usr/bin/php -q address2 >/dev/null 2>&1
137+
````
138+
- Instead of addres2, you should put the address of the warnUsage.php file and save it. Example:
139+
````
140+
/usr/bin/php -q /home/yourfolder/public_html/yordomain.com/warnUsage.php >/dev/null 2>&1
141+
````
142+
or
143+
````
144+
/usr/bin/php -q /home/yourfolder/public_html/warnUsage.php >/dev/null 2>&1
145+
````
146+
147+
<br>
148+
149+
150+
### set and hook
151+
152+
153+
````
154+
https://api.telegram.org/bot1/setWebhook?url=2/bot.php
155+
````
156+
Instead of 1, you should replace the robot token and instead of 2, enter the project address: eg
157+
````
158+
https://api.telegram.org/bot365447414:AAFjkjKJHoLKJIOJKLK89jklYwuCU_1IzzCsKJHKQvv/setWebhook?url=https://yordomain.com/bot.php
159+
````
160+
161+
- If the following text is displayed in the output, then congratulations, you have executed the robot correctly
162+
163+
````
164+
{"ok":true,"result":true,"description":"Webhook was set"}
165+
````
166+
167+
168+
<br>
169+
170+
## Setting the htaccess file to increase security
171+
172+
- After extracting the project files, you may not be able to see the htaccess file, first click on Settings in the upper right corner
173+
- In the window that opens, activate the option Show Hidden Files (dotfiles) and then click save
174+
- Finally, remove the .htaccess file from the bot folder and place it directly in public_html
175+
176+
177+
<br>
178+
179+
## Set config port count
180+
181+
- Edit the temp.txt file and write your desired value
182+
183+
184+
<br>
185+
186+
## Setting shared configuration with a specific port for multiple users
187+
188+
- Manually enter a config without volume - date and have a port for example 443
189+
- Please note that we do not use the first created user, which has unlimited volume and date, and defined it only for the robot
190+
- Then in the robot, select the add plan (shared configuration) section and give it the id of the connection line you created.
191+
- As a result, the robot automatically generates users... that's it
192+
193+
<br>
194+
195+
196+
## Setting the panel type
197+
198+
- Panel type (Senai and Alireza) is used for Sanai version 1.1.1 and above and Alireza version 0.4.2
199+
- The panel type (simple) is used for Sanai version 1.0.9 and below, Alireza 0.3.2 and below, Vexilo Chinese panel, Niduka
200+
201+
202+
<br>
203+
204+
## Important points after installation:
205+
206+
- To forcefully lock the bot, you must be the channel administrator
207+
- Lookish host or server must be outside of Iran
208+
- If you use the Trojan protocol (the panel must have the ability to create Trojans, otherwise you will face problems)
209+
- The validity of the notification becomes zero after 2 days (after two days, if the volume or time is low, it will be sent again)
210+
- If the public message or notification is not sent when setting the cron job (when setting the cron job, just delete the domain address from inside the command)
211+
- To create a test configuration, set the price to 0 (each account can use the free test account only once
212+
- If you encounter the message (Glam, the connection to the server is not established), remember that the path is next to the address of the panel, remove the path and restart the panel, the problem will be solved.
213+
214+
215+
216+
217+
218+
<br>
219+
220+
## Support for the following panels:
221+
222+
223+
#### Important note: Install Sanai panel version 1.0.9 and Alireza panel version 0.4.0 that we have installed
224+
225+
226+
227+
- (Nidoka Kalanka) single-port, multi-port (the best option for the robot)
228+
````
229+
bash <(curl -Ls https://raw.githubusercontent.com/NidukaAkalanka/x-ui-english/master/install.sh)
230+
````
231+
- (Senai) multi-port - single-port
232+
````
233+
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
234+
````
235+
````
236+
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v1.0.9
237+
````
238+
- (Alireza) multi-port - single port
239+
````
240+
bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh)
241+
````
242+
````
243+
bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh) 0.4.0
244+
````
245+
- (Vexilo) only single port
246+
````
247+
bash <(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh)
248+
````
249+
250+
<br>
251+
252+
253+
### When adding a server to the robot, please enter the following address
254+
255+
- If your panel starts with path, please delete it from inside the panel and then restart the panel and give the address without path to the bot
256+
257+
````
258+
https://youdomain.com:8080
259+
````
260+
261+
````
262+
http://192.180.125:8080
263+
````
264+
265+
266+
#### The following address is wrong
267+
268+
````
269+
https://youdomain.com:8080/xui/inbounds
270+
````
271+
272+
````
273+
https://youdomain.com:8080/path
274+
````
275+
276+
````
277+
https://youdomain.com:8080/
278+
````
279+
280+
281+
<br>
282+
283+
### Setting the certificate inside the robot
284+
285+
- Instead of keyFile and certificateFile, please enter the address of your certificate and the following is an example:
286+
287+
````
288+
{"serverName": "","certificates": [{"certificateFile": "","keyFile": ""}]}
289+
````
290+
291+
Example:
292+
293+
- Important note: do not leave a space between the ssl address and it should be without space, otherwise the entire x-ui panel will fail.
294+
295+
````
296+
{"serverName": "yourdomain.com","certificates": [{"certificateFile": "/root/cert.crt","keyFile": "/root/private.key"}]}
297+
````
298+
299+
- serverName: yourdomain.com
300+
- certificateFile: /root/cert.crt
301+
- keyFile: /root/private.key
302+
303+
304+
<br>
305+
306+
307+
308+
### Vizviz facilities
309+
310+
311+
- Automatic sale of vless - vmess - trojan
312+
- Setting and creating a configuration with the ability to:
313+
- (volume - day - network - protocol - single user {depends on the panel})
314+
- Server creation and management:
315+
- (name-flag-remark-capacity-header-request-request-tls-sni-ip)
316+
- Create category and manage it
317+
- Creating a plan and managing it
318+
- Create configuration of shared port and dedicated port
319+
- Create test configuration for users (before purchase)
320+
- Ability to pay by card (confirmed by the manager)
321+
- Automatic sending of configuration along with link + configuration name + qrcode to the user
322+
- View the complete specifications of the purchased configuration
323+
- Show the sold accounts of each plan
324+
- Advanced ticketing system section (ticketing)
325+
- Display capability (software link)
326+
- Sending public messages with CronJob
327+
- Enable or disable (Sales - Configuration specifications or both)
328+
- Notification of completion of volume and configuration time (only to the user)
329+
- Inline (config specifications)
330+
- Forced channel lock
331+
- Senate panel support
332+
- Alireza panel support
333+
- Vexilo panel support
334+
- Niduka panel support
335+
- The possibility of adding an account by the user
336+
- The ability to manage and delete the account by the user
337+
- The possibility of registering the configuration to vless-vmess-uuid (Trojan does not support it well)
338+
- Get configuration information (for single port and multiple ports)
339+
- Display account name
340+
- Show input key
341+
- Status display
342+
- Display the total volume
343+
- Show download consumption
344+
- Show upload consumption
345+
- Show total volume usage
346+
- Display the remaining volume
347+
- Display the number of remaining days
348+
- Show subscription expiration date
349+
350+
<br>
351+
352+
Be sure to join the group and support us
353+
354+
## Contact Developer
355+
💎 Group: https://t.me/wizwizdev

0 commit comments

Comments
 (0)