crasivo/3x-ui repository overview

⁠🧬 3X-UI

This repository contains ready-made images for running 3X-UI⁠ in isolated containers (docker/podman).

⁠What is 3X-UI

3X-UI — is a modern and functional web control panel designed for easy configuration and administration of the powerful Xray core. It allows you to deploy a full-fledged proxy server in a few clicks with support for the most up-to-date and secure protocols such as VLESS, VMess, Trojan, Shadowsocks, and Hysteria2.

Main advantages:

1. Versatility: Support for advanced blocking bypass mechanisms, including Reality, XTLS, and gRPC.
2. Convenience: Intuitive multi-language web interface with detailed traffic consumption statistics for each user.
3. Flexibility: Built-in tools for managing SSL certificates, generating QR codes for client connections, and configuring routing rules.
4. Security: Ability to restrict access to the panel by IP, change ports, and configure multi-user access with individual limits.

⁠⚠️ Disclaimer

This project and the provided Docker images are intended for educational purposes and personal use only.

1. Responsibility: The author is not responsible for any damage, data loss, or consequences resulting from the use of this software. You use it at your own risk.
2. Legality: You are fully personally responsible for complying with the local laws of your country when using this tool. The author does not encourage or support actions that violate the law.
3. Security: Despite the use of proven components, always check the configurations before using them in production environments.

Implementation features:

• ✅ Root & Rootless container launch modes.
• ✅ Using packages from official repositories (3X-UI/XRay Core).
• ✅ Automatic update of 3X-UI, XRay & GeoData.
• ✅ Easy customization of container launch (ENTRYPOINT).
• ✅ Configuration control via environment variables.
• ✅ Built-in healtcheck to control the service status.

⁠🚀 Quick start

Example commands to start the service via Docker Run⁠:

# Root
$ docker run -d --name 3x-ui -p 2053:2053 crasivo/3x-ui
# Rootless
$ docker run -d --name 3x-ui -p 2053:2053 --user xray crasivo/3x-ui

After a successful launch, you can go to the control panel at http://localhost:2053⁠ Login details — admin:admin. Fine-tuning for starting the container is described below.

Below is an example of a simple docker-compose.yml configuration file for starting the service via Docker Compose⁠.

name: 3x-ui

services:
  3x-ui:
    image: crasivo/3x-ui
    container_name: 3x-ui
    restart: unless-stopped
    environment:
      - "XUI_ADMIN_USERNAME=admin"
      - "XUI_ADMIN_PASSWORD=2UWGn9Ptw6mHmYEPqsvH"
    network_mode: host
    hostname: 3x-ui

⁠🕹️ Usage

⁠Environment variables

The image supports service configuration via environment variables.

Summary table of available environment variables:

⁠📜 License

This project is distributed under the MIT⁠ license.