base on An advanced Web Panel • Built for SagerNet/Sing-Box # S-UI **An Advanced Web Panel • Built on SagerNet/Sing-Box**    [](https://img.shields.io/github/downloads/alireza0/s-ui/total.svg) [](https://www.gnu.org/licenses/gpl-3.0.en.html) > **Disclaimer:** This project is only for personal learning and communication, please do not use it for illegal purposes, please do not use it in a production environment **If you think this project is helpful to you, you may wish to give a**:star2: [](https://www.buymeacoffee.com/alireza7) - USDT (TRC20): `TYTq73Gj6dJ67qe58JVPD9zpjW2cc9XgVz` ## Quick Overview | Features | Enable? | | -------------------------------------- | :----------------: | | Multi-Protocol | :heavy_check_mark: | | Multi-Language | :heavy_check_mark: | | Multi-Client/Inbound | :heavy_check_mark: | | Advanced Traffic Routing Interface | :heavy_check_mark: | | Client & Traffic & System Status | :heavy_check_mark: | | Subscription Service (link/json + info)| :heavy_check_mark: | | Dark/Light Theme | :heavy_check_mark: | ## Default Installation Information - Panel Port: 2095 - Panel Path: /app/ - Subscription Port: 2096 - Subscription Path: /sub/ - User/Password: admin ## Install & Upgrade to Latest Version ```sh bash <(curl -Ls https://raw.githubusercontent.com/alireza0/s-ui/master/install.sh) ``` ## Install legacy Version **Step 1:** To install your desired legacy version, add the version to the end of the installation command. e.g., ver `1.0.0`: ```sh VERSION=1.0.0 && bash <(curl -Ls https://raw.githubusercontent.com/alireza0/s-ui/$VERSION/install.sh) $VERSION ``` ## Manual installation 1. Get the latest version of S-UI based on your OS/Architecture from GitHub: [https://github.com/alireza0/s-ui/releases/latest](https://github.com/alireza0/s-ui/releases/latest) 2. **OPTIONAL** Get the latest version of `s-ui.sh` [https://raw.githubusercontent.com/alireza0/s-ui/master/s-ui.sh](https://raw.githubusercontent.com/alireza0/s-ui/master/s-ui.sh) 3. **OPTIONAL** Copy `s-ui.sh` to /usr/bin/ and run `chmod +x /usr/bin/s-ui`. 4. Extract s-ui tar.gz file to a directory of your choice and navigate to the directory where you extracted the tar.gz file. 5. Copy *.service files to /etc/systemd/system/ and run `systemctl daemon-reload`. 6. Enable autostart and start S-UI service using `systemctl enable s-ui --now` 7. Start sing-box service using `systemctl enable sing-box --now` ## Uninstall S-UI ```sh sudo -i systemctl disable sing-box --now systemctl disable s-ui --now rm -f /etc/systemd/system/s-ui.service rm -f /etc/systemd/system/sing-box.service systemctl daemon-reload rm -fr /usr/local/s-ui rm /usr/bin/s-ui ``` ## Install using Docker <details> <summary>Click for details</summary> ### Usage **Step 1:** Install Docker ```shell curl -fsSL https://get.docker.com | sh ``` **Step 2:** Install S-UI > Docker compose method ```shell mkdir s-ui && cd s-ui wget -q https://raw.githubusercontent.com/alireza0/s-ui/master/docker-compose.yml docker compose up -d ``` > Use docker for s-ui only ```shell mkdir s-ui && cd s-ui docker run -itd \ -p 2095:2095 -p 2096:2096 -p 443:443 -p 80:80 \ -v $PWD/db/:/usr/local/s-ui/db/ \ -v $PWD/cert/:/root/cert/ \ --name s-ui --restart=unless-stopped \ alireza7/s-ui:latest ``` > Build your own image ```shell docker build -t s-ui . ``` </details> ## Manual run ( contribution ) <details> <summary>Click for details</summary> ### Build and run whole project ```shell ./runSUI.sh ``` ### - Frontend Frontend codes are in `frontend` folder in the root of repository. To run it locally for instant development you can use (apply automatic changes on file save): ```shell cd frontend npm run dev ``` > By this command it will run a `vite` web server on separate port `3000`, with backend proxy to `http://localhost:2095`. You can change it in `frontend/vite.config.mts`. To build frontend: ```shell cd frontend npm run build ``` ### - Backend Backend codes are in `backend` folder in the root of repository. > Please build frontend once before! To build backend: ```shell cd backend # remove old frontend compiled files rm -fr web/html/* # apply new frontend compiled files cp -R ../frontend/dist/ web/html/ # build go build -o ../sui main.go ``` To run backend (from root folder of repository): ```shell ./sui ``` </details> ## Languages - English - Farsi - Vietnamese - Chinese (Simplified) - Chinese (Traditional) - Russian ## Features - Supported protocols: - General: Mixed, SOCKS, HTTP, HTTPS, Direct, Redirect, TProxy - V2Ray based: VLESS, VMess, Trojan, Shadowsocks - Other protocols: ShadowTLS, Hysteria, Hysteri2, Naive, TUIC - Supports XTLS protocols - An advanced interface for routing traffic, incorporating PROXY Protocol, External, and Transparent Proxy, SSL Certificate, and Port - An advanced interface for inbound and outbound configuration - Clients’ traffic cap and expiration date - Displays online clients, inbounds and outbounds with traffic statistics, and system status monitoring - Subscription service with ability to add external links and subscription - HTTPS for secure access to the web panel and subscription service (self-provided domain + SSL certificate) - Dark/Light theme ## Recommended OS - Ubuntu 20.04+ - Debian 11+ - CentOS 8+ - Fedora 36+ - Arch Linux - Parch Linux - Manjaro - Armbian - AlmaLinux 9+ - Rocky Linux 9+ - Oracle Linux 8+ - OpenSUSE Tubleweed ## Environment Variables <details> <summary>Click for details</summary> ### Usage | Variable | Type | Default | | -------------- | :--------------------------------------------: | :------------ | | SUI_LOG_LEVEL | `"debug"` \| `"info"` \| `"warn"` \| `"error"` | `"info"` | | SUI_DEBUG | `boolean` | `false` | | SUI_BIN_FOLDER | `string` | `"bin"` | | SUI_DB_FOLDER | `string` | `"db"` | | SINGBOX_API | `string` | - | </details> ## SSL Certificate <details> <summary>Click for details</summary> ### Certbot ```bash snap install core; snap refresh core snap install --classic certbot ln -s /snap/bin/certbot /usr/bin/certbot certbot certonly --standalone --register-unsafely-without-email --non-interactive --agree-tos -d <Your Domain Name> ``` </details> ## Stargazers over Time [](https://starchart.cc/alireza0/s-ui) ", Assign "at most 3 tags" to the expected json: {"id":"7825","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"