Documentação · WHMCS 9

Guia de Instalação

Tudo o que você precisa para colocar a Aurora Themes no ar: requisitos, envio dos arquivos, ativação do addon e da licença, escolha do tema e do carrinho, conferência final, atualização e remoção.

Tempo estimado: 15 a 30 minutos Nível: administrador do WHMCS Versão do pacote: 1.0.0

01O que vem no pacote

A Aurora Themes é uma suíte de três peças que trabalham juntas, mais os modelos de e-mail.

Tema da área do cliente

Pasta aurorathemes. Tema filho do Nexus, o tema padrão do WHMCS 9: redesenha as páginas principais e herda o resto.

Carrinho (order form)

Pasta aurorathemes_cart. Baseado no Standard Cart: planos com troca de ciclo e checkout em etapas.

Addon Aurora Themes

Pasta aurorathemes_admin. Painel de configuração, licença, construtor da página inicial e skin do admin.

Modelos de e-mail

HTML responsivo em 3 idiomas, importado manualmente. Veja a seção 11.

O arquivo aurorathemes.zip tem esta estrutura:

aurorathemes-vX.Y.Z/
│   ├── templates/aurorathemes/            tema da área do cliente
│   ├── templates/orderforms/aurorathemes_cart/   carrinho
│   ├── modules/addons/aurorathemes_admin/ addon
│   └── includes/hooks/aurorathemes_client.php    hook do tema
└── docs/                                  manuais e modelos de e-mail (não enviar)

As três peças dependem umas das outras. O carrinho usa as cores e fontes do tema do cliente, e o tema lê as configurações salvas pelo addon. Instale sempre as três.

02Requisitos

Confira cada item antes de enviar os arquivos.

ItemExigênciaOnde conferir
WHMCS9.x. Versões 8.x e anteriores não são suportadas.Rodapé do admin ou Ajuda › Informações do sistema
PHP8.2, 8.3, 8.4 ou 8.5, desde que a sua versão do WHMCS 9 suporte (a WHMCS recomenda 8.3)Utilitários › Sistema › Informações do PHP
ionCube Loader13.0.2 ou superior (exigência do WHMCS 9; 14.x recomendado). Os arquivos PHP da Aurora são criptografados com ionCube e não funcionam sem ele.Informações do PHP, bloco “ionCube”
Tema NexusPresente em templates/nexus (vem com o WHMCS 9). Não apague.Gerenciador de arquivos / FTP
Standard CartPresente em templates/orderforms/standard_cart (vem com o WHMCS)Gerenciador de arquivos / FTP
Cron do WHMCSRodando todos os dias (a licença é reconfirmada no cron diário)Configurações do sistema › Automação
Conexão de saídaHTTPS (porta 443) para painel.modulespay.com.br, o servidor de licenças da Modules PayFirewall do servidor / hospedagem
Chave de licençaRecebida na compra, na sua conta da Modules PayÁrea do cliente da Modules Pay
NavegadoresVersões atuais de Chrome, Edge, Firefox e Safari—

03Antes de começar

Três cuidados rápidos evitam dor de cabeça.

  • Backup completo dos arquivos do WHMCS e do banco de dados. A instalação não altera arquivos do WHMCS, mas o backup permite voltar atrás em qualquer situação.
  • Anote o tema e o carrinho atuais (em Configurações gerais › Geral › Template e Configurações gerais › Pedidos), para poder voltar se precisar.
  • Tenha à mão o acesso FTP/SFTP ou o gerenciador de arquivos da hospedagem, um usuário administrador do WHMCS com acesso total e a chave de licença.

Dica: se tiver um ambiente de testes (cópia do WHMCS), instale lá primeiro. O tema pode ser conferido antes de ficar visível para os clientes com o recurso Visualizar tema, explicado no Guia de Utilização.

04Enviar os arquivos

