DoconutOptions
Konfiguracja usług Doconut
DoconutOptions (namespace Doconut) jest jedynym obiektem konfiguracyjnym dla całego SDK. Konfigurujesz go raz, wewnątrz AddDoconut(), i jest rejestrowany jako singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Properties
| Typ | Właściwość | Domyślne | Opis |
|---|---|---|---|
bool | ShowDoconutInfo | false | Gdy true, żądanie middleware bez tokenu zwraca baner wersji (Doconut <version> is running on <host>) zamiast 404. Przydatne jako szybki test; pozostaw false w środowisku produkcyjnym. |
bool | UnsafeMode | false | Gdy true, pomija sprawdzanie bezpieczeństwa sesji ASP.NET przy żądaniach stron. Pozostaw false w produkcji (zobacz Podstawowe pojęcia → Sesje i bezpieczeństwo). |
string | MiddlewarePath | "/doconut" | Wartość koordynacji dla punktu końcowego page-image. Jest walidowana, ale nie montuje gałęzi potoku; utrzymuj ją zgodną z rzeczywistym mapowaniem UseDoconut() i klientem BasePath. |
string | ResourcesPath | "/doconut-res" | Prefiks ścieżki URL dla osadzonych zasobów JS/CSS/obrazów/czcionek. |
string | LicensePath | "" | Ścieżka do pliku licencji. Pusta → następne źródło licencji, potem automatyczne wykrywanie; brak wyniku → stan oceny z znakowaniem wodnym bez możliwości. |
string | LicenseContent | "" | Surowa zawartość licencji XML (baza danych, zmienna środowiskowa, manager sekretów). Ma pierwszeństwo przed LicensePath. |
Stream? | LicenseStream | null | Licencja jako strumień, odczytywana raz przy uruchomieniu. Ma pierwszeństwo przed oboma innymi źródłami. |
bool | ResetLicense | false | Zarezerwowany znacznik kompatybilności. Obecna implementacja .NET 8 go nie wykorzystuje; uruchom ponownie aplikację po wymianie licencji. |
DoconutPluginRegistry | PluginRegistry | — | Rejestr tylko do odczytu zbierający wkłady wtyczek; wykorzystywany przez fabrykę przeglądarek. Wypełnij za pomocą AddPlugin<T>(). |
Priorytet licencji (wyegzekwowany przy rejestracji usług): LicenseStream → LicenseContent → LicensePath → automatyczne wykrywanie (zobacz Rozpoczęcie → Konfiguracja licencji).
Methods
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Użyj tej metody dla wydanych pakietów Converter, DICOM i Signer z opcją opt-in. Adnotacje i normalne wyszukiwanie są wbudowanymi funkcjami licencjonowanymi i nie używają AddPlugin<TPlugin>().
Rejestruje wtyczkę pierwszej strony (Converter, DICOM, Signer). Fluent — zwraca instancję opcji. AddDoconut() rzuca InvalidOperationException przy brakującej licencji, przestarzałym pliku TRIAL lub płatnej licencji, która nie przyznaje możliwości wtyczki. Rejestracje tymczasowe/demo są zachowywane po wygaśnięciu i podlegają bramce w czasie wykonywania (zobacz Podstawowe pojęcia → System wtyczek).
Widżet Converter z opcją opt-in jest włączony przy użyciu AddConverterWidget() i udostępniony przez właściwość tylko do odczytu ConverterWidget; jego opcje są udokumentowane na stronie wtyczki Converter (Wtyczki → Wtyczka Converter). Widżet Signer z opcją opt-in jest włączony w ten sam sposób, przy użyciu AddSignerWidget(), i udostępniony przez właściwość tylko do odczytu SignerWidget; zobacz Wtyczka Signer.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — opcjonalna kropka początkowa
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Rejestruje niestandardowy przeglądacz dla rozszerzenia pliku. Niestandardowe przeglądarki mają pierwszeństwo przed wbudowanymi i przeglądarkami wtyczek i nie są ograniczone licencją. Gdy defaultConfig jest pominięte i dokument otwiera się bez wyraźnej konfiguracji, używany jest ImageConfig.
Rzuca ArgumentException (Extension must be a non-empty file extension.) przy pustym rozszerzeniu i ArgumentNullException przy null factory.
Startup validation
AddDoconut() waliduje opcje fail-fast, więc błędna konfiguracja objawia się jako wyraźny wyjątek przy uruchomieniu zamiast mylących 404 podczas żądania:
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.Common configurations
// Produkcja: jawna licencja, wszystko zabezpieczone (wszystkie domyślne ustawienia bezpieczeństwa)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Niestandardowe ścieżki (np. aby uniknąć konfliktu trasy)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Gdy zmieniasz ResourcesPath, utrzymuj w synchronizacji ResPath widżetu klienta (zobacz ViewerConfig).
MiddlewarePath nie jest automatycznym mapowaniem tras ASP.NET Core. Jeśli Doconut ma odpowiadać tylko pod niestandardowym prefiksem, zamontuj UseDoconut() na tej gałęzi (na przykład przy użyciu app.Map("/docs-engine", branch => branch.UseDoconut())) i ustaw klienta BasePath na ten prefiks bez wiodącego / ('docs-engine').
Czy ta strona była pomocna?