Installation

Ajoutez Doconut à votre projet .NET 8

Le visualiseur de base Doconut pour .NET 8 est fourni sous forme d'un seul package NuGet qui s'intègre à toute application ASP.NET Core. Les plugins optionnels utilisent des packages séparés. Cette page installe le package de base et enregistre le middleware — le minimum nécessaire avant votre premier rendu.

Prérequis

Le package fonctionne sur ces plateformes :

PlateformePris en charge
Windows x64 / x86Oui
Linux x64, glibc‑based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Oui
Alpine et autres distributions basées sur muslNon
macOSNon

Sur Linux, installez la bibliothèque de configuration des polices avant l'ouverture du premier document :

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

Sur RHEL, Fedora et les distributions similaires, le package est fontconfig (dnf install -y fontconfig). C’est le seul package système dont Doconut a besoin : les bibliothèques natives qu’il utilise sont incluses dans le package NuGet, et libgdiplus n’est pas requis. Les pages sont rendues avec les polices installées sur le serveur, consultez donc Dépannage pour les polices et les messages d’erreur Linux.

Installer le package

bash
dotnet add package Doconut.NET8

La commande sans version installe la dernière version stable. Pour figer la version décrite dans cette documentation, passez la version comme option séparée :

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 est l'ID du package. Le suffixe de version appartient au nom de fichier Doconut.NET8.<version>.nupkg téléchargé et ne fait pas partie de l'ID.

Enregistrer Doconut

AddDoconut() est le seul point d’entrée d’enregistrement — il n’y a qu’une surcharge unique, et il connecte le service Viewer, le service de licence et l’infrastructure de rendu dans le conteneur DI.

Deux appels middleware complètent la configuration, et leur ordre est important : UseDoconutResources() doit s’exécuter avant UseDoconut(). UseDoconut() est un middleware terminal, donc le placer en premier signifie que chaque requête vers une ressource /doconut-res n’atteint jamais le gestionnaire de ressources et renvoie 404. UseDoconut() répond à chaque requête qui l’atteint, donc montez‑le sur sa propre branche avec app.Map. Le câblage de session est également requis — la sécurité de document par défaut de Doconut valide chaque requête de page contre l’état de session ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // l'état de session nécessite un cache (MVC/Razor Pages en ajoute déjà un)
builder.Services.AddSession(); // La sécurité des documents Doconut repose sur l'état de session ASP.NET

app.UseSession();          // appelez UseSession() avant UseDoconut()
app.UseDoconutResources(); // doit être enregistré avant UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Toutes les options

DoconutOptions accepte les propriétés réglables suivantes. Chacune est optionnelle — les valeurs par défaut ci‑dessous s’appliquent lorsqu’une propriété n’est pas définie.

PropriétéValeur par défautDescription
ShowDoconutInfofalseLorsque true, une requête sans token renvoie une bannière de version au lieu d’un 404. Utile comme vérification rapide ; désactiver en production.
UnsafeModefalseLorsque true, ignore la vérification de sécurité de session ASP.NET sur les requêtes de page. Désactiver en production.
MiddlewarePath"/doconut"Valeur de coordination pour le point de terminaison page-image. Elle est validée, mais ne monte pas de branche par elle‑même ; maintenez‑la alignée avec le mappage réel UseDoconut() et le client BasePath.
ResourcesPath"/doconut-res"Emplacement d’où proviennent les ressources JS/CSS/image intégrées.
LicensePath"" (empty string)Chemin vers le fichier de licence. Vide signifie passer à la source suivante, puis recherche automatique.
LicenseContent"" (empty string)Contenu brut de la licence — provenant d’une variable d’environnement, d’un gestionnaire de secrets ou d’une base de données.
LicenseStreamnullLicence sous forme de flux, lue une fois au démarrage.
ResetLicensefalseDrapeau de compatibilité réservé. Les services .NET 8 actuels lisent la licence pendant AddDoconut() ; redémarrez l’application après avoir remplacé une licence.
MaxConcurrentEditorSessions200Nombre maximal de sessions d’éditeur en direct (documents ouverts avec DocOptions.EditMode). Au‑dessus, la session d’éditeur inactif la moins récemment utilisée est fermée. Les sessions de visualisation normales ne sont jamais comptées. 0 ou une valeur négative signifie aucune limite.
EditorSnapshotEveryOps50Avec la persistance de l’éditeur activée (AddDoconutEditorPersistence), créez un instantané du document en direct toutes les N modifications enregistrées. 0 ou une valeur négative ne crée jamais d’instantané en cours de session. Aucun effet lorsque la persistance est désactivée.

Priorité des licences lorsqu’il y a plusieurs sources définies : LicenseStream l’emporte sur LicenseContent, qui l’emporte sur LicensePath, qui l’emporte sur la recherche automatique — voir Configuration de la licence.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordonnez-vous avec le mappage de l'application et le BasePath du client
    options.ResourcesPath   = "/doconut-res"; // d'où les JS/CSS/images du visualiseur sont servis
    options.UnsafeMode      = false;          // maintenez la sécurité de session activée
    options.ShowDoconutInfo = false;
});

Étapes suivantes

Cette page était-elle utile ?