Os arquivos vão para a raiz do WHMCS, sem substituir nada do próprio WHMCS.

  1. Descompacte o pacote no seu computadorAbra aurorathemes.zip e localize as pastas templates, modules e includes.
  2. Localize a raiz do WHMCS no servidorÉ a pasta onde ficam configuration.php, clientarea.php e cart.php. Pode ser a raiz do domínio (public_html/) ou uma subpasta (ex.: public_html/clientes/).
  3. Envie as pastas templates, modules e includesEnvie as três pastas para a raiz do WHMCS. Elas já existem no servidor: o conteúdo é mesclado a elas.

    No gerenciador de arquivos do cPanel, a forma mais rápida é compactar as três pastas num zip, enviar esse zip para a raiz do WHMCS e usar Extrair.

  4. Confira o resultadoDepois do envio, a raiz do WHMCS deve ter:
    templates/aurorathemes/theme.yaml
    templates/orderforms/aurorathemes_cart/theme.yaml
    modules/addons/aurorathemes_admin/aurorathemes_admin.php
    includes/hooks/aurorathemes_client.php
  5. Ajuste as permissões, se necessárioArquivos com 644 e pastas com 755. A pasta modules/addons/aurorathemes_admin/ precisa permitir escrita pelo PHP: a subpasta uploads/, onde ficam os logos e imagens enviados pelo painel, é criada no primeiro envio.
  • Não envie a pasta docs/ ao servidor: ela é só para você.
  • Envie os arquivos em modo binário no FTP (ou use SFTP/gerenciador de arquivos). Os arquivos PHP são criptografados com ionCube: modo texto (ASCII) os corrompe e causa erro ao abrir o addon.
  • Não renomeie as pastas. Os nomes aurorathemes, aurorathemes_cart e aurorathemes_admin são usados internamente.
  • Não apague nem altere templates/nexus e templates/orderforms/standard_cart: a Aurora herda deles as páginas que não redesenha.

05Ativar o addon

O addon cria as tabelas de configuração e libera o painel da Aurora no admin.

  1. Abra a lista de addonsNo admin do WHMCS, vá em Configurações do sistema › Módulos Addon (Addon Modules).
  2. Ative o Aurora ThemesLocalize Aurora Themes e clique em Ativar. As tabelas mod_aurorathemes_* são criadas nesse momento.
  3. Clique em ConfigurarNa mesma linha, abra Configurar e preencha:
    CampoO que informar
    Chave de licençaCole a chave recebida da Modules Pay, sem espaços antes ou depois.
    Apagar dados ao desativarDeixe desmarcado. Marque só quando quiser remover a Aurora de vez (veja Desinstalação).
    Access ControlMarque apenas os grupos de administradores que podem alterar o tema (normalmente, só Full Administrator).
  4. SalveClique em Salvar alterações. O painel da Aurora passa a aparecer em Addons › Aurora Themes.

06Ativar a licença

Sem licença ativa o tema continua funcionando, mas as configurações ficam bloqueadas.

  1. Abra o painelVá em Addons › Aurora Themes. No topo aparece o quadro Licença.
  2. Clique em “Verificar agora”O WHMCS consulta o servidor de licenças da Modules Pay. Em poucos segundos a situação muda para Ativa e as abas de configuração são liberadas.

Situações possíveis

SituaçãoSignificadoO que fazer
AtivaConfirmada nos últimos 7 dias.Nada.
Sem chaveNenhuma chave informada no módulo.Informe a chave em Módulos Addon › Aurora Themes › Configurar, salve e clique em Verificar agora.
Inválida ou expiradaO servidor recusou a chave (inválida, vencida ou suspensa).Confira a chave e a validade na sua conta da Modules Pay. Se mudou o WHMCS de domínio, IP ou pasta, peça a reemissão (reissue) da licença na sua conta.
Não verificadaNunca confirmada, ou sem resposta do servidor há mais de 7 dias.Veja Solução de problemas: normalmente é firewall ou cron parado.

Como a verificação funciona

  • A licença é conferida no cron diário e quando você abre o painel do addon, se a última verificação tiver mais de 24 horas.
  • A área do cliente nunca consulta o servidor de licenças: o site dos seus clientes não fica mais lento nem depende da Modules Pay estar no ar.
  • Se o servidor de licenças não responder, a última confirmação vale por até 7 dias.
  • Sem licença ativa, o painel mostra só o quadro da licença, com a instrução do caso e o atalho Abrir configuração do módulo. A área do cliente e a skin do admin continuam funcionando com as configurações atuais, e um aviso discreto aparece no canto inferior do admin.

07Ativar o tema da área do cliente

A partir deste passo os clientes passam a ver a Aurora.

Quer escolher entre os seis temas visuais e conferir antes de publicar? Faça isso primeiro na aba Temas do addon, com Visualizar tema, e só depois ative o template. Detalhes no Guia de Utilização.

  1. Abra as configurações geraisConfigurações do sistema › Configurações gerais › Geral.
  2. Escolha o templateNo campo Template, selecione Aurora Themes.
  3. SalveClique em Salvar alterações.

Se o seu WHMCS permite que o cliente escolha o template, a Aurora aparece na lista como qualquer outro tema. O tema padrão escolhido aqui é o que visitantes e novos clientes veem.

