Configurazione della licenza

Where Doconut looks for your license file under IIS

Senza una licenza, Doconut continua a renderizzare i documenti — ogni pagina mostra semplicemente una filigrana di valutazione. Questa pagina descrive i quattro modi per fornire una licenza in Global.asax, dove Doconut cerca quando non ne fornisci alcuna, e cosa succede quando manca la licenza di un plugin.

Quattro modi per fornire una licenza

Ci sono tre fonti esplicite su DoconutOptions — un percorso file, uno stream o contenuto grezzo — più la scoperta automatica quando nessuna di esse è impostata. Tutte vengono lette una sola volta, in DoconutHost.Initialize. Quando ne è impostata più di una, la precedenza è esatta:

LicenseStream supera LicenseContent supera LicensePath supera la scoperta automatica.

Per percorso

Fornisci a LicensePath un percorso completo. Un percorso relativo viene risolto rispetto alla directory corrente del processo, e sotto IIS questa è la cartella del processo worker, non del tuo sito. HostingEnvironment.MapPath converte un percorso relativo al sito in uno completo:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

Se il file non esiste, Doconut non genera eccezioni e non ricade sulla scoperta automatica: non carica alcuna licenza e il visualizzatore aggiunge filigrane. I file di licenza per plugin nella stessa cartella (Doconut.Viewer.<Capability>.lic) vengono letti insieme, quindi LicensePath e AddPlugin<...>() funzionano insieme quando le licenze dei plugin si trovano accanto alla licenza principale.

Per stream

LicenseStream viene letto una sola volta, all'avvio — utile quando la licenza proviene da una risorsa incorporata o da un archivio segreto anziché da un file su disco.

csharp
// Priorità: LicenseStream > LicenseContent > LicensePath > auto-search.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Per contenuto

LicenseContent prende il testo della licenza stesso — da una variabile d'ambiente, un database o un archivio segreto — così non è necessario distribuire un file di licenza con il sito.

csharp
// License XML da un database, una variabile d'ambiente o un archivio segreto -
// nessun file su disco. Superato solo da LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Scoperta automatica

Non impostare nessuna delle tre, e Doconut cerca la licenza da solo:

csharp
// Non configurare nulla, e Doconut cerca la licenza da solo, in quest'ordine:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (sotto IIS: la cartella radice del sito)
// Cerca prima Doconut.lic; se manca, Doconut.Viewer.lic più qualsiasi
// file Doconut.Viewer.<Capability>.lic per plugin.
Doconut.DoconutHost.Initialize();

Le due cartelle, in ordine, e i file cercati:

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-plugin licenses, read only when Doconut.Viewer.lic was found

Su IIS e IIS Express, AppContext.BaseDirectory è la cartella radice del sito — quella che contiene Web.config — non la sua cartella bin. Quindi la licenza deve trovarsi in wwwroot nella radice del sito:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

Nel progetto, mantieni wwwroot\*.lic accanto a Web.config e distribuisci la cartella con il sito. Nessuna fase di build deve copiarla da nessuna parte. Un .lic altrove — in bin\, accanto a Web.config, o in una sottocartella di wwwroot — non viene mai letto.

Mantieni i file .lic fuori dal controllo di versione. Distribuiscili accanto al sito, o fornisci la licenza tramite LicenseContent o LicenseStream dal tuo archivio segreto.

Cosa succede senza licenza

Una licenza mancante non genera eccezione. DoconutHost.Initialize ha successo, il sito si avvia e il visualizzatore funziona, ma ogni pagina porta una filigrana di valutazione e nessuna capacità opzionale è concessa.

Un file di licenza che viene trovato ma rifiutato è diverso. Una firma non valida, manomissione o una build al di fuori della finestra di versione della licenza fa sì che OpenDocumentAsync lanci LicenseException con il motivo. Una licenza Temporanea scaduta continua in modalità con filigrana. Una licenza a pagamento la cui data di sottoscrizione è passata continua a funzionare, pulita e con le sue capacità, su ogni build rilasciata prima di quella data.

I plugin richiedono la loro licenza all'avvio

Registrare un plugin la cui capacità non è concessa da alcuna licenza interrompe l'applicazione all'avvio. DoconutHost.Initialize genera un'eccezione in Application_Start:

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.

Con System.Web, non vedi quel messaggio nel browser. Ogni richiesta al sito risponde con un 500 vuoto — nessuna pagina di errore, nessuna traccia dello stack, nulla nel log di IIS. L'eccezione viene registrata solo nel log eventi di Windows (log Applicazione, origine ASP.NET). Se l'intero sito smette di rispondere subito dopo aver aggiunto una riga AddPlugin, controlla i file di licenza in wwwroot prima del codice: il Doconut.Viewer.<Capability>.lic del plugin deve trovarsi accanto a Doconut.Viewer.lic, e senza la licenza di base i file del plugin non vengono letti affatto.

Verifica la licenza caricata

IDoconutLicenseService è la stessa fonte di verità usata dall'SDK. Risolvila da DoconutHost.Services per esporre un endpoint diagnostico autenticato o gestire i flag delle funzionalità — non restituire mai il contenuto della licenza:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

La licenza viene letta una sola volta, in DoconutHost.Initialize. Dopo aver sostituito un file di licenza, ricicla il pool di applicazioni (o tocca Web.config) così Application_Start viene eseguito nuovamente.

Risoluzione dei problemi

SintomoProbabile causaVerifica
Il visualizzatore funziona ma ogni pagina è contrassegnata da filigranaNon è stata trovata alcuna licenzaIl .lic è in <site root>\wwwroot? Chiama l'endpoint di stato sopra
Ogni richiesta risponde con un 500 vuoto subito dopo aver aggiunto un pluginUn plugin registrato non ha una licenza che lo concedaLog eventi di Windows, origine ASP.NET; il .lic del plugin accanto a Doconut.Viewer.lic
LicensePath funziona sulla tua macchina ma non sul serverUn percorso relativo risolto rispetto alla cartella del processo workerCompilalo con HostingEnvironment.MapPath("~/wwwroot/...")
Un file .lic sostituito non ha effettoLa licenza è stata letta all'avvio dell'applicazioneRicicla il pool di applicazioni
OpenDocumentAsync genera LicenseExceptionLa licenza è stata trovata ma rifiutataLeggi il messaggio dell'eccezione; non mostrarlo a client non fidati

Prossimi passi

Questa pagina è stata utile?