From b8e132fc0be6b6ff002ab34a4138cfd287010842 Mon Sep 17 00:00:00 2001 From: Muse Date: Tue, 20 Oct 2026 12:40:52 +0000 Subject: [PATCH] =?UTF-8?q?=E9=93=BE=E6=8E=A5=E8=BF=81=E7=A7=BB:=206=20?= =?UTF-8?q?=E4=B8=AA=E5=A4=9A=E8=AF=AD=E8=A8=80=20README=20=E4=B8=8E=20CON?= =?UTF-8?q?TRIBUTING=20=E6=94=B9=E6=8C=87=E6=9C=AC=E4=BB=93=20Gitea?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 快速开始主命令改指本仓 install-master.sh (Gitea raw); 无等价物的 指定版本/dev 通道一键命令替换为指向主 README 的英文说明行 (小节结构保留) - 删除 5 个绑定上游仓库的 shields/pkg.go.dev 徽章 (无 Gitea 等价物); Wiki 链接改指本仓首页; Docker 示例镜像由上游发布的 ghcr.io/mhsanaei/3x-ui 改为本地构建的 3x-ui-agent:local (fork 不发布注册表镜像) - 删除上游作者个人捐赠锚点 (buymeacoffee/nowpayments) 与 starchart 上游统计小节 - CONTRIBUTING: clone 地址与 Issues 链接改指本仓 Gitea --- CONTRIBUTING.md | 6 +++--- README.ar_EG.md | 27 +++++---------------------- README.es_ES.md | 28 +++++----------------------- README.fa_IR.md | 28 +++++----------------------- README.ru_RU.md | 28 +++++----------------------- README.tr_TR.md | 28 +++++----------------------- README.zh_CN.md | 29 ++++++----------------------- 7 files changed, 34 insertions(+), 140 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a321769..4e5a580 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,8 +50,8 @@ Cross-building the Linux SQLite target from Windows (or vice versa) requires a s ## First-time setup ```bash -git clone https://github.com/MHSanaei/3x-ui.git -cd 3x-ui +git clone https://git.881218.xyz/rogue/3x-ui-agent.git +cd 3x-ui-agent cp .env.example .env @@ -315,6 +315,6 @@ must match the override, for example `XUI_PORT: "8080"` with `ports: ["8080:8080 ## Issues -- Bug reports and feature requests: [GitHub Issues](https://github.com/MHSanaei/3x-ui/issues) +- Bug reports and feature requests: [Issues](https://git.881218.xyz/rogue/3x-ui-agent/issues) Before filing a bug, include the OS, Go version, panel version (`/panel/api/server/status` or the dashboard footer), and the relevant excerpt from `x-ui/3xui.log`. diff --git a/README.ar_EG.md b/README.ar_EG.md index 1a02692..2e4f95d 100644 --- a/README.ar_EG.md +++ b/README.ar_EG.md @@ -8,12 +8,7 @@

- Release - Build - GO Version - Downloads License - Go Reference

