2026-06-08 00:54:13 -07:00
[English ](/README.md ) | [فارسی ](/README.fa_IR.md ) | [العربية ](/README.ar_EG.md ) | [中文 ](/README.zh_CN.md ) | [Español ](/README.es_ES.md ) | [Русский ](/README.ru_RU.md ) | [Türkçe ](/README.tr_TR.md )
< p align = "center" >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "./media/3x-ui-dark.png" >
< img alt = "3x-ui" src = "./media/3x-ui-light.png" >
< / picture >
< / p >
< p align = "center" >
< a href = "https://github.com/MHSanaei/3x-ui/releases" > < img src = "https://img.shields.io/github/v/release/mhsanaei/3x-ui" alt = "Release" > < / a >
< a href = "https://github.com/MHSanaei/3x-ui/actions" > < img src = "https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg" alt = "Build" > < / a >
< a href = "#" > < img src = "https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui.svg" alt = "GO Version" > < / a >
< a href = "https://github.com/MHSanaei/3x-ui/releases/latest" > < img src = "https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg" alt = "Downloads" > < / a >
< a href = "https://www.gnu.org/licenses/gpl-3.0.en.html" > < img src = "https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true" alt = "License" > < / a >
< a href = "https://pkg.go.dev/github.com/mhsanaei/3x-ui/v3" > < img src = "https://pkg.go.dev/badge/github.com/mhsanaei/3x-ui/v3.svg" alt = "Go Reference" > < / a >
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
< a href = "https://docs.sanaei.dev" > < img src = "https://img.shields.io/badge/docs-docs.sanaei.dev-22d3ee" alt = "Documentation" > < / a >
2026-06-08 00:54:13 -07:00
< / p >
2026-06-08 14:56:13 -07:00
**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.
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
Orijinal X-UI projesinin geliştirilmiş bir çatallaması (fork) olarak inşa edilen 3X-UI; çok daha geniş protokol desteği, artı rı lmı ş kararlı lı k, kullanı cı başı na trafik hesaplama ve kullanı m kolaylı ğı sağlayan birçok yeni özellik sunar.
2026-06-08 00:54:13 -07:00
> [!IMPORTANT]
2026-06-08 14:56:13 -07:00
> Bu proje yalnı zca kişisel kullanı m için tasarlanmı ştı r. Lütfen yasadı şı amaçlar için veya üretim (production) ortamı nda kullanmayı n.
2026-06-08 00:54:13 -07:00
## Özellikler
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
- **Çoklu protokol destekli gelen bağlantı lar (Inbounds)** — VLESS, VMess, Trojan, Shadowsocks, WireGuard, AmneziaWG, Hysteria2, MTProto, HTTP, SOCKS (Karma), Dokodemo-door / Tunnel ve TUN.
2026-06-08 14:56:13 -07:00
- **Modern aktarı mlar (transports) ve güvenlik** — TCP (Raw), mKCP, WebSocket, gRPC, HTTPUpgrade ve XHTTP; TLS, XTLS ve REALITY ile güvene alı nmı ştı r.
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
- **Dahili AmneziaWG** — DPI'ya dayanı klı WireGuard, panelin içinde bir kullanı cı alanı ağ yı ğı nı üzerinde çalı şı r; çekirdek modülü, DKMS veya ek paket kurulumu gerektirmez.
- **MTProto proxy'leri** — İstemci başı na FakeTLS gizli anahtarları , reklam etiketleri (ad-tag) ve kotalar, mevcut bağlantı lar kopmadan anlı k olarak uygulanı r.
2026-06-08 14:56:13 -07:00
- **Geri Dönüş (Fallbacks)** — Xray'in fallback desteğini kullanarak tek bir port üzerinde birden fazla protokole (ör. 443 üzerinde hem VLESS hem Trojan) hizmet verin.
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
- **Kullanı cı başı na yönetim** — Trafik kotaları , bitiş tarihleri, güvenilir adreslere muafiyet tanı nabilen IP sı nı rları , HWID cihaz sı nı rları , zamanlanmı ş yenileme döngüleri, canlı çevrimiçi (online) durumu ve tek tı kla paylaşı m bağlantı ları , QR kodları ve abonelikler.
2026-06-08 14:56:13 -07:00
- **Trafik istatistikleri** — Gelen bağlantı (Inbound), istemci ve giden bağlantı (Outbound) bazı nda istatistikler ve sı fı rlama kontrolleri.
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
- **Çoklu düğüm (Multi-node) desteği** — Tek bir panel üzerinden birden fazla sunucuyu yönetin ve ölçeklendirin; gelen bağlantı ları diğer düğümlere klonlayı n.
- **Giden bağlantı (Outbound) ve yönlendirme** — WARP, NordVPN, PIA, özel yönlendirme kuralları , dengeleyiciler arası yük devretme destekli yük dengeleyiciler (load balancers) ve giden bağlantı proxy zincirleme (proxy chaining). Pakete dahil geosite ve geoip kategorileri doğrudan kural düzenleyicisinden taranabilir.
- **Dahili abonelik sunucusu** — İstemcinin User-Agent bilgisine göre otomatik seçilen raw, JSON ve Clash çı ktı sı ve [özel sayfa şablonları ](docs/custom-subscription-templates.md ).
2026-06-08 14:56:13 -07:00
- Uzaktan izleme ve yönetim için **Telegram botu** .
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
- Kapsamı sı nı rlanmı ş, isteğe bağlı olarak süresi dolan token'lar ve panel içi API referansı sunan **RESTful API** .
- **Kurulabilir panel (PWA)** — 3X-UI'yi masaüstüne veya telefon ana ekranı na sabitleyin.
2026-06-08 14:56:13 -07:00
- **Esnek depolama** — SQLite (varsayı lan) veya PostgreSQL.
- Koyu ve açı k tema seçenekleriyle **13 farklı UI dili** .
- Kullanı cı başı na IP limitlerini zorunlu kı lmak için **Fail2ban entegrasyonu** .
2026-06-08 00:54:13 -07:00
## Ekran Görüntüleri
< details >
< summary > Genişletmek için tı klayı n< / summary >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "./media/01-overview-dark.png" >
< img alt = "Genel Bakı ş" src = "./media/01-overview-light.png" >
< / picture >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "./media/02-add-inbound-dark.png" >
2026-06-08 14:56:13 -07:00
< img alt = "Gelen Bağlantı lar (Inbounds)" src = "./media/02-add-inbound-light.png" >
2026-06-08 00:54:13 -07:00
< / picture >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "./media/03-add-client-dark.png" >
< img alt = "Kullanı cı Ekle" src = "./media/03-add-client-light.png" >
< / picture >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "./media/05-add-nodes-dark.png" >
< img alt = "Yapı landı rmalar" src = "./media/05-add-nodes-light.png" >
< / picture >
< / details >
## Hı zlı Başlangı ç
```bash
bash < (curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
```
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
Belirli bir sürümü kurmak için, etiketini (ör. `v3.7.0` ) ekleyin:
2026-06-24 17:36:30 -07:00
```bash
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
bash < (curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v3.7.0
2026-06-24 17:36:30 -07:00
```
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
```
2026-06-08 14:56:13 -07:00
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.
2026-06-08 00:54:13 -07:00
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
Her yayı n dosyası , yanı nda bir `.sha256` sağlama toplamı yla birlikte yayı mlanı r. Hem `install.sh` hem de güncelleyici, arşivi bu toplama karşı doğrular ve uyuşmazlı k halinde işlemi durdurur.
Tam dokümantasyon — kurulum, yapı landı rma, işletim ve eksiksiz API referansı — için ** [docs.sanaei.dev ](https://docs.sanaei.dev )** adresini ziyaret edin.
2026-06-08 00:54:13 -07:00
2026-06-25 15:35:34 -07:00
### Etkileşimsiz kurulum
2026-06-24 17:36:30 -07:00
2026-06-25 15:35:34 -07:00
Yükleyici, cloud-init için **etkileşimsiz** olarak da çalı şı r.
2026-06-24 17:36:30 -07:00
`XUI_NONINTERACTIVE=1` ayarlayı n (veya TTY olmadan boru hattı na aktarı n); kurulum baştan
sona hiçbir soru sormadan tamamlanı r, rastgele kimlik bilgileri oluşturup bunları
`/etc/x-ui/install-result.env` dosyası na yazar. Şunlar için [`deploy/` ](deploy/ ) klasörüne bakı n:
- [Cloud-init user-data ](deploy/cloud-init/ ) — herhangi bir bulutta etkileşimsiz kurulum (Hetzner/AWS/DO/Vultr/GCP/Azure/Oracle)
2026-06-25 15:35:34 -07:00
- [Hetzner Cloud notları ](deploy/marketplace/hetzner/ ) — Hetzner üzerinde cloud-init tabanlı dağı tı m
2026-06-24 17:36:30 -07:00
2026-06-08 00:54:13 -07:00
## Desteklenen Platformlar
**İşletim sistemleri:** Ubuntu, Debian, Armbian, Fedora, CentOS, RHEL, AlmaLinux, Rocky Linux, Oracle Linux, Amazon Linux, Virtuozzo, Arch, Manjaro, Parch, openSUSE (Tumbleweed / Leap), Alpine ve Windows.
**Mimariler:** `amd64` · `386` · `arm64` (aarch64) · `armv7` · `armv6` · `armv5` · `s390x` .
## Veritabanı Seçenekleri
2026-06-08 14:56:13 -07:00
3X-UI kurulum sı rası nda seçilebilecek iki arka uç (backend) destekler:
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
- **SQLite** (varsayı lan) — `/etc/x-ui/x-ui.db` konumunda tek bir dosya. Kurulum gerektirmez, küçük ve orta ölçekli dağı tı mlar için idealdir.
- **PostgreSQL** — Yüksek kullanı cı sayı ları veya çoklu düğüm (multi-node) kurulumları için önerilir. Yükleyici sizin için yerel olarak PostgreSQL kurabilir veya mevcut bir sunucuya DSN bağlantı sı kabul edebilir.
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
Çalı şma anı nda veritabanı türü ortam değişkenleri (environment variables) ile seçilir (yükleyici bunları sizin için `/etc/default/x-ui` dosyası na yazar):
2026-06-08 00:54:13 -07:00
```
XUI_DB_TYPE=postgres
XUI_DB_DSN=postgres://xui:password@127.0.0.1:5432/xui?sslmode=disable
```
2026-06-08 14:56:13 -07:00
### Mevcut bir SQLite Kurulumunu PostgreSQL'e Taşı ma
2026-06-08 00:54:13 -07:00
```bash
x-ui migrate-db --dsn "postgres://xui:password@127.0.0.1:5432/xui?sslmode=disable"
2026-06-08 14:56:13 -07:00
# ardı ndan /etc/default/x-ui içindeki XUI_DB_TYPE ve XUI_DB_DSN değerlerini ayarlayı p yeniden başlatı n:
2026-06-08 00:54:13 -07:00
systemctl restart x-ui
```
2026-06-08 14:56:13 -07:00
Kaynak SQLite dosyası na dokunulmaz; yeni veritabanı nı n düzgün çalı ştı ğı nı doğruladı ktan sonra eski SQLite dosyası nı manuel olarak silebilirsiniz.
2026-06-08 00:54:13 -07:00
### Docker
2026-06-08 14:56:13 -07:00
Varsayı lan `docker compose up -d` komutu SQLite kullanmaya devam eder. Birlikte paketlenmiş PostgreSQL servisi ile çalı ştı rmak için, `docker-compose.yml` dosyası ndaki iki `XUI_DB_*` değişken satı rı nı n yorumunu kaldı rı n ve profille başlatı n:
2026-06-08 00:54:13 -07:00
```bash
docker compose --profile postgres up -d
```
2026-06-08 14:56:13 -07:00
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:
2026-06-08 00:54:13 -07:00
```bash
docker run -d --cap-add=NET_ADMIN --cap-add=NET_RAW ... ghcr.io/mhsanaei/3x-ui
```
2026-06-08 14:56:13 -07:00
## Ortam Değişkenleri (Environment Variables)
2026-06-08 00:54:13 -07:00
| Değişken | Açı klama | Varsayı lan |
| --- | --- | --- |
2026-06-08 14:56:13 -07:00
| `XUI_DB_TYPE` | Veritabanı türü: `sqlite` veya `postgres` | `sqlite` |
| `XUI_DB_DSN` | PostgreSQL bağlantı dizesi (eğer `XUI_DB_TYPE=postgres` ise) | — |
| `XUI_DB_FOLDER` | SQLite veritabanı dizini | `/etc/x-ui` |
2026-06-08 00:54:13 -07:00
| `XUI_DB_MAX_OPEN_CONNS` | Maksimum açı k bağlantı sayı sı (PostgreSQL havuzu) | — |
2026-06-08 14:56:13 -07:00
| `XUI_DB_MAX_IDLE_CONNS` | Maksimum boşta bekleme bağlantı sı (PostgreSQL havuzu) | — |
2026-06-11 03:51:54 -07:00
| `XUI_INIT_WEB_BASE_PATH` | Web paneli için başlangı ç URI yolu | `/` |
2026-06-08 14:56:13 -07:00
| `XUI_ENABLE_FAIL2BAN` | Fail2ban tabanlı IP limit uygulaması nı etkinleştir | `true` |
| `XUI_LOG_LEVEL` | Günlük (Log) ayrı ntı seviyesi (`debug`, `info` , `warning` , `error` ) | `info` |
2026-06-08 00:54:13 -07:00
| `XUI_DEBUG` | Hata ayı klama (debug) modunu etkinleştir | `false` |
2026-06-24 17:36:30 -07:00
| `XUI_TUNNEL_HEALTH_MONITOR` | Tünel sağlı k izleyicisini etkinleştir (bir URL'yi yoklar ve tekrarlanan başarı sı zlı klardan sonra xray'i yeniden başlatı r; yeniden başlatma tüm istemcilerin bağlantı sı nı düşürür) | `false` |
| `XUI_TUNNEL_HEALTH_PROXY` | Yoklamanı n gönderildiği proxy; yoklamanı n tüneli test etmesi için bunu yerel bir xray gelen bağlantı sı na yönlendirin (ör. `socks5://127.0.0.1:1080` ). Boş bı rakı lı rsa yoklama yalnı zca ana makine bağlantı sı nı kontrol eder | — |
| `XUI_TUNNEL_HEALTH_URL` | Tünel sağlı ğı için yoklanan URL | `https://www.cloudflare.com/cdn-cgi/trace` |
| `XUI_TUNNEL_HEALTH_INTERVAL` | Yoklamalar arası ndaki aralı k | `30s` |
| `XUI_TUNNEL_HEALTH_TIMEOUT` | Yoklama başı na zaman aşı mı | `10s` |
| `XUI_TUNNEL_HEALTH_FAILURES` | Yeniden başlatma tetiklenmeden önceki ardı şı k başarı sı zlı k sayı sı | `3` |
| `XUI_TUNNEL_HEALTH_COOLDOWN` | Ardı şı k yeniden başlatmalar arası ndaki minimum gecikme | `5m` |
docs(readme): refresh all seven READMEs for the current feature set
The READMEs had not moved since 2026-07-07, 341 commits ago, and had
drifted far enough to misdescribe the panel: AmneziaWG and MTProto
inbounds were missing from the protocol list entirely, the outbound
list predated PIA, and the API section still advertised Swagger rather
than scoped, optionally expiring tokens.
Add the two missing protocols plus a bullet each for what makes them
notable — AmneziaWG runs on the embedded userspace netstack, so unlike
the DKMS/awg-quick shape it originally shipped with there is nothing to
install, and MTProto client edits hot-apply through the mtg-multi
management API instead of bouncing the process. Fold the smaller
additions into the bullets they belong to (HWID device limits, IP-limit
exemptions, renewal cycles, inbound cloning, balancer-to-balancer
fallback, geosite/geoip browsing, named subscription formats) and add
one for PWA installability.
Point documentation at docs.sanaei.dev, which the panel sidebar already
links to and which supersedes the wiki, using each README's own locale
where the docs site has one (fa/ru/zh). Bump the pinned install example
to the current stable tag, note the .sha256 verification install.sh and
update.sh now perform, and document XUI_NODE_TOKEN_KEY_FILE /
XUI_NODE_TOKEN_KEY, which no markdown in the repo covered.
All seven files move together so the language picker keeps pointing at
equivalent documents.
2026-09-04 00:49:25 -07:00
| `NODE_TOKEN_ENCRYPTION` | Düğüm API token'ları için beklemede şifreleme: `off` , `migration` veya `required` (`XUI_` öneki yoktur) | `off` |
| `XUI_NODE_TOKEN_KEY_FILE` | Etkin anahtar kimliğini ve base64 kodlu 32 baytlı k anahtarları nı içeren JSON anahtarlı ğı (mod `0600` ) | `/etc/x-ui/node_token_key.json` |
| `XUI_NODE_TOKEN_KEY` | Tek bir base64 kodlu 32 baytlı k anahtar; yalnı zca anahtar dosyası yüklenemediğinde kullanı lı r | — |
Tam liste [ortam değişkenleri referansı nda ](https://docs.sanaei.dev/docs/reference/env-vars ) yer alı r.
2026-06-08 00:54:13 -07:00
## Desteklenen Diller
2026-06-08 14:56:13 -07:00
Panel arayüzü 13 farklı dilde mevcuttur:
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
İngilizce · Farsça · Arapça · Çince (Basitleştirilmiş) · Çince (Geleneksel) · İspanyolca · Rusça · Ukraynaca · Türkçe · Vietnamca · Japonca · Endonezce · Portekizce (Brezilya)
2026-06-08 00:54:13 -07:00
## Katkı da Bulunma
2026-06-08 14:56:13 -07:00
Katkı ları nı zı her zaman bekliyoruz. Bir sorun (issue) açmadan veya pull request (PR) göndermeden önce lütfen [Katkı da Bulunma Kı lavuzunu ](/CONTRIBUTING.md ) okuyun.
2026-06-08 00:54:13 -07:00
## Özel Teşekkürler
- [alireza0 ](https://github.com/alireza0/ )
2026-06-08 14:56:13 -07:00
## Teşekkür & Atı f
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
- [Iran v2ray rules ](https://github.com/chocolate4u/Iran-v2ray-rules ) (Lisans: **GPL-3.0** ): _Geliştirilmiş v2ray/xray ve v2ray/xray-clients yönlendirme (routing) kuralları ; yerleşik İran alan adları ile güvenlik ve reklam engelleme odaklı dı r._
- [Russia v2ray rules ](https://github.com/runetfreedom/russia-v2ray-rules-dat ) (Lisans: **GPL-3.0** ): _Bu depo, Rusya'daki engellenen alan adları ve adreslere dayalı otomatik olarak güncellenen V2Ray yönlendirme kuralları nı içerir._
2026-06-08 00:54:13 -07:00
## Topluluk Araçları
2026-06-08 14:56:13 -07:00
3x-ui çevresindeki topluluk tarafı ndan oluşturulmuş araçlar ve entegrasyonlar.
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
- [terraform-provider-3x-ui ](https://github.com/batonogov/terraform-provider-threexui ) (Lisans: **MIT** ): _Gelen bağlantı larnı , kullanı cı ları , panel ayarları nı ve Xray yapı landı rması nı Terraform / OpenTofu ile kod olarak (as code) yönetin._
2026-06-08 00:54:13 -07:00
## Projeyi Destekleyin
2026-06-08 14:56:13 -07:00
**Eğer bu proje size faydalı olduysa, bir yı ldı z verebilirsiniz**:star2:
2026-06-08 00:54:13 -07:00
< a href = "https://www.buymeacoffee.com/MHSanaei" target = "_blank" >
2026-06-08 14:56:13 -07:00
< img src = "./media/default-yellow.png" alt = "Bana Bir Kahve Ismarla" style = "height: 70px !important;width: 277px !important;" >
2026-06-08 00:54:13 -07:00
< / a >
< / br >
< a href = "https://nowpayments.io/donation/hsanaei" target = "_blank" rel = "noreferrer noopener" >
2026-06-08 14:56:13 -07:00
< img src = "./media/donation-button-black.svg" alt = "NOWPayments üzerinden Kripto Bağı ş Butonu" >
2026-06-08 00:54:13 -07:00
< / a >
2026-06-08 14:56:13 -07:00
## Yı ldı z Tablosu
2026-06-08 00:54:13 -07:00
2026-06-08 14:56:13 -07:00
[](https://starchart.cc/MHSanaei/3x-ui)