Installation

Lägg till Doconut i din .NET Framework 4.7.2 webbapplikation

Doconut.NETFramework hostar Doconut‑visaren i en klassisk ASP.NET‑applikation på .NET Framework 4.7.2 — IIS eller IIS Express, MVC 5 eller Web Forms. Installationen har tre delar: NuGet‑paketet, två registreringar i Web.config och ett anrop i Global.asax. Den här sidan täcker alla tre; Snabbstart placerar sedan ett dokument på en sida.

Krav

  • Webbprojektet riktar sig mot .NET Framework 4.7.2 eller senare. Ett 4.7‑projekt kan inte konsumera detta paket; rikta om det först.
  • Webbplatsen körs i den integrerade pipelinen (standard för IIS‑ och IIS‑Express‑applikationspooler).
  • Servern kör Windows. Paketet är endast för Windows.

Den här sidan täcker Doconut.NETFramework 26.9.0 och senare. Versionerna 26.8.0 och tidigare riktade sig mot .NET Framework 4.7 med ett annat API; den raden har avvecklats. Uppdatering av en befintlig applikation över den gränsen behandlas i Migration.

Installera paketet

Från Package Manager Console:

powershell
Install-Package Doconut.NETFramework

Eller, i ett SDK‑stilprojekt:

bash
dotnet add package Doconut.NETFramework

De oversionsspecifika kommandona installerar den senaste stabila versionen. För att låsa den version som denna dokumentation beskriver, ange versionen:

powershell
Install-Package Doconut.NETFramework -Version 26.10.0
bash
dotnet add package Doconut.NETFramework --version 26.10.0

Renderingsmotorn är inbäddad i paketet: det finns ingen separat motor‑assembly att referera till, kopiera eller distribuera. Valfria funktioner levereras som egna paket — till exempel Doconut.NETFramework.Converter och Doconut.NETFramework.Dicom — och varje paket kräver en licens som beviljar det (se Plugin‑system).

Konfigurera Web.config

