DoconutOptions
Διαμορφώστε τις υπηρεσίες Doconut
DoconutOptions (namespace Doconut) είναι το μοναδικό αντικείμενο διαμόρφωσης για ολόκληρο το SDK. Το διαμορφώνετε μία φορά, μέσα στο AddDoconut(), και καταχωρείται ως singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Ιδιότητες
| Τύπος | Ιδιότητα | Προεπιλογή | Περιγραφή |
|---|---|---|---|
bool | ShowDoconutInfo | false | Όταν true, ένα αίτημα middleware χωρίς διακριτικό επιστρέφει μια μπάνερ έκδοσης (Doconut <version> is running on <host>) αντί για 404. Χρήσιμο ως έλεγχος καπνού· αφήστε το false στην παραγωγή. |
bool | UnsafeMode | false | Όταν true, παραλείπεται ο έλεγχος ασφαλείας της ASP.NET‑session στα αιτήματα σελίδας. Αφήστε το false στην παραγωγή (δείτε Βασικές Έννοιες → Συνεδρίες & Ασφάλεια). |
string | MiddlewarePath | "/doconut" | Τιμή συντονισμού για το endpoint page-image. Επικυρώνεται, αλλά δεν δημιουργεί κλάδο pipeline· διατηρήστε το ευθυγραμμισμένο με την πραγματική αντιστοίχιση UseDoconut() και τον πελάτη BasePath. |
string | ResourcesPath | "/doconut-res" | Πρόθεμα διαδρομής URL για τους ενσωματωμένους πόρους JS/CSS/εικόνας/γραμματοσειράς. |
string | LicensePath | "" | Διαδρομή προς το αρχείο άδειας. Κενό → επόμενη πηγή άδειας, έπειτα αυτόματη ανίχνευση· αν δεν βρεθεί τίποτα → κατάσταση αξιολόγησης με υδατογράφημα χωρίς δυνατότητες. |
string | LicenseContent | "" | Ακατέργαστο περιεχόμενο άδειας XML (βάση δεδομένων, μεταβλητή περιβάλλοντος, διαχειριστής μυστικών). Έχει προτεραιότητα έναντι του LicensePath. |
Stream? | LicenseStream | null | Άδεια ως ροή, διαβάζεται μία φορά κατά την εκκίνηση. Έχει προτεραιότητα έναντι και των δύο άλλων πηγών. |
bool | ResetLicense | false | Δεσμευμένη σημαία συμβατότητας. Η τρέχουσα υλοποίηση .NET 8 δεν τη χρησιμοποιεί· επανεκκινήστε την εφαρμογή μετά την αντικατάσταση μιας άδειας. |
DoconutPluginRegistry | PluginRegistry | — | Καταχωρητής μόνο για ανάγνωση που συλλέγει συνεισφορές plugins· χρησιμοποιείται από το εργοστάσιο προβολέα. Συμπληρώστε μέσω του AddPlugin<T>(). |
Προτεραιότητα αδειών (επιβάλλεται κατά την καταχώριση υπηρεσίας): LicenseStream → LicenseContent → LicensePath → αυτόματη ανίχνευση (δείτε Ξεκινώντας → Ρύθμιση Άδειας).
Μέθοδοι
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Χρησιμοποιήστε αυτή τη μέθοδο για τα κυκλοφορημένα πακέτα Converter, DICOM και Signer με επιλογή opt‑in. Η Σχόλιο και η κανονική Αναζήτηση είναι ενσωματωμένες λειτουργίες με άδεια και δεν χρησιμοποιούν το AddPlugin<TPlugin>().
Καταχωρεί ένα plugin πρώτου μέρους (Converter, DICOM, Signer). Fluent — επιστρέφει το αντικείμενο options. AddDoconut() ρίχνει InvalidOperationException για έλλειψη άδειας, παλιό αρχείο TRIAL ή πληρωμένη άδεια που δεν παρέχει τη δυνατότητα του plugin. Οι προσωρινές/Δοκιμαστικές καταχωρίσεις διατηρούνται μετά τη λήξη και υπόκεινται στην πύλη χρόνου εκτέλεσης (δείτε Βασικές Έννοιες → Plugin System).
Το widget Converter με επιλογή opt‑in ενεργοποιείται με το AddConverterWidget() και εμφανίζεται μέσω της μόνο‑ανά‑ανάγνωση ιδιότητας ConverterWidget· οι επιλογές του τεκμηριώνονται στη σελίδα Converter Plugin (Plugins → Converter Plugin). Το widget Signer με επιλογή opt‑in ενεργοποιείται με τον ίδιο τρόπο, με το AddSignerWidget(), και εμφανίζεται μέσω της μόνο‑ανά‑ανάγνωση ιδιότητας SignerWidget· δείτε Signer Plugin.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — προαιρετικό το αρχικό σημείο
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Καταχωρεί έναν προσαρμοσμένο προβολέα για μια επέκταση αρχείου. Οι προσαρμοσμένοι προβολείς έχουν προτεραιότητα έναντι των ενσωματωμένων και των προβολέων plugins και δεν περιορίζονται από άδεια. Όταν το defaultConfig παραλείπεται και ένα έγγραφο ανοίγει χωρίς ρητή διαμόρφωση, χρησιμοποιείται ένα ImageConfig.
Ρίχνει ArgumentException (Extension must be a non-empty file extension.) για κενή επέκταση και ArgumentNullException για μηδενικό εργοστάσιο.
Επικύρωση εκκίνησης
AddDoconut() επικυρώνει τις επιλογές fail‑fast, ώστε μια λανθασμένη διαμόρφωση να εμφανίζεται ως σαφής εξαίρεση κατά την εκκίνηση αντί για μπερδεμένα 404 κατά το χρόνο αιτήματος:
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.Κοινές ρυθμίσεις
// Παραγωγή: ρητή άδεια, όλα κλειδωμένα (όλες οι προεπιλογές ασφαλείας)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Προσαρμοσμένες διαδρομές (π.χ. για αποφυγή σύγκρουσης διαδρομής)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Όταν αλλάζετε το ResourcesPath, διατηρήστε το ResPath του widget πελάτη σε συγχρονισμό (δείτε ViewerConfig).
MiddlewarePath δεν είναι αυτόματος χαρτογράφος διαδρομών ASP.NET Core. Αν το Doconut πρέπει να απαντά μόνο κάτω από ένα προσαρμοσμένο πρόθεμα, τοποθετήστε το UseDoconut() σε αυτόν τον κλάδο (π.χ. με το app.Map("/docs-engine", branch => branch.UseDoconut())) και ορίστε το BasePath του πελάτη σε αυτό το πρόθεμα χωρίς το αρχικό / ('docs-engine').
Ήταν αυτή η σελίδα χρήσιμη;