Lisans Kurulumu

Doconut'un lisans dosyanızı nerede aradığı

Bir lisans olmadan, Doconut hâlâ belgeleri render eder — her sayfa sadece bir değerlendirme filigranı taşır. Bu sayfa, bir lisans sağlamanın dört yolunu ve birden fazla ayarlandığında tam önceliği kapsar.

Lisansı sağlamanın dört yolu

Dört tane vardır: DoconutOptions üzerindeki üç açık kaynak — bir akış, ham içerik veya bir dosya yolu — ve hiçbiri ayarlı olmadığında otomatik keşif. Birden fazla ayarlandığında, öncelik kesin olarak şu şekildedir:

LicenseStream üstün gelir LicenseContent üstün gelir LicensePath üstün gelir otomatik arama.

Yol ile

LicensePath tam olarak verildiği gibi File.Exists'a iletilir. Göreceli bir yol, işlemin şu anki çalışma dizinine göre çözülür — projenizin klasörüne değil ve Program.cs'nin bulunduğu klasöre de değil. Yol çözülemezse, Doconut hata atmaz ve otomatik aramaya geri dönmez — sadece lisans yüklemez ve görüntüleyici filigran ekler. Otomatik arama yalnızca LicensePath, LicenseContent veya LicenseStream hiçbiri ayarlı olmadığında çalışır. Aynı klasördeki (Doconut.Viewer.<Capability>.lic) eklenti başına lisans dosyaları onunla birlikte okunur, bu yüzden LicensePath ve AddPlugin<...>() temel lisansın yanında eklenti lisansları bulunduğunda birlikte çalışır.

Mutlak bir yol tercih edin (örneğin IWebHostEnvironment.WebRootPath veya AppContext.BaseDirectory'den oluşturulan), ya da LicensePath'i tamamen atlayıp aşağıdaki otomatik keşfe güvenin.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});

Akış ile

LicenseStream başlangıçta bir kez okunur — lisansın bir dosya yerine gizli bir depodan gelmesi durumunda kullanışlıdır.

csharp
// Öncelik: LicenseStream > LicenseContent > LicensePath > otomatik arama.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

İçerik ile

LicenseContent lisans metnini doğrudan kabul eder — bir ortam değişkeni, bir veritabanı veya bir gizli yönetici aracılığıyla:

csharp
// Veritabanı, ortam değişkeni veya gizli yönetici üzerinden Lisans XML'i —
// diskte dosya yok. Sadece LicenseStream tarafından geçilir.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Otomatik keşif

Üç açık kaynağın hiçbirini yapılandırmazsanız, Doconut lisansı kendisi arar:

csharp
// Hiçbir şey yapılandırmayın, Doconut lisansı kendisi arar, yalnızca bu iki klasörde:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (derleme çıktısının içindeki wwwroot)
// Önce Doconut.lic, ardından Doconut.Viewer.lic ve eklenti başına olanları arar.
// bu dosyanın yanında Doconut.Viewer.<Capability>.lic dosyaları.
builder.Services.AddDoconut();

Sondaj klasörleri, sırasıyla, ve her birinde aranan dosya adları:

text
1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot

Filenames (checked in each folder above, in order):
  Doconut.lic                          — base viewer license (checked first)
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin license, alongside the base license

wwwroot klasörünün dışındaki hiçbir şey okunmaz: çıktı klasöründeki bir .lic veya wwwroot/lib içindeki bir şey yok sayılır.

Lisansı çıktı klasörünüze kopyalayın

İşlem proje klasöründen çalışmadığında — yayınlanmış bir uygulama, IIS, bir konteyner, bir test çalıştırıcı — ilk sondaj kaçırılır ve ikinci sondaj, {AppContext.BaseDirectory}/wwwroot, dosyayı bulmak zorundadır. SDK'nın kendi test uygulaması, her derlemede bu MSBuild hedefiyle lisansları oraya kopyalar:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- İlk olarak silin, böylece wwwroot içindeki bir .lic dosyasının yeniden adlandırılması veya kaldırılması da çıktıda yer almaz. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Hedef $(OutDir)wwwroot olmalıdır: çıktı köküne kopyalanan bir .lic otomatik arama tarafından asla bulunmaz. Bu sayfadaki LicensePath örnekleri aynı konuma işaret eder.

.lic dosyalarını kaynak kontrolünden dışarıda tutun — uygulamanın yanına dağıtın, ya da gizli deponuzdan LicenseContent veya LicenseStream aracılığıyla lisansı enjekte edin.

Lisans olmadan ne olur

Eksik bir lisans hata oluşturmaz. AddDoconut() başarılı olur, uygulama başlar ve görüntüleyici çalışır — ancak her sayfa bir değerlendirme filigranı taşır ve hiçbir isteğe bağlı yetenek verilmez.

Bulunan ancak reddedilen bir lisans dosyası farklıdır. Geçersiz bir imza, müdahale, kara listeye alınma veya lisansın sürüm penceresinin dışındaki bir derleme, OpenDocumentAsync'nin LicenseException'ı License.RejectionMessage ile atmasına neden olur. Reddetme mesajı olmayan takvim süresi dolmuş bir lisans, filigranlı modda devam eder.

Eklentiler yeteneklere ihtiyaç duyar

İlgili bir yetkiye sahip olmayan bir eklentiyi kaydetmek farklıdır: eksik bir lisans, eski bir TRIAL dosyası veya o yeteneği içermeyen bir ücretli lisans için, AddDoconut() InvalidOperationException hatası verir, bu yüzden uygulama başlatılamaz. Örneğin, Converter eklentisini, Converter yetkisini veren bir lisans olmadan kaydetmek:

text
InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.

Mesaj, düzeltmeyi doğrudan söyler: ya o eklenti için options.AddPlugin<...>() çağrısını kaldırın, ya da yeteneği veren bir ücretli lisans ya da aktif bir Geçici/Demo (NFR) lisansı kurun. Geçici kayıtların son tarihlerini geçmesine izin verilir, böylece önceden yapılandırılmış bir uygulama yeniden başlatma sırasında çökmek yerine çalışma zamanında gerileyebilir; süresi dolduğunda ise yetenekleri hâlâ iptal edilir.

Yüklenen lisansı doğrula

IDoconutLicenseService'ı kullanın, SDK tarafından kullanılan aynı gerçek kaynağı, kimliği doğrulanmış bir tanı uç noktasını ortaya çıkarmak veya özellik bayraklarını yönetmek için. Lisans içeriğini veya anahtarlarını geri döndürmeyin.

csharp
app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(new
{
    viewer = license.IsViewerLicensed || license.IsTemporary,
    temporary = license.IsTemporary,
    search = license.IsCapabilityGranted(LicenseCapability.Search),
    annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
    converter = license.HasConverter,
    dicom = license.HasDicom
}));

Lisans, AddDoconut() kaydı sırasında okunur. ResetLicense şu anda aktif bir yeniden yükleme yolu olmayan bir uyumluluk özelliğidir, bu yüzden bir lisans dosyasını değiştirmek uygulamayı yeniden başlatmayı gerektirir.

Sorun giderme matrisi

SemptomMuhtemel nedenKontrol
Görüntüleyici çalışıyor ancak her sayfa filigranlıLisans yüklenmedi veya lisans takvim süresi dolmuşIDoconutLicenseService'ı çözün; çıktı dizinini ve işlem çalışma dizinini doğrulayın
AddDoconut() bir eklenti için hata verirLisans o eklenti yeteneğini vermiyorIsCapabilityGranted(...)'ı kontrol edin ve satın almadığınız kayıtları kaldırın
Yapılandırılmış bir göreli yol yerel olarak çalışıyor ancak IIS/konteynerde çalışmıyorİşlem çalışma dizini değiştiAppContext.BaseDirectory'ı kullanın veya mutlak bir yol
Değiştirilen .lic dosyası etkisizTekil lisans hizmeti zaten oluşturulmuşUygulamayı yeniden başlatın
OpenDocumentAsync LicenseException hatası verirİmza, domain, sürüm penceresi, kara liste veya eklenti çalışma zamanı kapısı lisansı reddettiİstisna/red mesajını güvensiz istemcilere göstermeden okuyun

Sonraki adımlar

  • Lisanslama — yetenekler, lisans seviyeleri ve çalışma zamanında neyin yüklendiğini doğrulama.
  • Sorun Giderme — filigranlar, reddedilen lisanslar ve yetenek hataları.

Bu sayfa yardımcı oldu mu?