Configuração de Licença

Onde o Doconut procura seu arquivo de licença no IIS

Sem uma licença, o Doconut ainda renderiza documentos — cada página apenas exibe uma marca d'água de avaliação. Esta página cobre as quatro maneiras de fornecer uma licença em Global.asax, onde o Doconut procura quando você não fornece nenhuma, e o que acontece quando a licença de um plugin está ausente.

Quatro maneiras de fornecer uma licença

Existem três fontes explícitas em DoconutOptions — um caminho de arquivo, um fluxo ou conteúdo bruto — além da descoberta automática quando nenhuma delas está definida. Todas são lidas uma única vez, em DoconutHost.Initialize. Quando mais de uma está definida, a precedência é exata:

LicenseStream tem precedência sobre LicenseContent, que tem precedência sobre LicensePath, que tem precedência sobre a descoberta automática.

Por caminho

Forneça a LicensePath um caminho completo. Um caminho relativo é resolvido em relação ao diretório atual do processo, e sob o IIS isso é a própria pasta do processo de trabalho, não o seu site. HostingEnvironment.MapPath converte um caminho relativo ao site em um caminho completo:

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

Se o arquivo não existir, o Doconut não lança exceção e não recorre à descoberta automática: ele não carrega nenhuma licença, e o visualizador exibe marcas d'água. Os arquivos de licença por plugin na mesma pasta (Doconut.Viewer.<Capability>.lic) são lidos junto com ele, de modo que LicensePath e AddPlugin<...>() funcionam juntos quando as licenças dos plugins ficam ao lado da licença base.

Por fluxo

LicenseStream é lido uma única vez, na inicialização — útil quando a licença vem de um recurso incorporado ou de um armazenamento secreto em vez de um arquivo no disco.

csharp
// Precedência: LicenseStream > LicenseContent > LicensePath > pesquisa automática.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Por conteúdo

LicenseContent recebe o próprio texto da licença — de uma variável de ambiente, de um banco de dados ou de um armazenamento secreto — então nenhum arquivo de licença precisa ser implantado com o site.

csharp
// XML de licença de um banco de dados, uma variável de ambiente ou um repositório secreto -
// nenhum arquivo no disco. Superado apenas por LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Descoberta automática

Não defina nenhum dos três, e o Doconut procura a licença por conta própria:

csharp
// Não configure nada, e Doconut procura a licença por conta própria, nesta ordem:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (sob o IIS: a pasta raiz do site)
// Ele procura Doconut.lic primeiro; se estiver ausente, Doconut.Viewer.lic mais qualquer
// arquivos Doconut.Viewer.<Capability>.lic por plugin.
Doconut.DoconutHost.Initialize();

As duas pastas, em ordem, e os arquivos procurados:

Nomes de arquivos, em ordem (cada um procurado na pasta 1, depois na pasta 2):

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

Em IIS e IIS Express, AppContext.BaseDirectory é a pasta raiz do site — aquela que contém Web.config — não a pasta bin. Portanto, a licença deve estar em wwwroot sob a raiz do site:

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

No projeto, mantenha wwwroot\*.lic ao lado de Web.config e implante a pasta com o site. Nenhuma etapa de compilação precisa copiá-la para nenhum lugar. Um .lic em outro local — em bin\, ao lado de Web.config, ou em uma subpasta de wwwroot — nunca é lido.

Mantenha os arquivos .lic fora do controle de versão. Implante-os ao lado do site, ou forneça a licença através de LicenseContent ou LicenseStream a partir do seu armazenamento secreto.

O que acontece sem uma licença

Uma licença ausente não lança exceção. DoconutHost.Initialize tem sucesso, o site inicia e o visualizador funciona, mas cada página exibe uma marca d'água de avaliação e nenhuma capacidade opcional é concedida.

Um arquivo de licença que é encontrado, mas rejeitado, é diferente. Uma assinatura inválida, adulteração ou uma compilação fora da janela de versão da licença faz OpenDocumentAsync lançar LicenseException com a razão. Uma licença Temporária expirada continua em modo com marca d'água. Uma licença paga cuja data de assinatura expirou continua funcionando, limpa e com suas capacidades, em todas as compilações lançadas antes dessa data.

Plugins precisam de sua licença na inicialização

Registrar um plugin cuja capacidade não é concedida por nenhuma licença interrompe a aplicação na inicialização. DoconutHost.Initialize lança em 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.

No System.Web, você não vê essa mensagem no navegador. Cada requisição ao site responde com um 500 vazio — sem página de erro, sem rastreamento de pilha, nada no log do IIS. A exceção é registrada apenas no Windows event log (log de Aplicação, origem ASP.NET). Se todo o site parar de responder logo após você adicionar uma linha AddPlugin, verifique os arquivos de licença em wwwroot antes do código: o Doconut.Viewer.<Capability>.lic do plugin deve ficar ao lado de Doconut.Viewer.lic, e sem a licença base os arquivos do plugin não são lidos.

Verificar a licença carregada

IDoconutLicenseService é a mesma fonte de verdade que o SDK usa. Resolva-a a partir de DoconutHost.Services para expor um endpoint de diagnóstico autenticado ou controlar flags de recursos — nunca retorne o conteúdo da licença:

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);
}

A licença é lida uma única vez, em DoconutHost.Initialize. Após substituir um arquivo de licença, recicle o pool de aplicações (ou toque em Web.config) para que Application_Start seja executado novamente.

Solução de Problemas

SintomaCausa provávelVerificação
O visualizador funciona mas cada página tem marca d'águaNenhuma licença foi encontradaO .lic está em <site root>\wwwroot? Chame o endpoint de status acima
Cada requisição responde com um 500 vazio logo após adicionar um pluginUm plugin registrado não tem licença que o concedaLog de eventos do Windows, origem ASP.NET; o .lic do plugin ao lado de Doconut.Viewer.lic
LicensePath funciona na sua máquina mas não no servidorUm caminho relativo resolvido em relação à pasta do processo de trabalhoCompile-o com HostingEnvironment.MapPath("~/wwwroot/...")
Um arquivo .lic substituído não tem efeitoA licença foi lida quando a aplicação iniciouRecicle o pool de aplicações
OpenDocumentAsync lança LicenseExceptionA licença foi encontrada mas rejeitadaLeia a mensagem da exceção; não a mostre a clientes não confiáveis

Próximos passos

Esta página foi útil?