DoconutOptions
Doconut hizmetlerini yapılandırın
DoconutOptions (namespace Doconut) bütün SDK için tek yapılandırma nesnesidir. Bunu bir kez, AddDoconut() içinde yapılandırırsınız ve tek bir örnek olarak kaydedilir.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Özellikler
| Tür | Özellik | Varsayılan | Açıklama |
|---|---|---|---|
bool | ShowDoconutInfo | false | true olduğunda, token içermeyen bir middleware isteği 404 yerine bir sürüm banner'ı (Doconut <version> is running on <host>) döndürür. Bir smoke kontrolü olarak faydalıdır; üretimde false bırakın. |
bool | UnsafeMode | false | true olduğunda, sayfa isteklerinde ASP.NET-oturum güvenlik kontrolünü atlar. Üretimde false bırakın (bkz. Temel Kavramlar → Oturumlar & Güvenlik). |
string | MiddlewarePath | "/doconut" | Sayfa-görüntü uç noktası için koordinasyon değeri. Doğrulanır, ancak bir pipeline dalı bağlamaz; gerçek UseDoconut() eşlemesi ve istemci BasePath ile uyumlu tutun. |
string | ResourcesPath | "/doconut-res" | Gömülü JS/CSS/görüntü/font kaynakları için URL yol ön eki. |
string | LicensePath | "" | Lisans dosyasının yolu. Boş → sonraki lisans kaynağı, ardından otomatik keşif; hiçbir şey bulunamazsa → özellikleri olmayan su işaretiyle değerlendirme durumu. |
string | LicenseContent | "" | Ham XML lisans içeriği (veritabanı, ortam değişkeni, gizli yönetici). LicensePath üzerindeki önceliği vardır. |
Stream? | LicenseStream | null | Lisans bir akış olarak, başlangıçta bir kez okunur. Diğer iki kaynağın üzerinde önceliği vardır. |
bool | ResetLicense | false | Ayrılmış uyumluluk bayrağı. Mevcut .NET 8 uygulaması bunu kullanmaz; bir lisansı değiştirdikten sonra uygulamayı yeniden başlatın. |
DoconutPluginRegistry | PluginRegistry | — | Eklenti katkılarını toplayan yalnızca okunabilir kayıt defteri; görüntüleyici fabrikası tarafından tüketilir. AddPlugin<T>() aracılığıyla doldurun. |
Lisans önceliği (servis kaydı sırasında uygulanır): LicenseStream → LicenseContent → LicensePath → otomatik keşif (bkz. Başlarken → Lisans Kurulumu).
Yöntemler
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Bu yöntemi yayınlanan isteğe bağlı Converter, DICOM ve Signer paketleri için kullanın. Açıklama ve normal Arama, yerleşik lisanslı özelliklerdir ve AddPlugin<TPlugin>() kullanmaz.
İlk taraf bir eklenti (Converter, DICOM, Signer) kaydeder. Akıcı — seçenekler örneğini döndürür. AddDoconut() eksik lisans, eski TRIAL dosyası veya eklentinin yeteneğini vermeyen ücretli lisans için InvalidOperationException fırlatır. Geçici/Demo kayıtları süresi dolana kadar tutulur ve çalışma zamanı geçidine tabi olur (bkz. Temel Kavramlar → Eklenti Sistemi).
İsteğe bağlı Converter widget'ı AddConverterWidget() ile etkinleştirilir ve yalnızca okunabilir ConverterWidget özelliği aracılığıyla sunulur; seçenekleri Converter Plugin sayfasında belgelenmiştir (Plugins → Converter Plugin). İsteğe bağlı Signer widget'ı aynı şekilde, AddSignerWidget() ile etkinleştirilir ve yalnızca okunabilir SignerWidget özelliği aracılığıyla sunulur; bkz. Signer Eklentisi.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — baştaki nokta isteğe bağlı
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Bir dosya uzantısı için özel görüntüleyici kaydeder. Özel görüntüleyiciler yerleşik ve eklenti görüntüleyicilerinin önceliğine sahiptir ve lisans kısıtlamasına tabi değildir. defaultConfig atlandığında ve bir belge açık bir yapılandırma olmadan açıldığında, bir ImageConfig kullanılır.
Boş uzantı için ArgumentException (Extension must be a non-empty file extension.) ve null fabrika için ArgumentNullException fırlatır.
Başlangıç doğrulaması
AddDoconut() seçenekleri hızlı başarır, böylece bir yapılandırma hatası başlangıçta net bir istisna olarak ortaya çıkar, istek zamanındaki kafa karıştırıcı 404 hataları yerine:
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.Ortak yapılandırmalar
// Production: açık lisans, her şey kilitlendi (tüm güvenlik varsayılanları)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Özel yollar (örn. bir rota çakışmasını önlemek için)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});ResourcesPath değiştirdiğinizde, istemci widget'ının ResPath değerini senkronize tutun (bkz. ViewerConfig).
MiddlewarePath otomatik bir ASP.NET Core rota eşleyicisi değildir. Doconut yalnızca özel bir ön ek altında yanıt vermeli ise, UseDoconut() bu dalda (örneğin app.Map("/docs-engine", branch => branch.UseDoconut()) ile) bağlayın ve istemci BasePath'yi öndeki / olmadan o ön eke ayarlayın ('docs-engine').
Bu sayfa yardımcı oldu mu?