08Ativar o carrinho (order form)

O carrinho da Aurora segue o visual do tema escolhido.

  1. Abra as opções de pedidoConfigurações do sistema › Configurações gerais › Pedidos (Ordering).
  2. Escolha o order form padrãoEm Default Order Form Template, selecione Aurora Themes Cart.
  3. SalveClique em Salvar alterações.
  4. Confira os grupos de produtosEm Configurações do sistema › Produtos/Serviços, cada grupo pode ter um order form próprio, que vence o padrão. Edite os grupos que devem usar a Aurora e selecione Aurora Themes Cart (ou deixe o grupo usando o padrão).

Para um plano aparecer com o selo de destaque na lista de planos, marque-o como destaque nas configurações do produto. Sem produto marcado, o plano do meio é destacado.

09Cron, nginx e cache

Ajustes finais do servidor.

Cron diário

Em Configurações do sistema › Automação, confirme que o cron está rodando (a data da última execução aparece na página). Sem ele, a licença não é reconfirmada e acaba ficando “não verificada” depois de 7 dias.

Servidor nginx

Em Apache, o arquivo .htaccess criado junto com a pasta de envios já bloqueia a execução de scripts. Em nginx, que ignora o .htaccess, adicione esta regra ao bloco server do site (ajuste o caminho se o WHMCS estiver numa subpasta) e recarregue o nginx:

location ~* ^/modules/addons/aurorathemes_admin/uploads/.*\.(php|phtml|phar|pl|py|cgi|sh|svg|html?)$ {
    deny all;
}

Cache de templates

Em Utilitários › Sistema › Limpeza do sistema, clique em Empty Template Cache. Se usar CDN ou cache no servidor (Cloudflare, LiteSpeed, Varnish), limpe também.

10Conferência final

Abra o site numa janela anônima e percorra os pontos abaixo.

Área do cliente

  • A página inicial abre com o visual da Aurora (cabeçalho, hero, planos, rodapé).
  • Login e cadastro mostram o painel de marca ao lado do formulário.
  • Depois do login: painel, serviços, domínios, faturas e tickets com o menu lateral.
  • O botão de claro/escuro funciona (se estiver liberado no addon).
  • A troca de idioma funciona (inglês, português e espanhol).
  • No celular, o menu abre como painel lateral.

Carrinho

  • A lista de planos mostra a troca de ciclo (mensal, anual…).
  • Um pedido de teste passa por configuração, carrinho, checkout e página de conclusão.
  • A busca e o registro de domínio funcionam.

Admin

  • Addons › Aurora Themes abre com a licença Ativa.
  • A skin do admin aparece (se ligada na aba Painel admin).
  • Relatórios › Smarty Compatibility, com o tema ativo, não aponta problemas nos templates da Aurora.

Tudo certo? Siga para o Guia de Utilização para escolher o tema visual, montar a página inicial e colocar a sua marca.

11Modelos de e-mail (opcional)

A importação é manual, para não sobrescrever modelos que você já personalizou.

Os arquivos ficam em docs/email-templates/ do pacote: cabeçalho e rodapé globais, CSS global opcional e o corpo de 13 modelos (cadastro, senha, pedido, faturas, serviço, domínio e suporte) em inglês, português e espanhol. Os assuntos estão em SUBJECTS.md.

  1. Cabeçalho e rodapé globais (uma vez só)Em Configurações gerais › Correio, cole global/header.html em Client Email Header Content e global/footer.html em Client Email Footer Content. Opcional: global/global.css em Global Email CSS Styling. Salve.
  2. Cada modeloEm Configurações do sistema › Modelos de e-mail, abra o modelo, mude o editor para o modo código-fonte, apague o conteúdo e cole o arquivo do idioma desejado. Cole também o assunto.
  3. TesteSalve e envie um e-mail de teste para conferir.

O passo a passo completo, com a lista dos modelos e dos merge fields, está em docs/pt-BR/email-templates.md.

12Atualização para uma nova versão

As configurações ficam no banco de dados e não se perdem na atualização.

  1. Leia o CHANGELOGO arquivo CHANGELOG.md da nova versão lista o que mudou e se há algum cuidado especial.
  2. Faça backupArquivos e banco de dados.
  3. Envie as pastas templates, modules e includes por cimaSubstitua os arquivos existentes, mantendo:
    • templates/aurorathemes/css/custom.css, se você criou;
    • modules/addons/aurorathemes_admin/uploads/ (logos e imagens enviados).
  4. Abra o painel do addon uma vezAcesse Addons › Aurora Themes. O WHMCS roda a atualização do banco do addon automaticamente.
  5. Limpe o cacheUtilitários › Sistema › Limpeza do sistema › Empty Template Cache, mais o cache do navegador/CDN.

