הגדרת רישיון

היכן Doconut מחפש את קובץ הרישיון שלך

ללא רישיון, Doconut עדיין מציג מסמכים — כל עמוד מציג סימן מים של הערכה. דף זה מסביר את ארבעת הדרכים לספק רישיון, ואת סדר העדיפויות המדויק כאשר מוגדר יותר מאחד.

הרישיון נטען פעם אחת, במהלך AddDoconut(). זה שינוי מהספרייה הקודמת של .NET Standard, שבה הרישיון הועבר למופע של Viewer או הוגדר דרך הקריאות הסטטיות Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...). שיטות אלו אינן מנגנון אתחול בגרסה זו — ראה את מדריך ההגירה.

ארבע דרכים לספק רישיון

יש ארבע: שלוש מקורות מפורשים בDoconutOptions — זרם, תוכן גולמי, או נתיב קובץ — ועוד גילוי אוטומטי כאשר אף אחד מהם לא מוגדר. כאשר מוגדרים יותר מאחד, סדר העדיפויות הוא מדויק:

LicenseStream מנצח על LicenseContent מנצח על LicensePath מנצח על auto-search.

לפי נתיב

LicensePath מועבר לFile.Exists בדיוק כפי שניתן. נתיב יחסי נפתר ביחס לספריית העבודה הנוכחית של התהליך — לא לתיקיית הפרויקט שלך, ולא לתיקייה שבה נמצא Program.cs. אם הנתיב אינו נפתר, Doconut לא זורק חריגה ולא נופל חזרה ל‑auto-search — הוא פשוט לא טוען רישיון והצופה מציג סימן מים. Auto-search פועל רק כאשר אף אחד מLicensePath, LicenseContent, או LicenseStream אינו מוגדר. קבצי הרישיון של כל תוסף באותה תיקייה (Doconut.Viewer.<Capability>.lic) נקראים יחד איתו, ולכן LicensePath ו‑AddPlugin<...>() פועלים יחד כאשר רישיונות התוסף נמצאים לצד רישיון הבסיס.

העדף נתיב מוחלט (למשל שנבנה מIWebHostEnvironment.WebRootPath או AppContext.BaseDirectory), או דלג על LicensePath לחלוטין והסתמך על גילוי אוטומטי למטה.

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

לפי זרם

LicenseStream נקרא פעם אחת באתחול — שימושי כאשר הרישיון מגיע ממאגר סודי במקום מקובץ על הדיסק.

csharp
// עדיפות: LicenseStream > LicenseContent > LicensePath > חיפוש אוטומטי.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

לפי תוכן

LicenseContent מקבל את טקסט הרישיון עצמו — ממשתנה סביבתי, ממסד נתונים, או ממנהל סודות:

csharp
// קובץ XML של הרישיון ממסד נתונים, משתנה סביבתי, או מנהל סודות —
// אין קובץ על הדיסק. נגרע רק על ידי LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

גילוי אוטומטי

אל תגדיר אף אחד משלושת המקורות המפורשים, ו‑Doconut יחפש את הרישיון בעצמו:

csharp
// אל תגדיר דבר, ו‑Doconut יחפש את הרישיון בעצמו, רק בשתי התיקיות האלה:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot בתוך תיקיית פלט הבנייה)
// הוא מחפש תחילה את Doconut.lic; אם הוא חסר, Doconut.Viewer.lic ועוד כל
// קבצי Doconut.Viewer.<Capability>.lic לפי יכולת.
builder.Services.AddDoconut();

תיקיות הסריקה, בסדר, ושמות הקבצים המחופשים:

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-capability licenses, read only when Doconut.Viewer.lic was found

שום דבר מחוץ לתיקייה wwwroot אינו נקרא: .lic בתיקיית הפלט עצמה, או בwwwroot/lib, מתעלמים ממנו.

אם בעבר העברת List<string> של נתיבי רישיון לבונה Viewer — אחד לכל יכולת — שמור קבצים נלווים אלה ליד Doconut.Viewer.lic ותן לגילוי האוטומטי לאסוף אותם. אין אפשרות רשימת‑נתיבים בDoconutOptions.

העתק את הרישיון לתיקיית הפלט שלך

כאשר התהליך אינו רץ מתיקיית הפרויקט — אפליקציה שפורסמה, IIS, מכולה, מריץ מבחנים — הסקר הראשון נכשל, והשני, {AppContext.BaseDirectory}/wwwroot, צריך למצוא את הקובץ. יעד MSBuild זה מעתיק את הרישיונות לשם בכל בנייה:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- מחק קודם, כך ששינוי שם או הסרת .lic ב‑wwwroot גם יוציא אותו מהפלט. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

