Spark
Sign In
Skill

Deploy Xray VLESS VPN Server

Sets up a self-hosted Xray VLESS VPN on your own VPS in about 10 minutes, using the 3X-UI panel for installation and client management.

Get skill
Works with github
NeuralDeep
Own this? Claim it
91
Spark score
out of 100
Updated 4 months ago
Version 1.1.0
Models
claude
Add to Favorites

Why it matters

Effortlessly deploy a modern VPN server using Xray VLESS with a single command. Secure your network and manage access with this streamlined setup.

Outcomes

What it gets done

01

Deploy VPN server in one command

02

Configure Xray VLESS for enhanced security

03

Manage VPN access and network security

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/3x-ui-vpn-skill | bash

Overview

3X-UI VPN Setup

Sets up a self-hosted Xray VLESS VPN on your own VPS through the 3X-UI panel, in about 10 minutes via chat. Covers fresh deployment, SSH-tunneled panel access, inbound bootstrap behind nginx, adding client devices, and system updates. Use it when you want to run your own VPN on a VPS instead of a third-party provider, and are ready to hand over SSH root access, a domain, and panel credentials for the setup. It is script-first and manual-first because it changes remote infrastructure.

What it does

3X-UI VPN Setup runs an Xray VLESS VPN on a VPS you control, using the 3X-UI panel for installation and ongoing management, in about 10 minutes end to end. The bundle offers five workflows: Fresh deploy (dependency installation, port hardening, and base setup on a clean server), Panel access (opens an SSH tunnel from the server to your machine so you can reach the 3X UI panel), Quick inbound bootstrap (creates an Xray VLESS inbound on port 443 with nginx in front of it), Add another client to an existing inbound (adds one more device to an already-configured inbound), and Updates (runs apt update/apt upgrade plus updates 3X UI itself).

When to use - and when NOT to

Use it when you have a fresh VPS (Ubuntu 24+, 1 vCPU, 512 MB RAM, 10 GB disk, at any hosting provider) and want a working, self-hosted VPN without manually running each install and configuration step. It is explicitly manual-first because it changes remote infrastructure - it will ask for an SSH target and root password (or rely on existing key-based auth), a domain, and panel credentials before doing anything. Server changes only ever go through the skill's bundled scripts, never ad hoc commands, and the panel/subscription server are meant to stay loopback-only behind nginx rather than exposed directly.

Inputs and outputs

After invoking the skill (e.g. $3x-ui-vps, set up a VPN for me in Codex, or /3x-ui-vpn-skills:3x-ui-vps in Claude Code), it asks for: the SSH target (root@X.Y.Z.A), the SSH password if key auth isn't already set up, a domain or subdomain to serve the VPN from, a username and password for the 3X UI panel, and an optional ACME email for issuing a Let's Encrypt certificate for that domain. The output is a running Xray VLESS server (transport VLESS + XHTTP) behind nginx on ports 80/443, manageable through the 3X UI panel reached over an SSH tunnel, plus the ability to add further client devices to the same inbound afterward.

Integrations

The skill installs the same way across several agent runtimes: as a Claude Code/Cowork plugin (claude plugin marketplace add / claude plugin install), via Codex's built-in $skill-installer, via Cursor's /create-skill prompt, or via OpenClaw's clawhub install 3x-ui-vps. A repo-root 3x-ui-vps path exists only as a transitional one-release compatibility shim and is not meant to be used as the canonical install source for new integrations - the canonical bundle is skills/3x-ui-vps/.

Who it's for

Anyone who wants to run their own VPN server - for personal privacy, bypassing restrictive networks, or avoiding third-party VPN providers - on a VPS they already control, without hand-configuring Xray, VLESS, and nginx themselves.

Source README

English | Russian

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/.

Architecture details: 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:

$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

Install In Any Agent Skills-Compatible System

Use the prompt:

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:

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:

/3x-ui-vpn-skills:3x-ui-vps

Install In Codex

The simplest path inside Codex is the built-in $skill-installer:

$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/ 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:

/create-skill Please, install this skill to Cursor: https://github.com/olegtsvetkov/3x-ui-vpn-skill

OpenClaw Compatibility

Install it with clawhub:

clawhub install 3x-ui-vps

Or use the prompt:

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 path is a one-release shim for clones of this repository. Do not use the shim as the canonical install source for new integrations.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.