התקנה

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

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

דרישות

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

פלטפורמהנתמך
Windows x64 / x86כן
Linux x64, מבוסס glibc (Debian, Ubuntu, התמונה הרשמית mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim)כן
Alpine והפצות אחרות מבוססות muslלא
macOSלא

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

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

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

התקנת החבילה

bash
dotnet add package Doconut.NET6

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

bash
dotnet add package Doconut.NET6 --version 26.10.0

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

זיהוי האינטגרציה לפני עדכון

מזהה החבילה Doconut.NET6 שומש הן באינטגרציה הקלאסית והן באינטגרציה הנוכחית של .NET 6. אל תבחר תיעוד רק משם החבילה:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), סינכרוני
    OpenDocument(...), וסקריפטים של הצופה שהועתקו ידנית מזהים את
    אינטגרציה קלאסית;
  • AddDoconut(), UseDoconutResources(), Viewer מוזרק, ו-
    OpenDocumentAsync(...) מזהים את האינטגרציה הנוכחית המתועדת כאן.

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

רישום 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(); // מצב הסשן צריך מטמון (MVC/Razor Pages כבר מוסיפים אחד)
builder.Services.AddSession(); // אבטחת המסמכים של Doconut מתבססת על מצב הסשן של 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 6 הנוכחיים קוראים את הרישיון במהלך 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/תמונות של הצופה מוגשים
    options.UnsafeMode      = false;          // שמור על אבטחת הסשן
    options.ShowDoconutInfo = false;
});

הצעדים הבאים

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