پیکربندی مجوز

محل جستجوی Doconut برای فایل مجوز شما

بدون مجوز، Doconut همچنان اسناد را رندر می‌کند — هر صفحه فقط یک واترمارک ارزیابی دارد. این صفحه چهار روش برای ارائه یک مجوز را پوشش می‌دهد و ترتیب دقیق اولویت‌ها را وقتی بیش از یک منبع تنظیم شده باشد، توضیح می‌دهد.

چهار روش برای ارائه یک مجوز

چهار روش وجود دارد: سه منبع صریح بر روی DoconutOptions — یک جریان، محتوا به‌صورت خام، یا مسیر فایل — به‌علاوه کشف خودکار وقتی هیچ‌یک از آن‌ها تنظیم نشده باشد. وقتی بیش از یک منبع تنظیم شود، ترتیب اولویت دقیق است:

LicenseStream برتری دارد بر LicenseContent برتری دارد بر LicensePath برتری دارد بر auto-search.

بر اساس مسیر

LicensePath دقیقاً همان‌طور که داده شده به File.Exists پاس داده می‌شود. یک مسیر نسبی نسبت به دایرکتوری کاری فعلی فرآیند حل می‌شود — نه پوشه پروژه شما، و نه پوشه‌ای که Program.cs در آن قرار دارد. اگر مسیر حل نشود، Doconut خطایی نمی‌اندازد و نمی به جستجوی خودکار باز نمی‌گردد — به‌سادگی هیچ مجوزی بارگذاری نمی‌کند و نمایشگر واترمارک می‌گذارد. جستجوی خودکار فقط زمانی اجرا می‌شود که هیچ‌یک از 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-plugin licenses, read only when Doconut.Viewer.lic was found

هیچ‌چیزی خارج از یک پوشه wwwroot خوانده نمی‌شود: یک .lic در خود پوشه خروجی، یا در wwwroot/lib، نادیده گرفته می‌شود.

کپی مجوز به پوشه خروجی شما

وقتی فرآیند از پوشه پروژه اجرا نمی‌شود — یک برنامه منتشر شده، 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() موفق می‌شود، برنامه شروع می‌شود و viewer اجرا می‌شود — اما هر صفحه دارای واترمارک ارزیابی است و هیچ قابلیت اختیاری اعطا نمی‌شود.

فایل مجوزی که پیدا می‌شود اما رد می‌شود متفاوت است. امضای نامعتبر، دستکاری، فهرست سیاه، یا ساختی خارج از بازه نسخه مجوز باعث می‌شود 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 در حال حاضر یک ویژگی سازگاری است که مسیر بارگذاری فعال ندارد، بنابراین جایگزینی فایل مجوز نیاز به راه‌اندازی مجدد برنامه دارد.

ماتریس عیب‌یابی

علامتدلیل محتملبررسی
Viewer کار می‌کند اما هر صفحه واترمارک داردهیچ مجوزی بارگذاری نشده است، یا مجوز موقت منقضی شده استبرطرف کنید IDoconutLicenseService؛ دایرکتوری خروجی و دایرکتوری کاری فرآیند را تأیید کنید
AddDoconut() برای یک افزونه خطا می‌دهدمجوز آن قابلیت افزونه را اعطا نمی‌کندIsCapabilityGranted(...) را بررسی کنید و ثبت‌نام‌هایی که خریداری نکرده‌اید حذف کنید
مسیر نسبی پیکربندی‌شده به‌صورت محلی کار می‌کند اما در IIS/کانتینر کار نمی‌کنددایرکتوری کاری فرآیند تغییر کرده استاز AppContext.BaseDirectory یا مسیر مطلق استفاده کنید
فایل جایگزین شدهٔ .lic اثر نداردسرویس تک‌نمونهٔ مجوز قبلاً ایجاد شده بودبرنامه را مجدداً راه‌اندازی کنید
OpenDocumentAsync خطای LicenseException را پرتاب می‌کندامضا، دامنه، بازه نسخه، فهرست سیاه، یا دروازهٔ زمان اجرا افزونه مجوز را رد کرده‌اندپیام استثنا/رد را بخوانید بدون اینکه به مشتریان غیرقابل اعتماد نشان داده شود

گام‌های بعدی

  • مجوزدهی — قابلیت‌ها، سطوح مجوز، و تأیید آنچه در زمان اجرا بارگذاری شده است.
  • عیب‌یابی — واترمارک‌ها، مجوزهای رد شده، و خطاهای قابلیت.

آیا این صفحه مفید بود؟