Quando o WHMCS for atualizado

A Aurora herda do Nexus e do Standard Cart, então as correções da WHMCS continuam chegando. Depois de atualizar o WHMCS, rode Relatórios › Smarty Compatibility e confira se há uma versão nova da Aurora para a sua versão do WHMCS.

13Solução de problemas na instalação

Os casos mais comuns e como resolver.

A Aurora não aparece na lista de templates

Confira se a pasta é exatamente templates/aurorathemes (com theme.yaml dentro, e não templates/templates/… ou templates/aurorathemes/aurorathemes) e se templates/nexus existe.

O carrinho não aparece na lista de order forms

A pasta deve ser templates/orderforms/aurorathemes_cart, e templates/orderforms/standard_cart precisa existir.

O addon não aparece em Módulos Addon

Confirme o caminho modules/addons/aurorathemes_admin/aurorathemes_admin.php. Se a página de addons mostrar erro, confira se o ionCube Loader está instalado e na versão 13.0.2 ou superior: os arquivos PHP da Aurora são criptografados com ionCube. Um erro como “file is corrupted” indica envio por FTP em modo texto; envie de novo em modo binário.

A área do cliente abre sem estilo

As pastas templates/aurorathemes/css/ e templates/aurorathemes/js/ precisam ter sido enviadas e estar legíveis pelo servidor (arquivos 644, pastas 755). Limpe o cache de templates e o do navegador.

As cores e textos do painel não aparecem no site

O hook includes/hooks/aurorathemes_client.php precisa estar no lugar. Salvar no painel limpa na hora o cache interno do tema; se ainda assim não mudar, limpe o cache de templates e o do CDN.

A licença fica “não verificada”
  • Confirme que o cron diário do WHMCS está rodando.
  • O servidor precisa abrir conexões HTTPS de saída (porta 443) para painel.modulespay.com.br. Peça à hospedagem para liberar, se houver firewall.
  • O certificado SSL é verificado: um servidor com a lista de certificados (CA) muito antiga pode falhar. Peça à hospedagem para atualizar o pacote de certificados.
  • Clique em Verificar agora no painel do addon.
A licença aparece como inválida depois de mudar de servidor ou domínio

A licença fica vinculada ao domínio, IP e pasta do WHMCS. Peça a reemissão (reissue) na sua conta da Modules Pay e clique em Verificar agora.

O envio de logo ou imagem falha
  • Formatos aceitos: PNG, JPG, WebP e GIF. SVG não é aceito, por segurança.
  • Limites: 1 MB para logos, 2 MB para imagens da página inicial, até 4000 × 4000 px.
  • A pasta modules/addons/aurorathemes_admin/ precisa permitir escrita pelo PHP.
  • Confira upload_max_filesize e post_max_size no PHP.
A tela de login do admin não mudou

É esperado: o WHMCS 9 não oferece um ponto de extensão para a tela de login do admin. A skin da Aurora aparece depois do login.

Erros de template (Smarty)

Rode Relatórios › Smarty Compatibility com o tema ativo e envie o resultado ao suporte da Modules Pay, junto com as versões do WHMCS e do PHP.

14Desinstalação

Remova na ordem abaixo para os clientes nunca verem uma página quebrada.

  1. Volte o tema e o carrinhoEm Configurações gerais, selecione Nexus como template e Standard Cart como order form (e nos grupos de produtos que usavam a Aurora).
  2. Decida sobre as configuraçõesPara apagar as configurações e preferências: em Módulos Addon › Aurora Themes › Configurar, marque Apagar dados ao desativar e salve. Sem essa opção, desativar mantém tudo, e reativar depois recupera as configurações.
  3. Desative o addonClique em Desativar na linha do Aurora Themes.
  4. Apague os arquivostemplates/aurorathemes/, templates/orderforms/aurorathemes_cart/, modules/addons/aurorathemes_admin/ e includes/hooks/aurorathemes_client.php.
  5. Limpe o cache de templatesUtilitários › Sistema › Limpeza do sistema › Empty Template Cache.

Apagar os arquivos com a Aurora ainda selecionada como template deixa a área do cliente sem tema. Faça sempre o passo 1 antes.

Os modelos de e-mail importados não são removidos: restaure os padrões do WHMCS em Modelos de e-mail, se quiser.