Konfiguracja licencji

Where Doconut looks for your license file

Bez licencji Doconut nadal renderuje dokumenty — każda strona po prostu zawiera znak wodny oceny. Ta strona opisuje cztery sposoby dostarczenia licencji oraz dokładny priorytet, gdy ustawionych jest więcej niż jeden.

Cztery sposoby dostarczenia licencji

Istnieją cztery: trzy explicite źródła w DoconutOptions — strumień, surowa treść lub ścieżka do pliku — oraz automatyczne wykrywanie, gdy żadne z nich nie jest ustawione. Gdy ustawionych jest więcej niż jedno, priorytet jest następujący:

LicenseStream wygrywa nad LicenseContent, który wygrywa nad LicensePath, który wygrywa nad auto-search.

Według ścieżki

LicensePath jest przekazywany do File.Exists dokładnie tak, jak podano. Ścieżka względna jest rozwiązywana względem bieżącego katalogu roboczego procesu — nie folderu projektu, ani folderu, w którym znajduje się Program.cs. Jeśli ścieżka nie zostanie znaleziona, Doconut nie zgłasza wyjątku i nie przechodzi do automatycznego wyszukiwania — po prostu nie ładuje licencji i podgląd zostaje oznaczony znakiem wodnym. Automatyczne wyszukiwanie uruchamia się tylko wtedy, gdy żadne z LicensePath, LicenseContent ani LicenseStream nie jest ustawione. Pliki licencji per‑plugin w tym samym folderze (Doconut.Viewer.<Capability>.lic) są odczytywane razem z nim, więc LicensePath i AddPlugin<...>() współdziałają, gdy licencje pluginów znajdują się obok głównej licencji.

Preferuj ścieżkę bezwzględną (na przykład zbudowaną z IWebHostEnvironment.WebRootPath lub AppContext.BaseDirectory), albo całkowicie pomiń LicensePath i polegaj na automatycznym wykrywaniu poniżej.

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

Według strumienia

LicenseStream jest odczytywany raz przy uruchomieniu — przydatny, gdy licencja pochodzi z tajnego magazynu zamiast z pliku na dysku.

csharp
// Priorytet: LicenseStream > LicenseContent > LicensePath > auto-search.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Według treści

LicenseContent przyjmuje sam tekst licencji — z zmiennej środowiskowej, bazy danych lub menedżera sekretów:

csharp
// License XML z bazy danych, zmiennej środowiskowej lub menedżera tajemnic —
// brak pliku na dysku. Zastępowany jedynie przez LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatyczne wykrywanie

Nie skonfiguruj żadnego z trzech explicite źródeł, a Doconut sam wyszuka licencję:

csharp
// Nie konfiguruj niczego, a Doconut sam wyszukuje licencję, tylko w tych dwóch folderach:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot wewnątrz folderu wyjściowego kompilacji)
// Najpierw szuka Doconut.lic; jeśli go brakuje, Doconut.Viewer.lic oraz dowolne
// pliki Doconut.Viewer.<Capability>.lic per-wtyczka.
builder.Services.AddDoconut();

Foldery sondowania, w kolejności, oraz nazwy plików, które są poszukiwane:

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

Filenames, in order (each one looked for in folder 1, then folder 2):
  Doconut.lic                          — legacy all-in-one license; if found, nothing else is read
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin licenses, read only when Doconut.Viewer.lic was found

Nic poza folderem wwwroot nie jest odczytywane: .lic w samym folderze wyjściowym lub w wwwroot/lib jest ignorowane.

Skopiuj licencję do folderu wyjściowego

Gdy proces nie uruchamia się z folderu projektu — opublikowana aplikacja, IIS, kontener, uruchamiacz testów — pierwsza sonda nie znajduje pliku, a druga, {AppContext.BaseDirectory}/wwwroot, musi go znaleźć. Ten cel MSBuild kopiuje licencje tam przy każdym budowaniu:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Najpierw usuń, aby zmiana nazwy lub usunięcie pliku .lic w wwwroot również usunęło go z wyjścia. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Miejsce docelowe musi być $(OutDir)wwwroot: .lic skopiowany do korzenia wyjścia nigdy nie zostanie znaleziony przez automatyczne wyszukiwanie. Przykłady LicensePath na tej stronie wskazują to samo miejsce.

