mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2025-09-08 11:16:18 +00:00
Update README.md
This commit is contained in:
parent
8811b1edb2
commit
ec8133121c
1 changed files with 47 additions and 48 deletions
95
README.md
95
README.md
|
@ -106,32 +106,19 @@ systemctl restart x-ui
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## SSL Certificate
|
|
||||||
|
|
||||||
<details>
|
## Recommended OS
|
||||||
<summary>Click for SSL Certificate</summary>
|
|
||||||
|
|
||||||
### Cloudflare
|
- Ubuntu 20.04+
|
||||||
|
- Debian 11+
|
||||||
|
- CentOS 8+
|
||||||
|
- Fedora 36+
|
||||||
|
- Arch Linux
|
||||||
|
- Manjaro
|
||||||
|
- Armbian
|
||||||
|
- AlmaLinux 9+
|
||||||
|
- Rockylinux 9+
|
||||||
|
|
||||||
The Management script has a built-in SSL certificate application for Cloudflare. To use this script to apply for a certificate, you need the following:
|
|
||||||
|
|
||||||
- Cloudflare registered email
|
|
||||||
- Cloudflare Global API Key
|
|
||||||
- The domain name has been resolved to the current server through cloudflare
|
|
||||||
|
|
||||||
**1:** Run the`x-ui`command on the terminal, then choose `Cloudflare SSL Certificate`.
|
|
||||||
|
|
||||||
|
|
||||||
### Certbot
|
|
||||||
```
|
|
||||||
apt-get install certbot -y
|
|
||||||
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
|
|
||||||
certbot renew --dry-run
|
|
||||||
```
|
|
||||||
|
|
||||||
***Tip:*** *Certbot is also built into the Management script. You can run the `x-ui` command, then choose `SSL Certificate Management`.*
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## Languages
|
## Languages
|
||||||
|
|
||||||
|
@ -169,25 +156,48 @@ certbot renew --dry-run
|
||||||
### Information
|
### Information
|
||||||
|
|
||||||
- **Port:** 2053
|
- **Port:** 2053
|
||||||
- **Username & Password:** It will generated randomly if you skip to modify your own security(x-ui "7")
|
- **Username & Password:** It will be generated randomly if you skip modifying.
|
||||||
- **Database Path:** /etc/x-ui/x-ui.db
|
- **Database Path:**
|
||||||
- **Xray Config Path:** /usr/local/x-ui/bin/config.json
|
- /etc/x-ui/x-ui.db
|
||||||
|
- **Xray Config Path:**
|
||||||
*Before SSL Deployment*
|
- /usr/local/x-ui/bin/config.json
|
||||||
|
- **Web Panel Path w/o Deploying SSL:**
|
||||||
- **Web Panel Path:**
|
|
||||||
|
|
||||||
- http://ip:2053/panel
|
- http://ip:2053/panel
|
||||||
- http://domain:2053/panel
|
- http://domain:2053/panel
|
||||||
|
- **Web Panel Path w/ Deploying SSL:**
|
||||||
*After SSL Deployment*
|
- https://domain:2053/panel
|
||||||
|
|
||||||
- **Web Panel Path:**
|
|
||||||
|
|
||||||
- https://yourdomain:2053/panel
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
## SSL Certificate
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click for SSL Certificate</summary>
|
||||||
|
|
||||||
|
### Cloudflare
|
||||||
|
|
||||||
|
The Management script has a built-in SSL certificate application for Cloudflare. To use this script to apply for a certificate, you need the following:
|
||||||
|
|
||||||
|
- Cloudflare registered email
|
||||||
|
- Cloudflare Global API Key
|
||||||
|
- The domain name has been resolved to the current server through cloudflare
|
||||||
|
|
||||||
|
**1:** Run the`x-ui`command on the terminal, then choose `Cloudflare SSL Certificate`.
|
||||||
|
|
||||||
|
|
||||||
|
### Certbot
|
||||||
|
```
|
||||||
|
apt-get install certbot -y
|
||||||
|
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
|
||||||
|
certbot renew --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
***Tip:*** *Certbot is also built into the Management script. You can run the `x-ui` command, then choose `SSL Certificate Management`.*
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
## Xray Configurations
|
## Xray Configurations
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
@ -400,17 +410,6 @@ XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## Recommended OS
|
|
||||||
|
|
||||||
- Ubuntu 20.04+
|
|
||||||
- Debian 11+
|
|
||||||
- CentOS 8+
|
|
||||||
- Fedora 36+
|
|
||||||
- Arch Linux
|
|
||||||
- Manjaro
|
|
||||||
- Armbian
|
|
||||||
- AlmaLinux 9+
|
|
||||||
- Rockylinux 9+
|
|
||||||
|
|
||||||
## Preview
|
## Preview
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue