Ana içeriğe geç
Version: 1.0.0

Ortam Değişkenleri Referansı

Bu belge, Teydex KYC projesinde kullanılan ortam değişkenlerini, varsayılan değerleri, örnek değerleri ve açıklamalarıyla birlikte sunar.

Güvenlik​

  • SECRET_KEY

    • Varsayılan: Yok

    • Örnek: (Production'da mutlaka tanımlanmalıdır)

    • Açıklama: Kriptografik imzalama için gizli anahtar.

      from django.core.management.utils import get_random_secret_key

      get_random_secret_key()

      fonksiyonu kullanarak üretilmeli ve bir kere set edildikten sonra asla değiştirilmemeli.

  • ALLOWED_HOSTS

    • Varsayılan: [*]
    • Örnek: *
    • Açıklama: Sunucuya bağlanabilecek izinli host listesi. * tüm hostlara izin verir (production'da önerilmez). Uygulama hangi domain'de çalışılıyorsa o set edilebilir. example.com,www.example.com gibi virgülle ayrılmış değerler tercih edilmelidir.

  • TRUSTED_ORIGINS

    • Varsayılan: []
    • Örnek: https://example.com,http://localhost:8000
    • Açıklama: CSRF ve CORS koruması için güvenilir adresler. Frontend uygulamasının adresi girilmesi gerekir. Protokol dahil edilmelidir (ör. https://). * kullanmaktan kaçının — her adres açıkça listelenmelidir.

  • SECURE_SSL_REDIRECT

    • Varsayılan: True
    • Açıklama: HTTP isteklerini HTTPS'e yönlendirir.

Depolama​

  • DEFAULT_STORAGE_BACKEND

    • Varsayılan: django.core.files.storage.FileSystemStorage
    • Örnek: storages.backends.ftp.FTPStorage
    • Açıklama: Dosyaların işlendiği depolama altyapısı. Kullanılan file storage adaptörleri: geleneksel dosya sistemi, S3, LibCloud, Azure Storage, Minio, Dropbox, FTP, SFTP, Google Cloud Storage. Gerekli değişkenler için Innovance KYC ekibinden destek alabilirsiniz.

  • DEFAULT_STORAGE_OPTIONS

    • Varsayılan: {}
    • Örnek: location=ftp://...;allow_overwrite=0
    • Açıklama: Depolama altyapısına özel ayarlar. Buradaki parametreler, yukarıda seçilen adaptöre göre değişiklik göstermektedir. Innovance KYC ekibinden destek alınabilir.

  • MEDIA_ROOT

    • Varsayılan: ""
    • Örnek: /data
    • Açıklama: Yüklenen medya dosyalarının yolu. Sadece file storage değişkeni, geleneksel dosya sistemi kullanılıyorsa kullanılmaktadır ve set edilmesi gerekmektedir.

E-posta​

  • DEFAULT_FROM_EMAIL

    • Varsayılan: webmaster@localhost
    • Örnek: application@test-domain.com
    • Açıklama: Varsayılan gönderici e-posta adresi.

  • EMAIL_CONF

    • Varsayılan: consolemail://

    • Örnek: smtp://user:password@localhost:25

    • Açıklama: E-posta altyapı yapılandırması. Django-environ e-posta URL formatını kullanır.

      Daha fazla bilgiyi buradan edinebilir veya Innovance KYC ekibinden destek alabilirsiniz.

Django Ortamı​

  • DATABASE_URL

    • Varsayılan: (yok)
    • Örnek: postgres://username:password@hostname:port/database
    • Açıklama: Tam veritabanı bağlantı URL'si. PostgreSQL veritabanı kullanılmalıdır.

  • CACHE_URL

    • Varsayılan: locmemcache://
    • Örnek: redis://username:password@localhost:6379/0
    • Açıklama: Önbellek altyapısının URL'si.

JWT Kimlik Doğrulama​

  • ACCESS_TOKEN_LIFETIME

    • Varsayılan: 3600 (1 saat)
    • Örnek: 3600
    • Açıklama: JWT erişim token'ının ömrü (saniye).

  • REFRESH_TOKEN_LIFETIME

    • Varsayılan: 86400 (24 saat)
    • Örnek: 86400
    • Açıklama: JWT yenileme token'ının ömrü (saniye).

Celery​

  • CELERY_BROKER_URL

    • Varsayılan: ""

    • Örnek: amqp://username:password@hostname:port/virtual_host

    • Açıklama: Celery mesaj kuyruğu bağlantı adresi.

      Daha fazla bilgiyi buradan edinebilir veya Innovance KYC ekibinden destek alabilirsiniz.

  • CELERY_RESULT_BACKEND

    • Varsayılan: None

    • Açıklama: Celery görev sonuçlarının nerede saklanacağı (varsayılan olarak etkin değil).

      Daha fazla bilgiyi buradan edinebilir veya Innovance KYC ekibinden destek alabilirsiniz.

LDAP Entegrasyonu​

Kurumsal ortamlar için LDAP kimlik doğrulama aşağıdaki ortam değişkenleri kullanılarak yapılandırılabilir:

  • AUTH_LDAP_SERVER_URI

    • Varsayılan: None
    • Örnek: ldap://localhost:389
    • Açıklama: LDAP sunucusu uç nokta URL'si. Uygulama kullanıcı kimlik doğrulama ve dizin aramaları için bu sunucuya bağlanır.

  • AUTH_LDAP_USER_SEARCH_BASE

    • Varsayılan: None
    • Örnek: ou=users,dc=mycompany,dc=local
    • Açıklama: Kullanıcı hesaplarının LDAP dizininde depolandığı organizasyon birimi.

  • AUTH_LDAP_USER_SEARCH_FILTER

    • Varsayılan: None
    • Örnek: (uid=%(user)s)
    • Açıklama: Belirli kullanıcı hesaplarını bulmak için LDAP filtre kalıbı. Kullanıcı adı için %(user)s yer tutucusu kullanır.

  • AUTH_LDAP_GROUP_SEARCH_BASE

    • Varsayılan: None
    • Örnek: ou=groups,dc=mycompany,dc=local
    • Açıklama: Grupların LDAP dizininde depolandığı organizasyon birimi.

  • AUTH_LDAP_USER_ATTR_MAP

    • Varsayılan: first_name=givenName,last_name=sn,email=mail
    • Örnek: first_name=givenName,last_name=sn,email=mail,username=uid
    • Açıklama: LDAP özniteliklerini uygulama kullanıcı alanlarına eşler. Format: uygulama_alanı=ldap_özniteliği (sol taraf = uygulama alanı, sağ taraf = LDAP özniteliği). Kullanılabilir uygulama alanları: username, first_name, last_name, email, is_active, is_staff, is_superuser

  • AUTH_LDAP_GROUP_TO_USER_TYPE_MAP

    • Varsayılan: {}
    • Örnek: admin=administrator,managers=customer_representative_manager,customer-reps=customer_representative,read-only-users=read_only
    • Açıklama: LDAP gruplarını uygulama kullanıcı rollerine eşler. Format: ldap_grup_adı=uygulama_rolü (sol taraf = LDAP grup adı, sağ taraf = uygulama rolü). Kullanılabilir uygulama rolleri:
      • api_user: API Kullanıcısı
      • read_only: Salt Okunur (varsayılan rol)
      • administrator: Yönetici
      • customer_representative: Müşteri Temsilcisi
      • customer_representative_manager: Müşteri Temsilcisi Müdürü

  • AUTH_LDAP_BIND_DN

    • Varsayılan: cn=admin,dc=mycompany,dc=local
    • Örnek: cn=admin,dc=mycompany,dc=local
    • Açıklama: Dizine bağlanmak ve arama yapmak için kullanılan LDAP kullanıcı hesabının ayırt edici adı.

  • AUTH_LDAP_BIND_PASSWORD

    • Varsayılan: admin
    • Örnek: MySecurePassword123
    • Açıklama: LDAP bağlama kullanıcı hesabının şifresi.

LDAP Kimlik Doğrulama Nasıl Çalışır​

  1. Kullanıcı Girişi: Kullanıcı, uygulama giriş formu aracılığıyla kimlik bilgilerini sağlar
  2. Dizin Arama: Uygulama, AUTH_LDAP_USER_SEARCH_BASE ve AUTH_LDAP_USER_SEARCH_FILTER kullanarak LDAP'ta kullanıcıyı arar
  3. Kimlik Doğrulama: Kullanıcı mevcutsa, uygulama sağlanan şifre ile bağlanmaya (kimlik doğrulama) çalışır
  4. Öznitelik Eşleme: Başarılı kimlik doğrulama sonrasında, kullanıcı öznitelikleri alınır ve AUTH_LDAP_USER_ATTR_MAP kullanılarak eşlenir
  5. Grup Yetkilendirme: Kullanıcının grup üyelikleri AUTH_LDAP_GROUP_SEARCH_BASE adresinden alınır ve AUTH_LDAP_GROUP_TO_USER_TYPE_MAP kullanılarak uygulama rollerine eşlenir
  6. Oturum Oluşturma: Eşlenen rollere dayalı uygun izinlerle yerel kullanıcı oturumu oluşturulur

Bu entegrasyon, uygulama içinde rol tabanlı erişim kontrolünü korurken merkezi kullanıcı yönetimi sağlar.

Harici Servisler​

Lisans Sunucusu​

  • LICENSE_KEY

    • Varsayılan: None
    • Örnek: 0DEFDC29-90D4-4059-A402-511427F14FAB
    • Açıklama: Ürün lisans anahtarı.

  • LICENSE_TOKEN

    • Varsayılan: None
    • Örnek: 5PvGecy...
    • Açıklama: Lisans doğrulama için kimlik doğrulama token’ı.

  • LICENSE_PUBLIC_KEY

    • Varsayılan: None
    • Örnek: /public-key/itself/or/directory/to/license.pub
    • Açıklama: Lisans doğrulama için açık anahtar yolu.

Havelsan KYC​

  • HAVELSAN_KYC_CLIENT_CONF

    • Varsayılan: base_url=
    • Örnek: base_url=https://1.0.0.0:8443
    • Açıklama: Havelsan KYC istemcisi için yapılandırma sözlüğü.

Assistbox​

  • ASSISTBOX_CLIENT_CONF

    • Varsayılan: 
      base_url=https://example.com;admin_user_id=admin.id;api_username=my-user;api_password=MySecurePass123!;api_key=MyApiKey123456789;company_id=1234
    • Örnek: 
      base_url=https://example.com;admin_user_id=admin.id;api_username=my-user;api_password=MySecurePass123!;api_key=MyApiKey123456789;company_id=1234
    • Açıklama: Assistbox entegrasyonu için yapılandırma. Noktalı virgülle ayrılmış düz metin formatında anahtar-değer çiftleri.

Web URL'leri​

  • WEB_APPLICATION_BASE_URL

    • Varsayılan: https://online-kyc-web-dev.k8s.innovance.com.tr
    • Örnek: https://online-kyc-web-dev.k8s.innovance.com.tr
    • Açıklama: Web ön yüzünün temel adresi.

Diğer​

  • EXPOSE_PROJECT_API

    • Varsayılan: False
    • Örnek: false
    • Açıklama: Geliştirme ortamında Swagger API’sini etkinleştirir. Production'da false olması gerekir.