Trzymaj pliki .lic poza kontrolą wersji — wdrażaj je razem z aplikacją lub wstrzykuj licencję przez LicenseContent lub LicenseStream z twojego magazynu sekretów.

Co się dzieje bez licencji

Brak licencji nie powoduje wyjątku. AddDoconut() odnosi sukces, aplikacja się uruchamia, a przeglądarka działa — ale każda strona zawiera znak wodny oceny i nie przyznano żadnej opcjonalnej funkcji.

Plik licencji, który został znaleziony, ale odrzucony, jest inny. Nieprawidłowy podpis, manipulacja, czarna lista lub kompilacja poza oknem wersji licencji powodują, że OpenDocumentAsync rzuca LicenseException z License.RejectionMessage. Wygasła tymczasowa licencja kontynuuje działanie w trybie znakowanym. Płatna licencja, której data subskrypcji minęła, nadal działa, czysto i ze swoimi możliwościami, na każdej kompilacji wydanej przed tą datą.

Wtyczki wymagają uprawnień

Rejestrowanie wtyczki bez odpowiadającego uprawnienia jest inne: w przypadku brakującej licencji, starszego pliku TRIAL lub płatnej licencji bez tej funkcji, AddDoconut() rzuca InvalidOperationException, więc aplikacja się nie uruchamia. Na przykład, rejestrowanie wtyczki Converter bez licencji, która przyznaje Converter:

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.

Komunikat podaje rozwiązanie bezpośrednio: albo usuń wywołanie options.AddPlugin<...>() dla tej wtyczki, albo zainstaluj płatną licencję lub aktywną tymczasową/licencję demonstracyjną (NFR), która przyznaje tę funkcję. Tymczasowe rejestracje mogą przetrwać po dacie wygaśnięcia, aby już skonfigurowana aplikacja mogła degradować się w czasie działania zamiast awarii przy ponownym uruchomieniu; po wygaśnięciu ich uprawnienia są nadal cofane.

Zweryfikuj załadowaną licencję

Użyj IDoconutLicenseService, tego samego źródła prawdy używanego przez SDK, aby udostępnić uwierzytelniony punkt diagnostyczny lub sterować flagami funkcji. Nie zwracaj treści licencji ani kluczy.

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
}));

Licencja jest odczytywana podczas rejestracji AddDoconut(). ResetLicense jest obecnie właściwością zgodności bez aktywnej ścieżki przeładowania, więc zastąpienie pliku licencji wymaga ponownego uruchomienia aplikacji.

Macierz rozwiązywania problemów

ObjawPrawdopodobna przyczynaSprawdź
Przeglądarka działa, ale każda strona jest znakowanaNie załadowano licencji lub tymczasowa licencja wygasłaRozwiąż IDoconutLicenseService; zweryfikuj katalog wyjściowy i katalog roboczy procesu
AddDoconut() rzuca wyjątek dla wtyczkiLicencja nie przyznaje tej wtyczce uprawnieniaSprawdź IsCapabilityGranted(...) i usuń rejestracje, których nie zakupiłeś
Skonfigurowana ścieżka względna działa lokalnie, ale nie w IIS/kontenerzeKatalog roboczy procesu się zmieniłUżyj AppContext.BaseDirectory lub ścieżki bezwzględnej
Zastąpiony plik .lic nie ma efektuUsługa licencji singleton została już utworzonaUruchom ponownie aplikację
OpenDocumentAsync rzuca LicenseExceptionPodpis, domena, okno wersji, czarna lista lub bramka czasu działania wtyczki odrzuciły licencjęOdczytaj komunikat wyjątku/odrzucenia bez udostępniania go nieufnym klientom

Kolejne kroki

  • Licencjonowanie — możliwości, poziomy licencji i weryfikacja tego, co zostało załadowane w czasie działania.
  • Rozwiązywanie problemów — znaki wodne, odrzucone licencje i błędy uprawnień.

Czy ta strona była pomocna?