KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

SharX

★ 164 Open GitHub ↗

SharX — modern multi-node Xray management platform based on 3XUI with Docker-first architecture, PostgreSQL, encrypted web sessions, MTProto integration, visual subscription page builder, and built-in observability support (Prometheus, Loki, VictoriaMetrics, Grafana export).

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=0,2,3,5,30&height=300&section=header&text=SharX&fontSize=70&fontAlignY=40&animation=fadeIn&fontColor=gradient&desc=Multi-Node%20%7C%20Subscription%20Builder%20%7C%20Observability&descSize=25&descAlignY=60" width="100%"/>

</div>

[English](README_EN.md) | [Русский](README_RU.md) | [فارسی](README_FA.md)

</div>

## Welcome to SharX / Добро пожаловать в SharX

**SharX** is a modern multi-node Xray management platform with Docker-first deployment, observability hooks, and a visual subscription page builder.

**SharX** — современная multi-node платформа управления Xray с Docker-сборкой, наблюдаемостью и визуальным конструктором страницы подписки.

This version brings a modern, Docker-first architecture, **multi-node** workers, a **visual subscription page builder**, **encrypted cookie-based web sessions**, and **optional observability** hooks (Prometheus text metrics, optional Loki / VictoriaMetrics in settings, Grafana dashboard JSON export).

Эта версия даёт современную Docker-сборку, **multi-node** worker-узлы, **визуальный конструктор страницы подписки**, **веб-сессии в зашифрованных cookie** и **опциональную наблюдаемость** (метрики в формате Prometheus, опционально Loki/VictoriaMetrics в настройках, JSON дашборда для Grafana).

## Quick Start / Быстрый старт

### 🚀 Install / Установка

Клонируйте и запустите:

```bash
git clone https://github.com/konstpic/SharX.git
cd SharX
sudo bash ./install_ru.sh
```

---

<details>
<summary><b>📜 Script Installation (Recommended) / Установка через скрипт (Рекомендуется)</b></summary>

### Automatic Installation / Автоматическая установка

