initial commit

2024-02-13 01:17:03 +01:00
commit f40b27fd8b
136 changed files with 16023 additions and 0 deletions
@@ -0,0 +1,139 @@
+# S-UI
+**An Advanced Web Panel • Built on SagerNet/Sing-Box**
+
+![](https://img.shields.io/github/v/release/alireza0/s-ui.svg)
+![](https://img.shields.io/docker/pulls/alireza7/s-ui.svg)
+[![Downloads](https://img.shields.io/github/downloads/alireza0/s-ui/total.svg)](https://img.shields.io/github/downloads/alireza0/s-ui/total.svg)
+[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](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:
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](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 + info)     | :heavy_check_mark: |
+| Dark/Light Theme                       | :heavy_check_mark: |
+
+
+## Install & Upgrade to Latest Version
+
+```sh
+bash <(curl -Ls https://raw.githubusercontent.com/alireza0/s-ui/master/install.sh)
+```
+
+## Install Custom Version
+
+**Step 1:** To install your desired version, add the version to the end of the installation command. e.g., ver `0.0.1`:
+
+```sh
+bash <(curl -Ls https://raw.githubusercontent.com/alireza0/s-ui/master/install.sh) 0.0.1
+```
+
+## 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
+
+```shell
+mkdir s-ui && cd s-ui
+docker run -itd \
+    -p 2095:2095 -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>
+
+## Languages
+
+- English
+- Farsi
+
+## 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
+
+- CentOS 8+
+- Ubuntu 20+
+- Debian 10+
+- Fedora 36+
+
+## 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
+
+[![Stargazers over time](https://starchart.cc/alireza0/s-ui.svg)](https://starchart.cc/alireza0/s-ui)