3X-UI on your VPS

Install

claude plugin marketplace add olegtsvetkov/3x-ui-vpn-skill
claude plugin install 3x-ui-vpn-skills@3x-ui-vpn-skills

This is third-party code. Review the repository files before installing.

What it does

The skill sets up a VPS from scratch: installs dependencies, locks ports down with ufw, runs 3X-UI in Docker Compose and nginx on ports 80 and 443 with a Let's Encrypt certificate. The panel and subscription server listen on loopback only, and the panel is reached through an SSH tunnel. It has five workflows: fresh deploy, panel access, VLESS inbound bootstrap, adding a client and updates. All server changes go through the bundled scripts only.

Who it is for. People with a VPS and a domain who want their own Xray server without configuring nginx and Docker by hand.

Example request

/3x-ui-vpn-skills:3x-ui-vps set up a VPN on root@203.0.113.10 with domain vpn.example.com

Limitations

Built for Ubuntu 24+ or Debian with apt and a root user. The domain must already resolve to the server. Both the server and your machine need outbound internet for Docker, ACME and panel API calls. Model auto-invocation is disabled, so the skill runs only when called explicitly.

How to disable. In Claude Code remove the plugin via /plugin. In Codex delete the 3x-ui-vps folder from $CODEX_HOME/skills.

Security check

• Uses root SSH access to a remote server
• Installs packages and changes firewall rules and nginx configuration
• May ask for the root password in plain text

README in short

The repository holds the 3x-ui-vps skill and is also a Claude Code plugin under the 3x-ui-vpn-skills namespace. The skill installs Xray VLESS with the 3X-UI panel on an Ubuntu VPS in about 10 minutes. Client transport is VLESS + XHTTP behind nginx, and the panel stays loopback-only. Installation is documented for Claude Code, Codex, Cursor and OpenClaw. MIT license.

SKILL.md

---
name: 3x-ui-vps
description: Deploy and manage 3X-UI on a root-managed Ubuntu or Debian VPS using Docker Compose, nginx, ACME certificates, SSH panel tunneling, UFW hardening, and Xray VLESS over XHTTP behind nginx. Use when the user explicitly wants to install 3X-UI from scratch, lock the panel and subscription server to 127.0.0.1, open an SSH tunnel to the panel, create or repair a VLESS inbound behind nginx on public 443, add extra clients to an existing inbound, or run safe OS and container updates.
disable-model-invocation: true
metadata:
  openclaw:
    requires:
      bins:
        - bash
        - python3
        - ssh
---

# 3X-UI VPS

Deploy 3X-UI on a VPS with the panel and subscription server bound to loopback, `ufw` allowing only SSH/HTTP/HTTPS, nginx on public `80/443`, and one `VLESS + XHTTP` transport routed through nginx.

This skill is manual-first because it mutates remote infrastructure. Invoke it only when the user explicitly asks to deploy, repair, harden, or update a VPS.

## Hard rule

- All server-side configuration must be executed only through the bundled scripts in this skill.
- Do not create or edit remote configs manually over SSH, do not run ad-hoc heredocs on the server, and do not "quick-fix" nginx, Docker, ACME, or 3X-UI by hand.
- Read-only inspection commands are allowed for diagnosis.
- If a script fails because the host is in an unexpected state, stop changing the server, patch the relevant script locally in this skill, and rerun the script.
- The manual fallback in this skill is for the 3X-UI panel UI only. It is not permission to mutate server files manually.

## Inputs

Collect these before doing any work:

- `ssh target` for the VPS, preferably `root@host`
- optional plain-text SSH password if the host is password-auth only
- public domain pointed at the VPS
- optional ACME email
- panel admin username and password
- optional local tunnel port

Assume Ubuntu or Debian with `apt`. Do not use this skill on other distributions without adapting the Docker repository setup first.

The operator workstation and the target VPS also need outbound internet access for Docker downloads, ACME issuance, and panel API calls.

Related