setup-xray-vless-vpn-using-3x-ui-on-your-vps
Deploy and manage a hardened 3X-UI VPN VPS with Docker Compose, nginx, ACME, SSH tunneling, and Xray VLESS over XHTTP
Open source Open in the app JSON README (API)
About
Deploy and manage a hardened 3X-UI VPN VPS with Docker Compose, nginx, ACME, SSH tunneling, and Xray VLESS over XHTTP
Details
- Kind
- Plugins
- Topic
- Cloud & DevOps
- Publisher
- olegtsvetkov
- Origin
- marketplace
- Category
- ferramentas
- Stars
- 30
- Forks
- 3
- Last push
- 2026-03-25T08:49:16Z
- Repository state
- ativo
- Language
- Python
- License
- MIT
- Added
- 2026-08-30 01:48:58
- Updated
- 2026-08-30 01:48:58
- Origin id
olegtsvetkov/3x-ui-vpn-skill/setup-xray-vless-vpn-using-3x-ui-on-your-vps
README
[English](README.md) | [Русский](README_RU.md) # Run your own Xray VPN in 10 minutes using AI agent Set up an Xray VLESS VPN on your own server or VPS with one command, using the 3X-UI panel for installation and management. You need: - a VPS running Ubuntu 24 or newer at any hosting provider - `1 vCPU` - `512 MB` memory - `10 GB` disk space - about `10 minutes` The canonical skill bundle lives in [`skills/3x-ui-vps/`](skills/3x-ui-vps/). Architecture details: [`skills/3x-ui-vps/references/architecture.md`](skills/3x-ui-vps/references/architecture.md) This repository root is also a Claude Code plugin with namespace `3x-ui-vpn-skills`. The `3x-ui-vps` skill inside it is manual-first because it changes remote infrastructure. ## What The Skill Can Do The skill includes 5 workflows: 1. `Fresh deploy` configures your server from scratch, including dependency installation, port hardening, and base setup. 2. `Panel access` opens an SSH tunnel from the server to your computer so you can access the 3X UI panel. 3. `Quick inbound bootstrap` creates an Xray VLESS inbound on port `443` with nginx in front of it. 4. `Add another client to an existing inbound` adds a client to an existing inbound so you can connect one more device. 5. `Updates` updates the system (`apt update` and `apt upgrade`) and 3X UI. ## How To Use It Install the skill using the instructions below and then use it in chat. Examples: - `Codex`: `$3x-ui-vps, set up a VPN for me` - `Claude Code`: `/3x-ui-vpn-skills:3x-ui-vps set up a VPN for me` - `Cursor`: `Set up a VPN for me using the instructions in AGENTS.md` - `OpenClaw`: `Set up a VPN for me using the 3x-ui-vps skill` Example prompt: ```text $3x-ui-vps, set up a VPN for me ``` ## Information You Will Be Asked For After launch, the skill will ask for additional information: - `SSH target`: the SSH user and IP in the format `root@X.Y.Z.A`; the `root` user is required to install all dependencies - `SSH password`: the `root` password; not needed if key-based authentication is already configured - `Domain`: your domain or subdomain where the VPN will be set up; buy any domain from a domain seller - `Panel Username`: the username for the 3X UI panel - `Panel Password`: the password for the 3X UI panel - `ACME Email`: your email for issuing a Let's Encrypt SSL certificate for the domain above; optional ## Included Files - [`skills/3x-ui-vps/SKILL.md`](skills/3x-ui-vps/SKILL.md): canonical Agent Skills bundle - [`skills/3x-ui-vps/scripts/`](skills/3x-ui-vps/scripts/): the only allowed remote mutation interface - [`skills/3x-ui-vps/references/`](skills/3x-ui-vps/references/): on-demand reference docs - [`skills/3x-ui-vps/agents/openai.yaml`](skills/3x-ui-vps/agents/openai.yaml): Codex/OpenAI UI metadata - [`.agents/skills`](.agents/skills): repo-scoped Codex compatibility link to the canonical `skills/` directory - [`3x-ui-vps`](3x-ui-vps): transitional compatibility shim to the canonical `skills/3x-ui-vps/` bundle - [`AGENTS.md`](AGENTS.md): lightweight entry point for Cursor and AGENTS-compatible tools - [`.claude-plugin/plugin.json`](.claude-plugin/plugin.json): Claude plugin manifest - [`.claude-plugin/marketplace.json`](.claude-plugin/marketplace.json): Claude marketplace manifest ## Install In Any Agent Skills-Compatible System Use the prompt: ```text Please, install this skill: https://github.com/olegtsvetkov/3x-ui-vpn-skill ``` ## Install In Claude Code or Cowork Install it from the Claude plugin UI or with the CLI: ```bash claude plugin marketplace add olegtsvetkov/3x-ui-vpn-skill claude plugin install 3x-ui-vpn-skills@3x-ui-vpn-skills ``` Then invoke the skill with: ```text /3x-ui-vpn-skills:3x-ui-vps ``` ## Install In Codex The simplest path inside Codex is the built-in `$skill-installer`: ```text $skill-installer install https://github.com/olegtsvetkov/3x-ui-vpn-skill/tree/master/skills/3x-ui-vps ``` Manual installation still works through `$CODEX_HOME/skills` (usually `~/.codex/skills`): 1. Copy or clone [`skills/3x-ui-vps/`](skills/3x-ui-vps/) into `$CODEX_HOME/skills/3x-ui-vps`. 2. Restart Codex. Compatibility note: - the built-in `$skill-installer` currently installs into `$CODEX_HOME/skills` by default - this repo also exposes `.agents/skills` for repo-scoped compatibility with AGENTS-style discovery flows ## Install In Cursor Use the `/create-skill` prompt: ```text /create-skill Please, install this skill to Cursor: https://github.com/olegtsvetkov/3x-ui-vpn-skill ``` ## OpenClaw Compatibility Install it with `clawhub`: ```bash clawhub install 3x-ui-vps ``` Or use the prompt: ```text Please, install this skill: https://github.com/olegtsvetkov/3x-ui-vpn-skill ``` ## Usage Notes - The skill is intentionally script-first. Remote server changes must go through the bundled scripts. - The panel and subscription server are intended to stay loopback-only. - nginx remains the public edge on `80/443`. - The client-facing VPN transport is `VLESS + XHTTP` behind nginx. - The repo-root [`3x-ui-vps`](3x-ui-vps) path is a one-release shim for clones of this repository. Do not use the shim as the canonical install source for new integrations. ## License This repository and the bundled skill are released under the MIT License. See [LICENSE](LICENSE) and [`skills/3x-ui-vps/LICENSE.txt`](skills/3x-ui-vps/LICENSE.txt).