Doconut hanterar två typer av förfrågningar, och IIS dirigerar båda genom Web.config:

  • DocImage.axd — visarens sida, miniatyr, sök‑ och annoterings‑endpoint, som levereras av Doconut.DocImageHandler.
  • /doconut-res/* — visarens egna skript, stilmallar och ikoner, inbäddade i assemblyn och levererade av Doconut.DoconutResourceModule.

Lägg till båda, samt de inställningar de beror på:

xml
<configuration>
  <system.web>
    <!-- Endast MVC 5: Razor kompilerar vyer vid körning och behöver netstandard-fasad. -->
    <compilation targetFramework="4.7.2">
      <assemblies>
        <add assembly="netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51" />
      </assemblies>
    </compilation>
    <!-- maxRequestLength är i KILOBYTES: 200 MB. -->
    <httpRuntime targetFramework="4.7.2" maxRequestLength="204800" />
    <!-- Läs .cshtml- och .aspx-filer som UTF-8, inte som serverns ANSI-kodpage. -->
    <globalization fileEncoding="utf-8" requestEncoding="utf-8" responseEncoding="utf-8" />
  </system.web>
  <system.webServer>
    <security>
      <requestFiltering>
        <!-- maxAllowedContentLength är i BYTES: samma 200 MB. -->
        <requestLimits maxAllowedContentLength="209715200" />
      </requestFiltering>
    </security>
    <modules runAllManagedModulesForAllRequests="true">
      <add name="DoconutResourceModule" type="Doconut.DoconutResourceModule, Doconut" />
    </modules>
    <handlers>
      <add name="DocImage" verb="GET,HEAD,POST" path="DocImage.axd"
           type="Doconut.DocImageHandler, Doconut" />
    </handlers>
  </system.webServer>
</configuration>

Varje rad förhindrar ett fel som inte ger något undantag:

  • verb="GET,HEAD,POST" — behåll HEAD. Visaren skickar en HEAD‑förfrågan för sida 1 för att upptäcka animerade bilder. Utan verbet svarar IIS med 404 innan hanteraren körs: dokument visas fortfarande, men animationsdetektering fungerar aldrig och webbläsarkonsolen fylls med 404‑fel.
  • runAllManagedModulesForAllRequests="true" — /doconut-res/*.js, .css och .png ser ut som statiska filer, och IIS skulle skicka dem till sin statiska fil‑handler innan resurs‑modulen ser dem. Resultatet blir en visare utan skript eller ikoner.
  • <globalization fileEncoding="utf-8"> — sidfiler sparade som UTF‑8 utan byte‑order‑markering läses annars med serverns ANSI‑teckenkodning, så varje icke‑ASCII‑tecken når webbläsaren dubbelt kodad (ett em‑dash visas som —). Filen är korrekt på disken, och sidan deklarerar fortfarande <meta charset="utf-8">.
  • Den netstandard‑assembly (MVC 5) — Razor kompilerar vyer när de först begärs, med sin egen referenslista som inte inkluderar detta gränssnitt. En vy som gör något dynamiskt utöver en enkel medlemsåtkomst misslyckas då med CS0012 och svarar med en tom 500, och endast de sidor som triggar det misslyckas. Kompilatorfelet visas bara i Windows‑händelseloggen (källa ASP.NET). Web Forms‑applikationer behöver inte denna rad.
  • Uppladdningsgränser — ASP.NET läser hela förfrågningskroppen innan någon handler körs, så en uppladdning över dessa gränser avvisas av IIS med sin egen felsida. Behåll maxRequestLength (kilobyte) och maxAllowedContentLength (byte) i takt, och över den största fil som dina användare öppnar eller laddar upp.

Två ytterligare inställningar är viktiga, och båda är vanligtvis redan korrekta:

  • Sessionstillstånd förblir på. Som standard levereras en sida endast till den ASP.NET‑session som öppnade dokumentet, så webbplatsen får inte sätta <sessionState mode="Off" />. Se Sessioner & Säkerhet.
  • Binding‑omdirigeringar. Behåll <runtime>‑binding‑omdirigeringarna som NuGet skriver in i Web.config. I ett SDK‑stilprojekt, kopiera dem från den genererade bin\<YourApp>.dll.config, eftersom klassisk ASP.NET bara läser omdirigeringar från Web.config. En omdirigering som refererar till en version som saknas i bin\ stoppar hela applikationen med en tom 500 vid start.

Registrera Doconut i Global.asax

Det finns ingen builder och ingen middleware‑pipeline i System.Web. Doconut komponeras en gång per arbetsprocess av DoconutHost.Initialize i Application_Start, och släpps av DoconutHost.Shutdown i Application_End:

csharp
// Global.asax.cs
protected void Application_Start()
{
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    });
}

protected void Application_End()
{
    Doconut.DoconutHost.Shutdown();
}

DoconutHost.Initialize bygger tjänsterna, hanteraren, resursmodulen och din egen kodanvändning. Din kod når dem via DoconutHost.Services (se DoconutHost). Endast det första anropet konfigurerar något; ett andra anrop ignoreras. I en MVC‑applikation, håll även de två Doconut‑vägarna utanför routingen — Snabbstart visar den kompletta Application_Start.

Alla alternativ

DoconutOptions accepterar följande konfigurerbara egenskaper. Alla är valfria.

EgenskapStandardBeskrivning
UnsafeModefalseNär false, DocImage.axd serverar en sida endast till den ASP.NET‑session som öppnade dokumentet. När true, serveras varje begäran som bär token. Lämna den false.
ShowDoconutInfofalseNär true, svarar en DocImage.axd‑begäran utan token med en versionsbanner istället för 404. Användbart som en snabbkontroll; lämna av i produktion.
ResourcesPath"/doconut-res"Var resursmodulen levererar de inbäddade skripten, stilarna och ikonerna. Ändra den endast tillsammans med visningsprogrammets ResPath och eventuella MVC IgnoreRoute.
LicensePath""Fullständig sökväg till licensfilen. Tomt betyder att man faller igenom till nästa källa, sedan till automatisk upptäckt.
LicenseContent""Rå licensinnehåll — från en miljövariabel, en hemlig lagring eller en databas.
LicenseStreamnullLicens som en ström, läses en gång vid uppstart.
MiddlewarePath"/doconut"Används inte i detta paket. Sidans slutpunkt är DocImage.axd‑hanteraren deklarerad i Web.config, oavsett vad detta är satt till. Den valideras fortfarande: den måste börja med / och skilja sig från ResourcesPath.
ResetLicensefalseAnvänds inte i detta paket. Licensen läses en gång, i DoconutHost.Initialize; återanvänd applikationspoolen efter att ha ersatt en licensfil.
MaxConcurrentEditorSessions200Maximalt antal aktiva redigeringssessioner (dokument öppnade med DocOptions.EditMode). Överst stängs den minst nyligen använda inaktiva redigeringssessionen. Normala visningssessioner räknas aldrig. 0 eller ett negativt värde betyder ingen gräns.
EditorSnapshotEveryOps50Med redigerarpersistens aktiverad (AddDoconutEditorPersistence), tas en ögonblicksbild av det levande dokumentet var N:te registrerade förändring. 0 eller ett negativt värde tar aldrig ögonblicksbilder mitt i en session. Ingen effekt när persistens är inaktiverad.

När mer än en licenskälla är angiven, slår LicenseStream LicenseContent, som slår LicensePath, som slår automatisk upptäckt — se Licensinställning.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.ResourcesPath   = "/doconut-res"; // varifrån viewer's JS/CSS/images levereras
    options.UnsafeMode      = false;          // behåll sessionssäkerhet på
    options.ShowDoconutInfo = false;
});
// Sidans slutpunkt är inte ett alternativ här: det är DocImage.axd‑hanteraren som deklarerats i Web.config.

Nästa steg

  • Snabbstart — öppna ett dokument och rendera det i webbläsaren, i MVC 5 eller Web Forms.
  • Licensinställning — där Doconut letar efter din licensfil.

Var den här sidan hjälpsam?