> For the complete documentation index, see [llms.txt](https://ajuda.zdg.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.zdg.com.br/configuracao-superadmin/tenants-e-licenca/gerenciar-licenca-z-pro/como-publicar-a-central-de-ajuda-com-a-sua-marca-documentacao-white-label.md).

# Como publicar a central de ajuda com a sua marca (Documentação white label)

Publique a central de ajuda do sistema com a sua marca e no seu domínio, para repassar aos seus clientes. Configuração no Painel do Licenciado: domínio, registro DNS, nome, cor e logo.

A **Documentação white label** é uma central de ajuda pronta, com os tutoriais de uso do sistema, que você repassa aos seus clientes com **a sua marca e no seu domínio**. O conteúdo é o mesmo da nossa central, sem nenhuma menção ao Z-PRO ou à ZDG: no lugar do nome do sistema aparece o nome que você definir, com o seu logo e a sua cor.

Assim, quando o seu cliente tiver dúvida de como usar o sistema, você indica um endereço seu, como `ajuda.suaempresa.com.br`, em vez de escrever os tutoriais do zero.

Para ver como fica antes de configurar, abra o [modelo sem marca](https://ajuda.techprovider.com.br/) ou a [demonstração com uma marca fictícia](https://ajuda.techprovider.com.br/?demo=1).

{% hint style="info" %}
**Pré-requisitos:**

* Licença Z-PRO ativa e acesso ao [Painel do Licenciado](https://ajuda.zdg.com.br/configuracao-superadmin/tenants-e-licenca/gerenciar-licenca-z-pro/painel-do-licenciado.md)
* Um domínio próprio (o mesmo usado na instalação do Z-PRO serve)
* Acesso ao gerenciador de DNS do domínio (Cloudflare, Registro.br, Hostinger ou onde você cria os registros DNS)
* O IP da VPS onde o Z-PRO está instalado
* O logo da sua marca em PNG ou JPG, até 512 KB (opcional)
  {% endhint %}

***

### Como funciona

| O que você define       | Onde aparece                                                                                        |
| ----------------------- | --------------------------------------------------------------------------------------------------- |
| **Endereço da central** | O subdomínio onde a central fica no ar (ex: `ajuda.suaempresa.com.br`)                              |
| **Nome**                | No topo da central, no título da aba do navegador e no lugar do nome do sistema ao longo dos textos |
| **Cor principal**       | Barra do topo, links e destaques                                                                    |
| **Logo**                | Topo da central                                                                                     |

O conteúdo é mantido pela ZDG. Quando um tutorial é criado ou atualizado na nossa central, a sua versão recebe a mudança automaticamente, sem nenhum trabalho do seu lado.

{% hint style="warning" %}
**A central traz só o que o seu cliente usa.** Ela reúne os tutoriais de uso do sistema (atendimento, canais, automações, configurações da empresa). Assuntos da sua operação como licenciado, como licença, instalação, servidor e Superadmin, ficam de fora.
{% endhint %}

***

### Etapa 1: Escolher o endereço e criar o registro DNS

Use um **subdomínio novo** do seu domínio, por exemplo `ajuda.suaempresa.com.br`. Não use um subdomínio que já esteja em uso pelo sistema (como o do frontend ou do backend).

No gerenciador de DNS do seu domínio, crie um registro do **tipo A**:

| Tipo  | Nome                                        | Valor (conteúdo)                            |
| ----- | ------------------------------------------- | ------------------------------------------- |
| **A** | `ajuda` (ou o subdomínio que você escolheu) | O **IP da VPS onde o Z-PRO está instalado** |

O IP é o mesmo para o qual já apontam os subdomínios do seu sistema. Se não lembrar qual é, confira no painel do provedor da VPS ou nos registros DNS que já existem para o sistema.

{% hint style="info" %}
A propagação de um registro DNS novo costuma levar alguns minutos, mas pode chegar a algumas horas dependendo do provedor.
{% endhint %}

***

### Etapa 2: Cadastrar o domínio no painel

1. Acesse [painel.zdg.com.br](https://painel.zdg.com.br/) e selecione a licença.
2. No menu lateral, clique em **Documentação white label**.
3. No card **Domínio**, informe em **Endereço da central** o subdomínio que você criou na Etapa 1 (ex: `ajuda.suaempresa.com.br`).
4. Clique em **Salvar domínio**.

<figure><img src="https://3541975055-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FM5B652UsmGn3Q7h9Du1t%2Fuploads%2FMtR0qjWifb8BCssmO5Sl%2Fimage.png?alt=media&amp;token=4903504a-811a-4747-8c13-12a4cbb8ab1e" alt=""><figcaption></figcaption></figure>

Depois de salvar, verifique o DNS no card **Endereço no ar**. A central vai ao ar assim que o painel confirmar que o registro está apontando corretamente.

{% hint style="danger" %}
**Informe só o endereço**, sem `https://`, sem barras e sem caminho. Exemplo correto: `ajuda.suaempresa.com.br`.
{% endhint %}

***

### Etapa 3: Configurar a marca

No card **Marca**:

1. Em **Nome**, digite o nome do seu sistema (até 40 caracteres). É ele que substitui o nome do sistema em todos os textos da central.
2. Em **Cor principal**, escolha a cor no seletor ou digite o código hexadecimal (ex: `#3f51b5`).
3. Clique em **Salvar marca**.
4. Em **Logo**, clique em **Enviar logo** e selecione o arquivo.

| Item              | Regra                                                                                                   |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| **Nome**          | Até 40 caracteres                                                                                       |
| **Cor principal** | Código hexadecimal                                                                                      |
| **Logo**          | PNG ou JPG, até 512 KB. O painel reduz para no máximo 128 px de altura e remove os metadados do arquivo |

A **Pré-visualização do topo** mostra na hora como o cabeçalho da central vai ficar com o nome, a cor e o logo escolhidos.

{% hint style="info" %}
Para o logo ficar nítido, envie uma imagem com fundo transparente (PNG) e pelo menos 128 px de altura.
{% endhint %}

***

### Etapa 4: Conferir a central no ar

Com o DNS verificado, o card **Endereço no ar** mostra o endereço da sua central. Abra no navegador e confira o topo, o nome nos textos e os links.

Pronto: agora é só divulgar o endereço aos seus clientes, por exemplo no menu do sistema, na mensagem de boas-vindas ou na assinatura do seu suporte.

{% hint style="info" %}
A central fica disponível enquanto a sua licença estiver ativa.
{% endhint %}

***

### Resumo das Funcionalidades

| Funcionalidade                             | Onde acessar                                                                   |
| ------------------------------------------ | ------------------------------------------------------------------------------ |
| Ver o modelo sem marca                     | [ajuda.techprovider.com.br](https://ajuda.techprovider.com.br/)                |
| Ver a demonstração com marca fictícia      | [ajuda.techprovider.com.br/?demo=1](https://ajuda.techprovider.com.br/?demo=1) |
| Definir o endereço da central              | **Documentação white label > Domínio**                                         |
| Definir nome e cor                         | **Documentação white label > Marca > Salvar marca**                            |
| Enviar o logo                              | **Documentação white label > Marca > Enviar logo**                             |
| Verificar o DNS e ver o endereço publicado | **Documentação white label > Endereço no ar**                                  |

***

### Encerramento

Com a Documentação white label, os seus clientes ganham uma central de ajuda completa, com a sua marca e sempre atualizada, e você deixa de escrever e manter tutoriais por conta própria. Se você revende o sistema para vários clientes, veja também [Como funciona a revenda do Z-PRO (white-label)](https://ajuda.zdg.com.br/como-funciona-o-z-pro/artigo-usando-o-white-label-para-varios-clientes.md).

***

### Possíveis Erros e Soluções

#### O painel não confirma o DNS

**Causa:** o registro ainda não propagou, foi criado com o nome errado ou aponta para outro IP.

**Solução:** confira no gerenciador de DNS se o registro é do **tipo A**, se o nome é exatamente o subdomínio cadastrado no painel e se o valor é o IP da VPS do Z-PRO. Aguarde alguns minutos e verifique de novo.

#### O endereço abre o sistema, uma página de erro ou nada

**Causa:** o subdomínio escolhido já estava em uso por outro serviço, ou o DNS ainda não foi verificado no painel.

**Solução:** use um subdomínio novo, exclusivo para a central, e confirme a verificação no card **Endereço no ar**.

#### O logo não aparece ou ficou pequeno demais

**Causa:** arquivo em formato diferente de PNG ou JPG, maior que 512 KB, ou com pouca altura.

**Solução:** envie um PNG ou JPG de até 512 KB, com pelo menos 128 px de altura.

#### O nome do sistema aparece cortado

**Causa:** o campo **Nome** aceita até 40 caracteres.

**Solução:** use uma versão mais curta do nome e clique em **Salvar marca**.

#### A central saiu do ar

**Causa:** a licença venceu, ou o registro DNS foi removido ou alterado.

**Solução:** confira a validade da licença na **Visão geral** do painel e se o registro A continua apontando para o IP da VPS. Se estiver tudo certo, [abra um chamado](https://suporte.zdg.com.br/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ajuda.zdg.com.br/configuracao-superadmin/tenants-e-licenca/gerenciar-licenca-z-pro/como-publicar-a-central-de-ajuda-com-a-sua-marca-documentacao-white-label.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
