راه‌اندازی مجوز

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

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

مجوز یک‌بار، در طول AddDoconut() بارگذاری می‌شود. این تغییر نسبت به کتابخانه ‎.NET Standard قبلی است، جایی که مجوز به یک نمونه Viewer داده می‌شد یا از طریق فراخوانی‌های ثابت Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) تنظیم می‌شد. این روش‌ها در این نسخه مکانیزم راه‌اندازی نیستند — برای جزئیات به راهنمای مهاجرت مراجعه کنید.

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

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

LicenseStream beats LicenseContent beats LicensePath beats 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-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 منتقل کنید و بگذارید کشف خودکار آنها را بارگذاری کند

گام‌های بعدی

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

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