היעד חייב להיות $(OutDir)wwwroot: .lic שהועתק לשורש הפלט לעולם לא נמצא על ידי חיפוש אוטומטי. הדוגמאות של LicensePath בדף זה מצביעות על אותו המקום.

שמור קבצי .lic מחוץ לבקרת גרסאות — פרוס אותם לצד האפליקציה, או הזרק את הרישיון דרך LicenseContent או LicenseStream מהמאגר הסודי שלך.

מה קורה ללא רישיון

רישיון חסר אינו גורם לשגיאה. AddDoconut() מצליח, האפליקציה מתחילה, והצופה פועל — אך כל דף נושא סימן מים של הערכה ואין אפשרות תכונה אופציונלית שניתנת.

קובץ רישיון שנמצא אך נדחה הוא שונה. חתימה לא תקפה, שינוי, רשימת שחורות, או בנייה מחוץ לחלון הגרסה של הרישיון גורמים לOpenDocumentAsync לזרוק LicenseException עם License.RejectionMessage. רישיון זמני שפג תוקפו ממשיך במצב עם סימן מים. רישיון בתשלום שהמועד של המנוי שלו עבר ממשיך לעבוד, נקי ועם היכולות שלו, בכל בנייה שהופקה לפני תאריך זה.

תוספים דורשים יכולות

רישום תוסף ללא זכאות תואמת הוא שונה: עבור רישיון חסר, קובץ TRIAL מיושן, או רישיון בתשלום ללא היכולת הזו, AddDoconut() זורק InvalidOperationException, ולכן האפליקציה לא מתחילה. לדוגמה, רישום תוסף Converter ללא רישיון שמעניק 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.

ההודעה מודיעה לך על הפתרון ישירות: או להסיר את הקריאה לoptions.AddPlugin<...>() עבור תוסף זה, או להתקין רישיון בתשלום או רישיון זמני/דמו (NFR) פעיל שמעניק את היכולת. רישומים זמניים מורשים לשרוד את תאריך הפקתם כך שאפליקציה שכבר הוגדרה יכולה להתדרדר בזמן ריצה במקום לקרוס בזמן אתחול; לאחר שפג תוקף, היכולות שלהם עדיין מבוטלות.

אמת את הרישיון הטעון

השתמש בIDoconutLicenseService, אותו מקור אמת שבו משתמש ה‑SDK, כדי לחשוף נקודת קצה אבחונית מאומתת או להניע דגלי תכונות. אל תחזיר את תוכן הרישיון או מפתחות.

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

הרישיון נקרא במהלך רישום AddDoconut(). ResetLicense הוא כיום נכס תאימות ללא נתיב טעינה פעיל, ולכן החלפת קובץ רישיון דורשת אתחול של היישום.

מטריצת פתרון בעיות

תסמיןסיבה סבירהבדיקה
הצופה עובד אך כל דף מסומן במיםלא נטען רישיון, או שהרישיון הזמני פג תוקףפתר את IDoconutLicenseService; אמת את תיקיית הפלט ואת תיקיית העבודה של התהליך
AddDoconut() זורק עבור תוסףהרישיון אינו מעניק את היכולת לתוסף זהבדוק את IsCapabilityGranted(...) והסר רישומים שלא רכשת
נתיב יחסי מוגדר עובד מקומית אך לא ב‑IIS/מכולהתיקיית העבודה של התהליך השתנתההשתמש בAppContext.BaseDirectory או בנתיב מוחלט
קובץ .lic שהוחלף אינו משפיעשירות הרישיון הסינגלטון כבר נוצראתחל את היישום
OpenDocumentAsync זורק LicenseExceptionחתימה, תחום, חלון גרסה, רשימת שחורות, או שער זמן ריצה של תוסף דחו את הרישיוןקרא את הודעת השגיאה/הדחייה מבלי לחשוף אותה ללקוחות לא מהימנים
רישיון לפי יכולת עבד בעבר אך לא כעתהקוד הישן העביר נתיבי רישיון מפורשים לבנאי Viewerהעבר את קבצי .lic המלווה ליד Doconut.Viewer.lic ותן לגילוי האוטומטי לטעון אותם

הצעדים הבאים

  • רישוי — יכולות, רמות רישיון, ואימות מה נטען בזמן ריצה.
  • פתרון בעיות — סימני מים, רישיונות נדחים, ושגיאות יכולת.

האם דף זה היה מועיל?