התקנה

הוסף את Doconut לפרויקט .NET 8 שלך

הצופה הבסיס של Doconut עבור .NET 8 מגיע כחבילה יחידה של NuGet שמתחברת לכל יישום ASP.NET Core. תוספים אופציונליים משתמשים בחבילות נפרדות. דף זה מתקין את חבילת הבסיס ורושם את ה‑middleware — המינימום הדרוש לפני הרינדור הראשון שלך.

דרישות

החבילה פועלת על הפלטפורמות הבאות:

פלטפורמהנתמך
Windows x64 / x86כן
Linux x64, glibc-based (Debian, Ubuntu, התמונה הרשמית של mcr.microsoft.com/dotnet/aspnet:8.0)כן
Alpine and other musl-based distributionsלא
macOSלא

ב‑Linux, התקן את ספריית תצורת הגופנים לפני שהמסמך הראשון נפתח:

bash
apt-get update && apt-get install -y libfontconfig1

ב‑RHEL, Fedora והפצות דומות החבילה היא fontconfig (dnf install -y fontconfig). זו החבילה המערכתית היחידה ש‑Doconut צריך: הספריות הטבעיות שהיא משתמשת בהן נשלחות בתוך חבילת ה‑NuGet, ו‑libgdiplus אינה נדרשת. הדפים מצוירים עם הגופנים המותקנים על השרת, ולכן ראו את פתרון בעיות עבור גופנים והודעות השגיאה של Linux.

התקנת החבילה

bash
dotnet add package Doconut.NET8

הפקודה ללא גרסה מתקינה את הגרסה היציבה האחרונה. כדי לקבע את הגרסה שהדוקומנטציה מתארת, העבר את הגרסה כאופציה נפרדת:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 הוא מזהה החבילה. הסיומת של הגרסה שייכת לקובץ Doconut.NET8.<version>.nupkg שהורד ואינה חלק מהמזהה.

רישום Doconut

AddDoconut() הוא נקודת הכניסה היחידה לרישום — יש עומס יתר יחיד, והוא מחבר את שירות Viewer, שירות הרישיון, ותשתית הרינדור למיכל ה‑DI.

שתיים קריאות middleware משלים את ההגדרה, והסדר שלהן חשוב: UseDoconutResources() חייב לרוץ לפני UseDoconut(). UseDoconut() הוא middleware סופי, ולכן קריאה אליו ראשון משמעותה שכל בקשה לנכס /doconut-res אף פעם לא מגיעה למטפל המשאבים ומחזירה 404. UseDoconut() משיב לכל בקשה שמגיעה אליו, ולכן יש למקם אותו בסניף משלו עם app.Map. חיבור הסשן נדרש גם הוא — האבטחה הדפוסית של Doconut מאמתת כל בקשת עמוד מול מצב הסשן של ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // מצב ה‑session צריך מטמון (MVC/Razor Pages כבר מוסיפים אחד)
builder.Services.AddSession(); // אבטחת המסמכים של Doconut מתבססת על מצב ה‑session של ASP.NET

app.UseSession();          // קרא UseSession() לפני UseDoconut()
app.UseDoconutResources(); // חייב להיות רשום לפני UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

כל האפשרויות

DoconutOptions מקבל את המאפיינים הניתנים להגדרה הבאים. כל אחד מהם אופציונלי — ברירות המחדל שלהלן חלות כאשר מאפיין נשאר ללא ערך.

מאפייןברירת מחדלתיאור
ShowDoconutInfofalseכאשר true, בקשה ללא token מחזירה באנר גרסה במקום 404. שימושי כבדיקת עישון; יש להשבית בייצור.
UnsafeModefalseכאשר true, מדלג על בדיקת האבטחה של ASP.NET‑session בבקשות דף. יש להשבית בייצור.
MiddlewarePath"/doconut"ערך תיאום עבור נקודת הקצה page-image. הוא מאומת, אך אינו יוצר סניף בעצמו; שמור אותו תואם למיפוי UseDoconut() האמיתי ולBasePath של הלקוח.
ResourcesPath"/doconut-res"מאיפה משמשים המשאבים המוטמעים של JS/CSS/תמונה.
LicensePath"" (empty string)נתיב לקובץ הרישיון. ריק משמעותו לעבור למקור הבא, ואז חיפוש אוטומטי.
LicenseContent"" (empty string)תוכן רישיון גולמי — ממשתנה סביבתי, מנהל סודות, או מסד נתונים.
LicenseStreamnullרישיון כזרם, נקרא פעם אחת בעת האתחול.
ResetLicensefalseדגל תאימות שמור. שירותי .NET 8 הנוכחיים קוראים את הרישיון במהלך AddDoconut(); יש לאתחל את האפליקציה לאחר החלפת רישיון.
MaxConcurrentEditorSessions200מספר מרבי של סשני עריכה חיים (מסמכים שנפתחים עם DocOptions.EditMode). מעל ערך זה, סשן העריכה הלא פעיל שהשתמש בפחות זמן נסגר. סשני צופה רגילים אינם נספרים. 0 או ערך שלילי משמעותו שאין מגבלה.
EditorSnapshotEveryOps50כאשר שמירת עריכה מופעלת (AddDoconutEditorPersistence), מצלמים את המסמך החי כל N שינויים רשומים. 0 או ערך שלילי אף פעם לא מצלמים באמצע סשן. אין השפעה כאשר שמירה מושבתת.

קדימות רישיון כאשר מוגדר יותר ממקור אחד: LicenseStream גובר על LicenseContent, גובר על LicensePath, גובר על חיפוש אוטומטי — ראו את הגדרת רישיון.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // תאם עם מיפוי האפליקציה ו‑BasePath של הלקוח
    options.ResourcesPath   = "/doconut-res"; // מאיפה שמשרתים את קבצי ה‑JS/CSS/images של ה‑viewer
    options.UnsafeMode      = false;          // שמור על אבטחת ה‑session
    options.ShowDoconutInfo = false;
});

הצעדים הבאים

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