You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 24, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+36-18Lines changed: 36 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,35 +8,36 @@
8
8
9
9
</h1>
10
10
11
-
<h3>
12
-
<strong>V2RayGen / XRayGen</strong> is a fully automated script that helps you to set up your own Xray server in the fastest time.
13
-
</h3>
11
+
<h3><strong>V2RayGen/XRayGen</strong>: A Fast and Automated Script for XRay/V2Ray Server Setup</h3>
14
12
15
13
[**Usage**](#usage)
16
14
17
15
[**Quick Setup**](#quicksetup)
18
16
19
17
[**Examples**](#examples)
20
18
21
-
[**Options ⚙️**](#options)
19
+
[**Options**](#options)
22
20
23
-
[**License 🪪**](#license)
21
+
[**License**](#license)
24
22
25
-
[**Donate Me ☕**](#donateme)
23
+
[**Donate Me**](#donateme)
26
24
27
25
## **Prerequisites & Dependencies**
28
26
29
-
For running this script, you must have **docker**, **docker-compose** and **python3** on your server **but** this script installs `docker` & `docker-compose` if your server doesn't have docker and runs xray-core automatically
27
+
-`Python3`
28
+
-`Docker`
29
+
-`Docker Compose`
30
+
<p>If your server lacks Docker and Docker-Compose, the script will install them and launch XRay-Core automatically.</p>
30
31
31
32
use **sudo** if your current user is not in the docker group or you don't have docker installed
32
33
33
-
## **How XRayGen Works ?**
34
+
## **How Does XRayGen Work?**
34
35
35
-
`XRayGen` uses docker to pull XRay image from the docker registry and after that, it generates a configuration file to start XRay container.
36
+
<p>XRayGen uses Docker to retrieve the xray-core image from the Docker registry. It then generates a configuration file to launch the XRay container.
36
37
37
-
it also creates a clientside configuration file so you can use that with xray-core or v2ray-core.
38
+
A client-side configuration file is also created for use with XRay-core or V2Ray-core.
38
39
39
-
There is also `XRayAgent` for User Management on XRay Configuration which can be used for CRUD operations.
40
+
The XRayAgent provides user management for XRay configuration, offering CRUD operations.</p>
40
41
41
42
## **Usage**
42
43
@@ -50,11 +51,12 @@ There is also `XRayAgent` for User Management on XRay Configuration which can be
50
51
51
52
You can use one of the following protocols for installation and change its settings according to your needs.
52
53
53
-
| Protoctol | Argument |
54
-
| ----------- | ------------- |
55
-
| VMESS | --vmess , -wm |
56
-
| VMESS + TLS | --vmess --tls |
57
-
| VLESS + TLS | --vless , -vl |
54
+
| Protoctol | Argument |
55
+
| ------------ | -------------- |
56
+
| VMESS | --vmess , -wm |
57
+
| VMESS + TLS | --vmess --tls |
58
+
| VLESS + TLS | --vless , -vl |
59
+
| VLESS + XTLS | --vless --xtls |
58
60
59
61
### **Quick `Xray` Setup with Default Setting** :
60
62
@@ -127,6 +129,12 @@ VLESS + Using Google DNS :
127
129
curl https://raw.githubusercontent.com/SonyaCore/V2RayGen/main/V2RayGen.py | sudo python3 - --vless --dns google
0 commit comments