Konfiguracja licencji

Gdzie Doconut szuka pliku licencji w IIS

Bez licencji Doconut nadal renderuje dokumenty — każda strona zawiera znak wodny oceny. Ta strona opisuje cztery sposoby dostarczenia licencji w Global.asax, gdzie Doconut szuka, gdy nie podasz żadnej, oraz co się dzieje, gdy brakuje licencji wtyczki.

Cztery sposoby dostarczenia licencji

Istnieją trzy wyraźne źródła w DoconutOptions — ścieżka do pliku, strumień lub surowa zawartość — oraz automatyczne wykrywanie, gdy żadne z nich nie jest ustawione. Wszystkie są odczytywane raz, w DoconutHost.Initialize. Gdy ustawionych jest więcej niż jedno, kolejność jest następująca:

LicenseStream ma pierwszeństwo przed LicenseContent, przed LicensePath, przed automatycznym wykryciem.

Poprzez ścieżkę

Podaj LicensePath pełną ścieżkę. Ścieżka względna jest rozwiązywana względem bieżącego katalogu procesu, a w IIS jest to folder własny procesu roboczego, a nie Twoja witryna. HostingEnvironment.MapPath zamienia ścieżkę względną względem witryny na pełną:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

Jeśli plik nie istnieje, Doconut nie zgłasza wyjątku i nie przechodzi do automatycznego wykrycia: nie ładuje żadnej licencji, a przeglądarka dodaje znak wodny. Pliki licencji poszczególnych wtyczek w tym samym folderze (Doconut.Viewer.<Capability>.lic) są odczytywane razem z nią, więc LicensePath i AddPlugin<...>() działają razem, gdy licencje wtyczek znajdują się obok głównej licencji.

Poprzez strumień

LicenseStream jest odczytywany raz, przy uruchomieniu — przydatny, gdy licencja pochodzi z zasobu osadzonego lub magazynu tajemnic, a nie z pliku na dysku.

csharp
// Priorytet: LicenseStream > LicenseContent > LicensePath > auto-wyszukiwanie.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Poprzez zawartość

LicenseContent przyjmuje sam tekst licencji — z zmiennej środowiskowej, bazy danych lub magazynu tajemnic — więc nie trzeba wdrażać pliku licencji wraz z witryną.

csharp
// XML licencji z bazy danych, zmiennej środowiskowej lub magazynu tajemnic -
// brak pliku na dysku. Przeważany jedynie przez LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatyczne wykrywanie

Nie ustawiając żadnego z trzech, Doconut sam wyszukuje licencję:

csharp
// Nie konfiguruj niczego, a Doconut sam wyszukuje licencję w następującej kolejności:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (pod IIS: katalog główny witryny)
// Najpierw szuka Doconut.lic; jeśli go brakuje, Doconut.Viewer.lic oraz dowolne
// pliki Doconut.Viewer.<Capability>.lic dla każdej wtyczki.
Doconut.DoconutHost.Initialize();

Dwa foldery, w kolejności, oraz pliki, które są przeszukiwane:

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

W IIS i IIS Express, AppContext.BaseDirectory jest głównym folderem witryny — tym, który zawiera Web.config — a nie jego folderem bin. Dlatego licencja powinna znajdować się w wwwroot w głównym folderze witryny:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

W projekcie, trzymaj wwwroot\*.lic obok Web.config i wdrażaj folder wraz z witryną. Żaden krok budowania nie musi go kopiować. .lic w innym miejscu — w bin\, obok Web.config, lub w podfolderze wwwroot — nigdy nie jest odczytywany.

Trzymaj pliki .lic poza kontrolą wersji. Wdrażaj je razem z witryną lub dostarczaj licencję przez LicenseContent lub LicenseStream z Twojego magazynu tajemnic.

Co się dzieje bez licencji

Brak licencji nie powoduje wyjątku. DoconutHost.Initialize kończy się powodzeniem, strona się uruchamia, a przeglądarka działa, ale każda strona zawiera znak wodny oceny i nie przyznano żadnych opcjonalnych funkcji.

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

Wtyczki potrzebują swojej licencji przy uruchamianiu

Rejestrowanie wtyczki, której funkcjonalność nie jest przyznana przez żadną licencję, zatrzymuje aplikację przy uruchamianiu. DoconutHost.Initialize rzuca w Application_Start:

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.

W środowisku System.Web nie widzisz tej wiadomości w przeglądarce. Każde żądanie do strony odpowiada pustym 500 — brak strony błędu, brak stosu wywołań, nic w logu IIS. Wyjątek jest zapisywany tylko w Windows event log (log aplikacji, źródło ASP.NET). Jeśli cała strona przestaje odpowiadać zaraz po dodaniu linii AddPlugin, sprawdź pliki licencji w wwwroot przed kodem: Doconut.Viewer.<Capability>.lic wtyczki musi znajdować się obok Doconut.Viewer.lic, a bez podstawowej licencji pliki wtyczki nie są w ogóle odczytywane.

Zweryfikuj załadowaną licencję

IDoconutLicenseService jest tym samym źródłem prawdy, którego używa SDK. Rozwiąż go z DoconutHost.Services, aby udostępnić uwierzytelniony punkt diagnostyczny lub sterować flagami funkcji — nigdy nie zwracaj zawartości licencji:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

Licencja jest odczytywana raz, w DoconutHost.Initialize. Po zamianie pliku licencji, zrecykluj pulę aplikacji (lub dotknij Web.config), aby Application_Start uruchomiło się ponownie.

Rozwiązywanie problemów

ObjawPrawdopodobna przyczynaSprawdź
Przeglądarka działa, ale każda strona ma znak wodnyNie znaleziono licencjiCzy .lic znajduje się w <site root>\wwwroot? Wywołaj powyższy punkt statusu
Każde żądanie odpowiada pustym 500 zaraz po dodaniu wtyczkiZarejestrowana wtyczka nie ma przyznanej licencjiLog zdarzeń Windows, źródło ASP.NET; .lic wtyczki obok Doconut.Viewer.lic
LicensePath działa na twoim komputerze, ale nie na serwerzeŚcieżka względna rozwiązywana względem folderu procesu roboczegoZbuduj to przy użyciu HostingEnvironment.MapPath("~/wwwroot/...")
Zastąpiony plik .lic nie ma efektuLicencja została odczytana przy uruchomieniu aplikacjiZrecykluj pulę aplikacji
OpenDocumentAsync rzuca LicenseExceptionLicencja została znaleziona, ale odrzuconaPrzeczytaj komunikat wyjątku; nie wyświetlaj go nieufnym klientom

Kolejne kroki

Czy ta strona była pomocna?