English | فارسی | العربية | 中文 | Español | Русский | Türkçe

3x-ui için Terraform Provider

3x-ui inbound'larını, istemcilerini, panel ayarlarını ve Xray yapılandırmasını kod olarak yönetin — panele tıklamadan VPN/proxy filonuzu yedekleyin, taşıyın ve ölçeklendirin.

Neden kullanmalısınız

Üretimde 3x-ui çalıştırmak, düzinelerce inbound, yüzlerce istemci ve kolayca bozulabilecek bir Xray yapılandırması anlamına gelir. Bu provider ile şunları yapabilirsiniz:

• Yapılandırmayı kod olarak yönetin — inbound listeniz git'te saklanır, her değişiklik gözden geçirilir ve sürümlenir.
• Sunucular arasında taşıyın — yeni bir VPS üzerinde aynı kurulumu tek bir terraform apply ile yeniden oluşturun.
• Panel anlık görüntüsü — terraform state pull, inbound'ların, istemcilerin ve ayarların tam bir dışa aktarımıdır.
• Onboarding'i ölçeklendirin — 100 panel tıklaması yerine tek bir PR ile 100 istemci ekleyin.
• Üretime göndermeden önce planlayın — terraform plan, herhangi bir şey gönderilmeden önce nelerin değişeceğini tam olarak gösterir.

Provider olmadan vs provider ile

Hızlı Başlangıç

terraform {
  required_providers {
    threexui = {
      source = "batonogov/threexui"
    }
  }
}

provider "threexui" {
  endpoint = "http://localhost:2053"
  username = "admin"
  password = "admin"
}

resource "threexui_inbound" "vless" {
  remark   = "VLESS Reality"
  port     = 443
  protocol = "vless"

  vless_settings {
    decryption = "none"
  }

  stream_settings {
    network  = "tcp"
    security = "reality"
    reality_settings {
      target       = "www.amazon.com:443"
      server_names = ["www.amazon.com"]
    }
  }

  sniffing {
    enabled       = true
    dest_override = ["http", "tls", "quic", "fakedns"]
  }
}

resource "threexui_inbound_client" "client_a" {
  inbound_id = threexui_inbound.vless.id
  email      = "client-a@example.com"
  enable     = true
  flow       = "xtls-rprx-vision"
}

OpenTofu kullanıcıları: tam kayıt adresini kullanın:

hcl source = "registry.terraform.io/batonogov/threexui"

Provider, OpenTofu Registry'de yayınlanmamaktadır (neden).

Uyumluluk

Destek politikası: provider resmi olarak dört 3x-ui minör hattını destekler: v3.1.x, v3.2.x, v3.3.x ve v3.4.x — dört hattın tamamındaki her yayımlanan yama, main'e yapılan her push'ta ve her pull request'te acceptance test matrisi tarafından sınanır.

Daha yeni protokol özellikleri requireMinVersion ile korunur ve eski sürümlerde otomatik olarak atlanır, bu nedenle provider sürüm başına ayrı dallar olmadan tüm sürümlerde sorunsuz çalışır.

Örnekler

Kılavuzlar

Yaygın operasyonel senaryolar için repo içindeki adım adım kılavuzlar:

• Kod olarak yedekleme — tam panel durumunuzu git'te saklayın, saniyeler içinde geri yükleyin.
• 3x-ui'ı sunucular arasında taşıma — tüm paneli yeni bir VPS'e hiçbir şeyi yeniden yazmadan taşıyın.
• Birçok istemciyi aynı anda ekleme — for_each desenleri ve CSV ile onboarding.

Belgeler

Tam belgeler Terraform Registry'de mevcuttur.

Kaynaklar

Veri Kaynakları

Güvenlik

Provider, panelin otomatik olarak verdiği sırları işler (Reality privateKey, WireGuard secretKey, istemci UUID'leri, Telegram bot tokenları, LDAP parolaları). Bu tür tüm alanlar Sensitive olarak işaretlenir ve düz metin olarak günlüğe kaydedilmez. Tam liste ve Terraform state'inizi koruma rehberi için bkz. SECURITY.md.

Geliştirme

Gereksinimler

• Go (sürüm go.mod dosyasında sabitlenmiştir)
• Task — görev çalıştırıcı
• golangci-lint — linter
• pre-commit — git kancaları çerçevesi
• Docker — yerel 3x-ui ortamı için

Komutlar

task build        # Provider'ı derle
task fmt          # Kodu biçimlendir (gofmt)
task vet          # go vet çalıştır
task lint         # golangci-lint çalıştır
task pre-commit   # Tüm kontrolleri manuel olarak çalıştır (fmt, vet, lint, build)
task test:unit    # Birim testlerini çalıştır (Docker / Terraform gerekmez)
task test:acc     # Acceptance testlerini çalıştır (docker compose başlatır)
task test         # Birim + acceptance testlerini çalıştır

Yerel ortam

# 3x-ui'ı localhost:2053 üzerinde başlat
docker compose up -d

# Giriş: admin / admin

# Durdur
docker compose down

Katkıda bulunma

Yerel kurulum, test ve gönderim yönergeleri için bkz. CONTRIBUTING.md. Hata raporları, özellik istekleri ve pull request'ler memnuniyetle karşılanır — üretimde hangi 3x-ui sürümlerini çalıştırdığınıza dair notlar da.

Değişiklik günlüğü

Sürümler Conventional Commits takip eder ve otomatik olarak yayımlanır. Tam sürüm geçmişi için bkz. CHANGELOG.md.

Lisans

MIT