**3X-UI** هي لوحة تحكم ويب متقدمة ومفتوحة المصدر لإدارة خوادم [Xray-core](https://github.com/XTLS/Xray-core). توفّر واجهة نظيفة ومتعددة اللغات لنشر وتكوين ومراقبة مجموعة واسعة من بروتوكولات الوكيل وVPN — من خادم VPS واحد إلى عمليات النشر متعددة العقد. @@ -69,24 +64,24 @@ ## البدء السريع ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` لتثبيت إصدار محدد، أضِف وسمه (مثل `v3.4.0`): ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` لتثبيت بنية **dev** المتجددة (أحدث إصدار أولي لكل التزام (commit) من `main`، وليس إصدارًا مستقرًا)، مرّر `dev-latest`: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` أثناء التثبيت، يتم إنشاء اسم مستخدم وكلمة مرور ومسار وصول عشوائية. بعد التثبيت، شغّل `x-ui` لفتح قائمة الإدارة، حيث يمكنك بدء/إيقاف الخدمة، وعرض أو إعادة تعيين بيانات تسجيل الدخول، وإدارة شهادات SSL، والمزيد. -للحصول على الوثائق الكاملة، يرجى زيارة [ويكي المشروع](https://github.com/MHSanaei/3x-ui/wiki). +للحصول على الوثائق الكاملة، يرجى زيارة [ويكي المشروع](https://git.881218.xyz/rogue/3x-ui-agent). ### التثبيت غير التفاعلي @@ -139,7 +134,7 @@ docker compose --profile postgres up -d تتضمن الصورة Fail2ban (مُفعَّل افتراضيًا) لفرض **حدود IP** لكل عميل. يحظر Fail2ban المخالفين باستخدام `iptables`، الذي يتطلب صلاحية `NET_ADMIN`. يمنح `docker-compose.yml` هذه الصلاحية مسبقًا عبر `cap_add`؛ إذا شغّلت الحاوية باستخدام `docker run` بدلاً من ذلك، فأضِف الصلاحيات بنفسك، وإلا فسيتم تسجيل عمليات الحظر دون تطبيقها أبدًا: ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## متغيرات البيئة @@ -191,15 +186,3 @@ English · فارسی · العربية · 中文（简体） · 中文（繁體 ## دعم المشروع **إذا كان هذا المشروع مفيدًا لك، فقد ترغب في إعطائه**:star2: - - -Buy Me A Coffee - -
- - Crypto donation button by NOWPayments - - -## النجوم عبر الزمن - -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) diff --git a/README.es_ES.md b/README.es_ES.md index bd025f5..ffb9f4d 100644 --- a/README.es_ES.md +++ b/README.es_ES.md @@ -8,12 +8,7 @@

- Release - Build - GO Version - Downloads License - Go Reference

**3X-UI** es un panel de control web avanzado y de código abierto para gestionar servidores [Xray-core](https://github.com/XTLS/Xray-core). Ofrece una interfaz limpia y multilingüe para desplegar, configurar y monitorear una amplia gama de protocolos de proxy y VPN — desde un único VPS hasta despliegues multinodo. @@ -69,24 +64,24 @@ Construido como un fork mejorado del proyecto X-UI original, 3X-UI añade un sop ## Inicio Rápido ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` Para instalar una versión específica, añade su etiqueta (p. ej. `v3.4.0`): ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` Para instalar la versión **dev** continua (la última prelanzamiento por commit desde `main`, no una versión estable), pasa `dev-latest`: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` Durante la instalación se generan un nombre de usuario, una contraseña y una ruta de acceso aleatorios. Tras la instalación, ejecuta `x-ui` para abrir el menú de gestión, donde puedes iniciar/detener el servicio, ver o restablecer tus credenciales de acceso, gestionar certificados SSL y mucho más. -Para la documentación completa, visita la [Wiki del proyecto](https://github.com/MHSanaei/3x-ui/wiki). +Para la documentación completa, visita la [Wiki del proyecto](https://git.881218.xyz/rogue/3x-ui-agent). ### Instalación desatendida @@ -139,7 +134,7 @@ docker compose --profile postgres up -d La imagen incluye Fail2ban (habilitado de forma predeterminada) para aplicar **límites de IP** por cliente. Fail2ban banea a los infractores con `iptables`, lo que requiere la capacidad `NET_ADMIN`. `docker-compose.yml` ya la concede mediante `cap_add`; si en su lugar inicias el contenedor con `docker run`, añade tú mismo las capacidades, de lo contrario los baneos se registran pero nunca se aplican: ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## Variables de Entorno @@ -191,16 +186,3 @@ Herramientas e integraciones construidas por la comunidad alrededor de 3x-ui. ## Apoyar el Proyecto **Si este proyecto te es útil, puedes darle una**:star2: - - -Buy Me A Coffee - - -
- - Crypto donation button by NOWPayments - - -## Estrellas a lo Largo del Tiempo - -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) diff --git a/README.fa_IR.md b/README.fa_IR.md index 5a232ba..6b68a0e 100644 --- a/README.fa_IR.md +++ b/README.fa_IR.md @@ -8,12 +8,7 @@

- Release - Build - GO Version - Downloads License - Go Reference

**3X-UI** یک پنل کنترل وب پیشرفته و متن‌باز برای مدیریت سرورهای [Xray-core](https://github.com/XTLS/Xray-core) است. این پنل یک رابط کاربری تمیز و چندزبانه برای استقرار، پیکربندی و نظارت بر طیف گسترده‌ای از پروتکل‌های پراکسی و VPN ارائه می‌دهد — از یک VPS تکی تا استقرارهای چندنودی. @@ -69,24 +64,24 @@ ## شروع سریع ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` برای نصب یک نسخه‌ی مشخص، تگ آن را در انتها اضافه کنید (مثلاً `v3.4.0`): ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` برای نصب نسخه‌ی غلتانِ **dev** (آخرین پیش‌انتشار به‌ازای هر کامیت از شاخه‌ی `main`، نه یک انتشار پایدار)، مقدار `dev-latest` را پاس دهید: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` در حین نصب، یک نام کاربری، رمز عبور و مسیر دسترسی تصادفی تولید می‌شود. پس از نصب، دستور `x-ui` را اجرا کنید تا منوی مدیریت باز شود؛ در آنجا می‌توانید سرویس را شروع/متوقف کنید، اطلاعات ورود خود را ببینید یا بازنشانی کنید، گواهی‌های SSL را مدیریت کنید و کارهای دیگری انجام دهید. -برای مستندات کامل، لطفاً به [ویکی پروژه](https://github.com/MHSanaei/3x-ui/wiki) مراجعه کنید. +برای مستندات کامل، لطفاً به [ویکی پروژه](https://git.881218.xyz/rogue/3x-ui-agent) مراجعه کنید. ### نصب بدون نظارت @@ -139,7 +134,7 @@ docker compose --profile postgres up -d این ایمیج، Fail2ban را (که به‌صورت پیش‌فرض فعال است) برای اعمال **محدودیت‌های IP** به‌ازای هر کلاینت همراه دارد. ‏Fail2ban متخلفان را با `iptables` مسدود می‌کند که به مجوز `NET_ADMIN` نیاز دارد. فایل `docker-compose.yml` این مجوز را از قبل از طریق `cap_add` می‌دهد؛ اگر به‌جای آن کانتینر را با `docker run` اجرا می‌کنید، خودتان مجوزها را اضافه کنید، در غیر این صورت مسدودسازی‌ها فقط ثبت می‌شوند اما هرگز اعمال نمی‌شوند: ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## متغیرهای محیطی @@ -191,16 +186,3 @@ English · فارسی · العربية · 中文（简体） · 中文（繁體 ## پشتیبانی از پروژه **اگر این پروژه برای شما مفید است، می‌توانید به آن یک**:star2: بدهید - - -Buy Me A Coffee - - -
- - Crypto donation button by NOWPayments - - -## ستاره‌ها در طول زمان - -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) diff --git a/README.ru_RU.md b/README.ru_RU.md index 204fb7a..bbfbf8b 100644 --- a/README.ru_RU.md +++ b/README.ru_RU.md @@ -8,12 +8,7 @@

- Release - Build - GO Version - Downloads License - Go Reference

**3X-UI** — продвинутая веб-панель управления с открытым исходным кодом для управления серверами [Xray-core](https://github.com/XTLS/Xray-core). Она предоставляет аккуратный многоязычный интерфейс для развёртывания, настройки и мониторинга широкого спектра протоколов прокси и VPN — от одного VPS до развёртываний с несколькими узлами. @@ -69,24 +64,24 @@ ## Быстрый старт ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` Чтобы установить конкретную версию, добавьте её тег (например, `v3.4.0`): ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` Чтобы установить скользящую **dev**-сборку (новейший предварительный релиз по каждому коммиту из ветки `main`, а не стабильный релиз), передайте `dev-latest`: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` Во время установки генерируются случайные имя пользователя, пароль и путь доступа. После установки выполните `x-ui`, чтобы открыть меню управления, где можно запускать/останавливать сервис, просматривать или сбрасывать учётные данные для входа, управлять SSL-сертификатами и многое другое. -Полную документацию смотрите в [вики проекта](https://github.com/MHSanaei/3x-ui/wiki). +Полную документацию смотрите в [вики проекта](https://git.881218.xyz/rogue/3x-ui-agent). ### Автоматическая установка @@ -139,7 +134,7 @@ docker compose --profile postgres up -d Образ включает Fail2ban (включён по умолчанию) для применения **лимитов IP** по каждому клиенту. Fail2ban блокирует нарушителей с помощью `iptables`, что требует возможности `NET_ADMIN`. `docker-compose.yml` уже предоставляет её через `cap_add`; если вы вместо этого запускаете контейнер через `docker run`, добавьте возможности самостоятельно, иначе блокировки будут регистрироваться, но никогда не применяться: ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## Переменные окружения @@ -191,16 +186,3 @@ English · فارسی · العربية · 中文（简体） · 中文（繁體 ## Поддержка проекта **Если этот проект полезен для вас, вы можете поставить ему**:star2: - - -Buy Me A Coffee - - -
- - Crypto donation button by NOWPayments - - -## Звезды с течением времени - -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) diff --git a/README.tr_TR.md b/README.tr_TR.md index 152b721..35588c0 100644 --- a/README.tr_TR.md +++ b/README.tr_TR.md @@ -8,12 +8,7 @@

- Release - Build - GO Version - Downloads License - Go Reference

**3X-UI**, [Xray-core](https://github.com/XTLS/Xray-core) sunucularını yönetmek için geliştirilmiş profesyonel, açık kaynaklı bir web kontrol panelidir. Tek bir sanal sunucudan (VPS) çok düğümlü (multi-node) dağıtımlara kadar çok çeşitli proxy ve VPN protokollerini kurmak, yapılandırmak ve izlemek için temiz, çok dilli bir arayüz sağlar. @@ -69,24 +64,24 @@ Orijinal X-UI projesinin geliştirilmiş bir çatallaması (fork) olarak inşa e ## Hızlı Başlangıç ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` Belirli bir sürümü kurmak için, etiketini (ör. `v3.4.0`) ekleyin: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` Sürekli güncellenen **dev** sürümünü (kararlı bir sürüm değil; `main` dalından her commit'te oluşturulan en son ön sürüm) kurmak için `dev-latest` değerini geçirin: ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` Kurulum sırasında rastgele bir kullanıcı adı, şifre ve erişim yolu oluşturulur. Kurulumdan sonra, hizmeti başlatabileceğiniz/durdurabileceğiniz, giriş bilgilerinizi görüntüleyebileceğiniz veya sıfırlayabileceğiniz, SSL sertifikalarını yönetebileceğiniz ve çok daha fazlasını yapabileceğiniz yönetim menüsünü açmak için terminalde `x-ui` komutunu çalıştırın. -Tam dokümantasyon için lütfen [proje Wiki sayfasını](https://github.com/MHSanaei/3x-ui/wiki) ziyaret edin. +Tam dokümantasyon için lütfen [proje Wiki sayfasını](https://git.881218.xyz/rogue/3x-ui-agent) ziyaret edin. ### Etkileşimsiz kurulum @@ -139,7 +134,7 @@ docker compose --profile postgres up -d Docker imajı, kullanıcı başına **IP limitlerini** zorunlu kılmak için Fail2ban ile (varsayılan olarak etkindir) paketlenmiştir. Fail2ban, ihlalcileri `iptables` ile engeller ve bunun için `NET_ADMIN` yetkisine ihtiyaç duyar. `docker-compose.yml` bunu zaten `cap_add` üzerinden vermektedir; ancak konteyneri bunun yerine `docker run` ile başlatırsanız bu yetkileri kendiniz eklemelisiniz, aksi takdirde yasaklamalar günlüğe kaydedilir ancak uygulanmaz: ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## Ortam Değişkenleri (Environment Variables) @@ -191,16 +186,3 @@ Katkılarınızı her zaman bekliyoruz. Bir sorun (issue) açmadan veya pull req ## Projeyi Destekleyin **Eğer bu proje size faydalı olduysa, bir yıldız verebilirsiniz**:star2: - - -Bana Bir Kahve Ismarla - - -
- - NOWPayments üzerinden Kripto Bağış Butonu - - -## Yıldız Tablosu - -[![Zaman içerisindeki yıldız sayısı](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui) diff --git a/README.zh_CN.md b/README.zh_CN.md index 715d066..1155c7c 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -8,12 +8,8 @@

- Release - Build - GO Version - Downloads + License - Go Reference

**3X-UI** 是一个先进的开源 Web 控制面板，用于管理 [Xray-core](https://github.com/XTLS/Xray-core) 服务器。它提供简洁、多语言的界面，用于部署、配置和监控各种代理与 VPN 协议——从单台 VPS 到多节点部署。 @@ -69,24 +65,24 @@ ## 快速开始 ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) +bash <(curl -Ls https://git.881218.xyz/rogue/3x-ui-agent/raw/branch/main/install-master.sh) ``` 若要安装特定版本，请在命令后附加对应的标签（例如 `v3.4.0`）： ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.4.0 +# This fork provides no pinned-version one-click install; see the main README (README.md). ``` 若要安装滚动更新的 **dev** 版本（来自 `main` 的最新逐次提交预发布版本，而非稳定版本），请传入 `dev-latest`： ```bash -bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) dev-latest +# This fork provides no dev-channel one-click install; see the main README (README.md). ``` 安装过程中会生成随机的用户名、密码和访问路径。安装完成后，运行 `x-ui` 打开管理菜单，您可以在其中启动/停止服务、查看或重置登录凭据、管理 SSL 证书等。 -完整文档请参阅 [项目Wiki](https://github.com/MHSanaei/3x-ui/wiki)。 +完整文档请参阅 [项目Wiki](https://git.881218.xyz/rogue/3x-ui-agent)。 ### 无人值守安装 @@ -139,7 +135,7 @@ docker compose --profile postgres up -d 该镜像捆绑了 Fail2ban（默认启用），用于强制执行按客户端的 **IP 限制**。Fail2ban 使用 `iptables` 封禁违规者，这需要 `NET_ADMIN` 权限。`docker-compose.yml` 已通过 `cap_add` 授予该权限；如果您改用 `docker run` 启动容器，请自行添加这些权限，否则封禁只会被记录而永远不会生效： ```bash -docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui +docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... 3x-ui-agent:local ``` ## 环境变量 @@ -191,16 +187,3 @@ English · فارسی · العربية · 中文（简体） · 中文（繁體 ## 支持项目 **如果这个项目对您有帮助，您可以给它一个**:star2: - - -Buy Me A Coffee - - -
- - Crypto donation button by NOWPayments - - -## 随时间变化的星标数 - -[![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg?variant=adaptive)](https://starchart.cc/MHSanaei/3x-ui)