The install script supports multiple Linux distributions and automatically:
- Installs Docker and Docker Compose
- Configures network mode (host/bridge)
- Sets up SSL certificates (Let's Encrypt for domain or IP)
- Generates secure database password
- Creates and starts all services

Скрипт установки поддерживает множество дистрибутивов Linux и автоматически:
- Устанавливает Docker и Docker Compose
- Настраивает режим сети (host/bridge)
- Настраивает SSL сертификаты (Let's Encrypt для домена или IP)
- Генерирует безопасный пароль базы данных
- Создаёт и запускает все сервисы

#### Supported Systems / Поддерживаемые системы

| Distribution | Package Manager |
|--------------|-----------------|
| Ubuntu/Debian | apt |
| Fedora | dnf |
| Arch Linux | pacman |
| Alpine | apk |
| openSUSE | zypper |

#### Panel Installation / Установка панели

```bash
sudo ./install.sh
# Select: 1) Install Panel
```

```bash
sudo ./install_ru.sh
# Выбрать: 1) Установить панель
```

#### Management Menu / Меню управления

After installation, run the script again to access the management menu:

После установки запустите скрипт снова для доступа к меню управления:

```bash
sudo ./install.sh
```

**Menu options / Опции меню:**
- Update Panel / Обновить панель
- Start/Stop/Restart services
- Change ports
- Renew SSL certificates
- View logs and status

**Panel updates / Обновление панели:** **Watchtower** in the same stack + `XUI_DOCKER_UPDATER_*` (in-UI update), or `docker compose pull` + `up -d`, or the SharX script **Update Panel** (pulls `sharx` + `watchtower`). / **Watchtower** в стеке и UI, либо `docker compose pull`, либо **2)** в `install_*.sh`. Set `WATCHTOWER_HTTP_API_TOKEN` in production. / `WATCHTOWER_HTTP_API_TOKEN` в `.env` для production. If you used `build:` in compose, the image name (e.g. `sharx-code-sharx`) is not pullable; use a Harbor `image:` and `docker login` — see README_RU/EN.

**Remote nodes / Удалённые узлы:** enable **multi-node**, **add node** and copy **`docker-compose.yml`** from the modal (`PANEL_URL` + `SECRET_KEY` pairing), then on the worker `docker compose up -d --build`. Manage in **Nodes** / **Geography**. Install script only deploys the panel. / Включите **multi-node**, в **Нодах** скопируйте compose из модалки, на узле — `docker compose up -d --build`. Подробно: [node/README.md](https://github.com/konstpic/sharx-code/blob/main/node/README.md).

</details>

---

<details>
<summary><b>🔧 Manual Installation / Ручная установка</b></summary>

### Panel Installation / Установка панели

1. **Clone the repository / Клонируйте репозиторий:**
   ```bash
   git clone https://github.com/konstpic/SharX.git
   cd SharX
   ```

2. **Configure `docker-compose.yml` / Настройте `docker-compose.yml`:**
   - Change `change_this_password` to a secure password
   - Измените `change_this_password` на надёжный пароль
   - **Specify image version / Укажите версию образа:** You can manually set a specific version tag in the `image` field
   - **Указать версию образа:** Вы можете вручную указать конкретную версию в поле `image`
   ```yaml
   services:
     sharx:
       image: harbor.sharxconnect.app/sharx/sharx:latest  # Specify version here / Укажите версию здесь
     postgres:
       image: harbor.sharxconnect.app/sharx/postgres:16-alpine
   ```yaml
   XUI_DB_PASSWORD: your_secure_password
   POSTGRES_PASSWORD: your_secure_password
   ```

3. **Prepare SSL certificates / Подготовьте SSL сертификаты:**
   ```bash
   mkdir -p cert
   cp /path/to/fullchain.pem cert/fullchain.pem
   cp /path/to/privkey.pem cert/privkey.pem
   ```

4. **Start services / Запустите сервисы:**
   ```bash
   docker compose up -d
   ```

5. **Access the panel / Откройте панель:**
   ```
   http://your-server-ip:2053
   ```

6. **Configure TLS in panel settings / Настройте TLS в панели:**
   - Certificate: `/app/cert/fullchain.pem`
   - Private Key: `/app/cert/privkey.pem`

7. **Remote nodes (optional) / Удалённые узлы (по желанию):** multi-node + compose from the **add node** modal; see [node/README.md](https://github.com/konstpic/sharx-code/blob/main/node/README.md). / Multi-node и docker-compose из модалки добавления узла — [node/README.md](https://github.com/konstpic/sharx-code/blob/main/node/README.md).

</details>

---

## Key Features / Основные возможности

- **Multi-node**: One panel controls many worker nodes (REST node API, geography / host overrides)
- **PostgreSQL**: Primary database with in-repo migrations; optional **SQLite → PostgreSQL** import for legacy panel backups
- **Encrypted cookie sessions**: Standard stack uses signed/encrypted browser cookies (Gin session store)
- **Observability (optional)**: `GET {basePath}panel/metrics` (Prometheus text); optional Loki log push and VictoriaMetrics URL in panel settings; downloadable Grafana dashboard JSON for **your** stack (Grafana itself is not bundled by default)
- **Docker + Watchtower**: Pre-built images; in-stack or manual updates
- **Subscription page builder**: Block-based public subscription page (`/panel/api/public/subscription`) — see below
- **Xray core config profiles**: Reusable core JSON merged into worker configs in multi-node mode
- **Telemt (MTProto)**: Sidecars on panel (standalone) and workers (multi-node), separate lifecycle from Xray where applicable
- **HWID (beta)**: Per-client device limits (Happ, V2RayTun)
- **Auto SSL**: Let's Encrypt via install scripts / acme workflow
- **Environment-based config**: Panel, sub, and DB settings via env (see full docs)

- **Multi-node**: одна панель и множество worker-узлов (REST API узла, география / host overrides)
- **PostgreSQL**: основная БД и миграции в репозитории; опциональный **импорт SQLite → PostgreSQL** со старых бэкапов панели
- **Сессии в cookie**: веб-сессии в подписанных/зашифрованных cookie (Gin session store)
- **Наблюдаемость (опционально)**: `GET {basePath}panel/metrics` (текст Prometheus); опционально Loki и VictoriaMetrics в настройках панели; JSON дашборда для импорта в **ваш** Grafana (сам Grafana по умолчанию не входит в compose)
- **Docker + Watchtower**: готовые образы; обновления из стека или вручную
- **Конструктор страницы подписки**: блоковая публичная страница (`/panel/api/public/subscription`) — см. ниже
- **Профили конфига Xray (core)**: общий core JSON, мердж в конфиг worker в multi-node
- **Telemt (MTProto)**: sidecar на панели (single-node) и на worker; жизненный цикл отделён от Xray где задумано
- **HWID (бета)**: лимит устройств на клиента (Happ, V2RayTun)
- **Авто SSL**: Let's Encrypt через скрипты установки / acme
- **Конфиг через env**: панель, подписка, БД — см. полные README_EN/RU

## Supported Protocols / Поддерживаемые протоколы

- **VMESS**
- **VLESS**
- **Trojan**
- **Shadowsocks**
- **Hysteria / Hysteria2**
- **Mixed (SOCKS/HTTP)**
- **WireGuard**
- **HTTP/Tunnel (for specific transport and routing scenarios)**
- **Telemt (MTProto sidecar integration for Telegram proxy flows)**

## Subscription Page Builder / Конструктор страницы подписки

SharX includes a built-in visual constructor for the public subscription page (`/panel/api/public/subscription`) with block-based layout and per-brand customization.

В SharX есть встроенный визуальный конструктор публичной страницы подписки (`/panel/api/public/subscription`) с блочной структурой и кастомизацией под бренд.

**What you can configure / Что можно настраивать:**
- Branding and theme (title, logo, colors, locale)
- Installation guides and app catalog (including Telegram MTProto flow when enabled)
- Add-to-app buttons and deep links
- Response rules (headers, profile metadata, announce/support links)
- Custom HTML/content blocks and ordering
- JSON templates and preview before publishing

## Documentation / Документация

For detailed installation instructions, configuration, and migration guide, please see:

Для подробных инструкций по установке, настройке и миграции, пожалуйста, смотрите:

- **[Full English Documentation](README_EN.md)** - Complete guide in English
- **[Полная русская документация](README_RU.md)** - Полное руководство на русском языке
- **[API Documentation](docs/API.md)** - REST API reference / Справочник REST API

## For Developers / Для разработчиков

Source code repository / Репозиторий исходного кода:

- **[Source Code Repository](https://github.com/konstpic/sharx-code)** - Main codebase for SharX panel and node / Основной репозиторий кода панели SharX и узла

## Requirements / Требования

- Linux server (Ubuntu, Debian, CentOS, Fedora, Arch, Alpine, openSUSE)
- Root access
- Domain name (optional, for TLS with domain)
- Port 80 open (for SSL certificate issuance)

- Linux сервер (Ubuntu, Debian, CentOS, Fedora, Arch, Alpine, openSUSE)
- Root доступ
- Доменное имя (опционально, для TLS с доменом)
- Открытый порт 80 (для выпуска SSL сертификата)

## Support / Поддержка

For issues, questions, or contributions, please refer to the project repository.

По вопросам, проблемам или вкладу в проект обращайтесь в репозиторий проекта.

## Authors / Авторы

**Project Author / Автор проекта:**
- [@konspic](https://github.com/konstpic)

## Donate / Донаты 💵

Support SharX development — card, crypto, and other payment methods:

Поддержите развитие SharX — карта, криптовалюта и другие способы оплаты:

- **[donate.konstpic.ru](https://donate.konstpic.ru/)**

---

**Note**: This version uses Docker containers for easy deployment. All images are pre-built and ready to use.

**Примечание**: Эта версия использует Docker-контейнеры для легкого развертывания. Все образы предварительно собраны и готовы к использованию.

<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=0,2,3,5,30&height=300&section=footer&animation=fadeIn" width="100%"/>

</div>

SharX

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README