Sunucu Yapılandırması¶
Varsayılan Docker görüntüsünü kullanarak, gerekli tüm yapılandırmalar tarayıcıdan yapılabilir. Ancak, dağıtıma bağlı olarak sunucu yapılandırmasını özelleştirmek gerekebilir.
Bu sayfa, yapılandırmayı değiştirmek için tüm yöntemleri ve mevcut tüm yapılandırma seçeneklerini listelemektedir.
Yapılandırma dosyası vs. ortam değişkenleri¶
Ayarlar için ya bir yapılandırma dosyası ya da ortam değişkenleri kullanabilirsiniz.
Eğer Docker Compose tabanlı bir kurulum kullanıyorsanız, grampsweb: bloğundaki volumes: anahtarının altına aşağıdaki liste öğesini ekleyerek bir yapılandırma dosyası dahil edebilirsiniz:
- /path/to/config.cfg:/app/config/config.cfg
/path/to/config.cfg, sunucunuzun dosya sistemindeki yapılandırma dosyasının yoludur (sağ taraf, konteynerdeki yolu ifade eder ve değiştirilmemelidir).
Ortam değişkenleri kullanıldığında,
- her ayar adını
GRAMPSWEB_ile öne ekleyin, böylece ortam değişkeninin adını elde edersiniz - İç içe sözlük ayarları için çift alt çizgi kullanın, örneğin
GRAMPSWEB_THUMBNAIL_CACHE_CONFIG__CACHE_DEFAULT_TIMEOUT,THUMBNAIL_CACHE_CONFIG['CACHE_DEFAULT_TIMEOUT']yapılandırma seçeneğinin değerini ayarlayacaktır.
Ortam aracılığıyla ayarlanan yapılandırma seçeneklerinin, yapılandırma dosyasındaki seçeneklerden önceliği olduğunu unutmayın. Her ikisi de mevcutsa, ortam değişkeni "kazanır".
Mevcut yapılandırma ayarları¶
Aşağıdaki yapılandırma seçenekleri mevcuttur.
Gerekli ayarlar¶
| Anahtar | Açıklama |
|---|---|
TREE |
Kullanılacak aile ağacı veritabanının adı. Mevcut ağaçları gramps -l ile gösterin. Bu isimde bir ağaç yoksa, yeni boş bir ağaç oluşturulacaktır. |
SECRET_KEY |
Flask için gizli anahtar. Gizli anahtar kamuya açık olarak paylaşılmamalıdır. Değiştirilmesi, tüm erişim jetonlarını geçersiz kılacaktır. |
USER_DB_URI |
Kullanıcı veritabanının veritabanı URL'si. SQLAlchemy ile uyumlu herhangi bir URL kabul edilir. |
Bilgi
Güvenli bir gizli anahtar oluşturmak için, örneğin şu komutu kullanabilirsiniz:
python3 -c "import secrets;print(secrets.token_urlsafe(32))"
İsteğe bağlı ayarlar¶
| Anahtar | Açıklama |
|---|---|
MEDIA_BASE_DIR |
Medya dosyaları için temel dizin olarak kullanılacak yol, Gramps'ta ayarlanan medya temel dizinini geçersiz kılar. S3 kullanırken, s3://<bucket_name> biçiminde olmalıdır. |
TREE_ID |
Tek ağaç modunda (eğer TREE MULTI olarak ayarlanmamışsa) kullanılacak aile ağacı veritabanının dizin adı. Ayarlandığında, sunucu ağacı dizin adıyla tanımlar, bu da yeniden adlandırmalara karşı daha sağlamdır. API aracılığıyla ağacı yeniden adlandırmak istiyorsanız gereklidir. Dizin adı, GET /api/trees/- (id alanı) ile bulunabilir. |
SEARCH_INDEX_DB_URI |
Arama dizini için veritabanı URL'si. Sadece sqlite veya postgresql arka uçları kabul edilir. Varsayılan olarak sqlite:///indexdir/search_index.db'dir, bu da scriptin çalıştığı yola göre indexdir klasöründe bir SQLite dosyası oluşturur. |
STATIC_PATH |
Statik dosyaların sunulacağı yol (örneğin, statik bir web ön yüzü). |
BASE_URL |
API'ye ulaşılabilecek temel URL (örneğin, https://mygramps.mydomain.com/). Bu, doğru şifre sıfırlama bağlantıları oluşturmak için gereklidir. |
CORS_ORIGINS |
CORS isteklerinin izin verildiği kökenler. Varsayılan olarak, tümü yasaktır. Herhangi bir alan adından istekleri kabul etmek için "*" kullanın. |
EMAIL_HOST |
SMTP sunucu ana bilgisayarı (örneğin, şifre sıfırlama e-postaları göndermek için). |
EMAIL_PORT |
SMTP sunucu portu. Varsayılan olarak 465'tir. |
EMAIL_HOST_USER |
SMTP sunucu kullanıcı adı. |
EMAIL_HOST_PASSWORD |
SMTP sunucu şifresi. |
EMAIL_USE_TLS |
Kullanımdan kaldırıldı (bunun yerine EMAIL_USE_SSL veya EMAIL_USE_STARTTLS kullanın). E-postaları göndermek için TLS kullanılıp kullanılmayacağını belirten Boolean. Varsayılan olarak True'dur. STARTTLS kullanırken, bunu False olarak ayarlayın ve 25'ten farklı bir port kullanın. |
EMAIL_USE_SSL |
SMTP için örtük SSL/TLS kullanılıp kullanılmayacağını belirten Boolean (v3.6.0+). EMAIL_USE_TLS açıkça ayarlanmamışsa varsayılan olarak True'dur. Genellikle 465 portu ile kullanılır. |
EMAIL_USE_STARTTLS |
SMTP için açık STARTTLS kullanılıp kullanılmayacağını belirten Boolean (v3.6.0+). Varsayılan olarak False'dur. Genellikle 587 veya 25 portu ile kullanılır. |
DEFAULT_FROM_EMAIL |
Otomatik e-postalar için "From" adresi. |
THUMBNAIL_CACHE_CONFIG |
Küçük resim önbelleği için ayarları içeren sözlük. Olası ayarlar için Flask-Caching sayfasına bakın. |
REQUEST_CACHE_CONFIG |
İstek önbelleği için ayarları içeren sözlük. Olası ayarlar için Flask-Caching sayfasına bakın. |
PERSISTENT_CACHE_CONFIG |
Kalıcı önbellek için ayarları içeren sözlük, örneğin telemetri için kullanılır. Olası ayarlar için Flask-Caching sayfasına bakın. |
CELERY_CONFIG |
Celery arka plan görev kuyruğu için ayarlar. Olası ayarlar için Celery sayfasına bakın. |
REPORT_DIR |
Gramps raporlarının çıktısının depolanacağı geçici dizin. |
EXPORT_DIR |
Gramps veritabanasının dışa aktarım çıktısının depolanacağı geçici dizin. |
REGISTRATION_DISABLED |
Eğer True ise, yeni kullanıcı kaydını engeller (varsayılan False). |
DISABLE_TELEMETRY |
Eğer True ise, istatistik telemetrisini devre dışı bırakır (varsayılan False). Detaylar için telemetri sayfasına bakın. |
PILLOW_MAX_IMAGE_PIXELS |
İşlenen görüntünün içerebileceği piksel sayısını belirten PIL.Image.MAX_IMAGE_PIXELS parametresini ayarlar. Detaylar için docs sayfasına bakın. |
MAX_THUMBNAIL_FILE_BYTES |
Küçük resimler için katı maksimum dosya boyutunu ayarlar. Varsayılan olarak 50 * 1024 * 1024 (50 MB) olarak ayarlanmıştır. Bunu artırmak, bellek kullanımını büyük ölçüde artırabilir ve büyük dosyalar bellekte açıldığında bellek yetersizliği hatalarına veya veri kaybına neden olabilir. |
Bilgi
Yapılandırma için ortam değişkenleri kullanıldığında, EMAIL_USE_TLS gibi boolean seçenekler ya true ya da false (büyük/küçük harf duyarlı!) olmalıdır.
Sadece PostgreSQL arka uç veritabanı için ayarlar¶
Eğer Gramps veritabanınızı PostgreSQL eklentisi ile çalışacak şekilde yapılandırdıysanız, bu gereklidir.
| Anahtar | Açıklama |
|---|---|
POSTGRES_USER |
Veritabanı bağlantısı için kullanıcı adı. |
POSTGRES_PASSWORD |
Veritabanı kullanıcısı için şifre. |
Birden fazla ağacı barındırmak için ilgili ayarlar¶
Ağları birden fazla ağaç barındırırken aşağıdaki ayarlar geçerlidir.
| Anahtar | Açıklama |
|---|---|
MEDIA_PREFIX_TREE |
Her ağacın medya dosyaları için ayrı bir alt klasör kullanılıp kullanılmayacağını belirten Boolean. Varsayılan olarak False'dur, ancak çoklu ağaç kurulumunda True kullanılması şiddetle önerilir. |
NEW_DB_BACKEND |
Yeni oluşturulan aile ağaçları için kullanılacak veritabanı arka ucu. sqlite, postgresql veya sharedpostgresql'dan biri olmalıdır. Varsayılan olarak sqlite'dır. |
POSTGRES_HOST |
SharedPostgreSQL arka ucu ile çoklu ağaç kurulumunda yeni ağaçlar oluşturmak için kullanılan PostgreSQL sunucusunun ana bilgisayar adı. |
POSTGRES_PORT |
SharedPostgreSQL arka ucu ile çoklu ağaç kurulumunda yeni ağaçlar oluşturmak için kullanılan PostgreSQL sunucusunun portu. |
OIDC kimlik doğrulama ayarları¶
Bu ayarlar, dış sağlayıcılarla OpenID Connect (OIDC) kimlik doğrulaması kullanmak istiyorsanız gereklidir. Ayrıntılı kurulum talimatları ve örnekler için OIDC Kimlik Doğrulama sayfasına bakın.
| Anahtar | Açıklama |
|---|---|
OIDC_ENABLED |
OIDC kimlik doğrulamasını etkinleştirip etkinleştirmeyeceğini belirten Boolean. Varsayılan olarak False'dur. |
OIDC_ISSUER |
OIDC sağlayıcı yayımlayıcı URL'si (özel OIDC sağlayıcıları için). |
OIDC_CLIENT_ID |
OAuth istemci kimliği (özel OIDC sağlayıcıları için). |
OIDC_CLIENT_SECRET |
OAuth istemci sırrı (özel OIDC sağlayıcıları için). |
OIDC_NAME |
Sağlayıcı için özel görüntüleme adı. Varsayılan olarak "OIDC"dir. |
OIDC_SCOPES |
OAuth kapsamları. Varsayılan olarak "openid email profile"dır. |
OIDC_USERNAME_CLAIM |
Kullanıcı adı için kullanılacak talep. Varsayılan olarak "preferred_username"dır. |
OIDC_OPENID_CONFIG_URL |
Opsiyonel: OpenID Connect yapılandırma uç noktasına URL (standart /.well-known/openid-configuration kullanılmıyorsa). |
OIDC_DISABLE_LOCAL_AUTH |
Yerel kullanıcı adı/şifre kimlik doğrulamasını devre dışı bırakıp bırakmayacağını belirten Boolean. Varsayılan olarak False'dur. |
OIDC_AUTO_REDIRECT |
Sadece bir sağlayıcı yapılandırıldığında otomatik olarak OIDC'ye yönlendirilip yönlendirilmeyeceğini belirten Boolean. Varsayılan olarak False'dur. |
Yerleşik OIDC sağlayıcıları¶
Yerleşik sağlayıcılar (Google, Microsoft, GitHub) için bu ayarları kullanın:
| Anahtar | Açıklama |
|---|---|
OIDC_GOOGLE_CLIENT_ID |
Google OAuth için istemci kimliği. |
OIDC_GOOGLE_CLIENT_SECRET |
Google OAuth için istemci sırrı. |
OIDC_MICROSOFT_CLIENT_ID |
Microsoft OAuth için istemci kimliği. |
OIDC_MICROSOFT_CLIENT_SECRET |
Microsoft OAuth için istemci sırrı. |
OIDC_GITHUB_CLIENT_ID |
GitHub OAuth için istemci kimliği. |
OIDC_GITHUB_CLIENT_SECRET |
GitHub OAuth için istemci sırrı. |
OIDC Rol Eşlemesi¶
Bu ayarlar, kimlik sağlayıcınızdan OIDC gruplarını/rollerini Gramps Web kullanıcı rollerine eşlemenizi sağlar:
| Anahtar | Açıklama |
|---|---|
OIDC_ROLE_CLAIM |
Kullanıcının gruplarını/rollerini içeren OIDC jetonundaki talep adı. Varsayılan olarak "groups"dır. |
OIDC_GROUP_ADMIN |
Gramps "Yönetici" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
OIDC_GROUP_OWNER |
Gramps "Sahip" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
OIDC_GROUP_EDITOR |
Gramps "Editör" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
OIDC_GROUP_CONTRIBUTOR |
Gramps "Katkıda Bulunan" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
OIDC_GROUP_MEMBER |
Gramps "Üye" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
OIDC_GROUP_GUEST |
Gramps "Misafir" rolüne eşlenen OIDC sağlayıcınızdan grup/rol adı. |
Sadece AI özellikleri için ayarlar¶
Bu ayarlar, sohbet veya anlamsal arama gibi AI destekli özellikleri kullanmak istiyorsanız gereklidir.
| Anahtar | Açıklama |
|---|---|
LLM_BASE_URL |
OpenAI uyumlu sohbet API'si için temel URL. Varsayılan olarak None'dır, bu OpenAI API'sini kullanır. |
LLM_MODEL |
OpenAI uyumlu sohbet API'si için kullanılacak model. Ayarlanmadığında (varsayılan), sohbet devre dışıdır. v3.6.0 itibarıyla, AI asistanı araç çağırma yetenekleri ile Pydantic AI kullanmaktadır. |
VECTOR_EMBEDDING_MODEL |
Anlamsal arama vektör gömme işlemleri için kullanılacak Sentence Transformers modeli. Ayarlanmadığında (varsayılan), anlamsal arama ve sohbet devre dışıdır. |
LLM_MAX_CONTEXT_LENGTH |
LLM'ye sağlanan aile ağacı bağlamı için karakter sınırı. Varsayılan olarak 50000'dir. |
LLM_SYSTEM_PROMPT |
LLM sohbet asistanı için özel sistem istemi (v3.6.0+). Ayarlanmadığında, varsayılan soybilim optimize edilmiş istemi kullanılır. |
Örnek yapılandırma dosyası¶
Üretim için minimal bir yapılandırma dosyası şu şekilde görünebilir: ```python TREE="Ailem Ağacı" BASE_URL="https://mytree.example.com" SECRET_KEY="..." # gizli anahtarınız USER_DB_URI="sqlite:////path/to/users.sqlite" EMAIL_HOST="mail.example.com" EMAIL_PORT=465 EMAIL_USE_SSL=True # 465 portu için örtük SSL kullanın EMAIL_HOST_USER="gramps@example.com" EMAIL_HOST_PASSWORD="..." # SMTP şifreniz DEFAULT_FROM_EMAIL="gramps@example.com"