Ir para o conteúdo

Documentação

cPanel e WHM

O cPanel é o painel onde os seus clientes iniciam sessão; o WHM é o painel acima dele, e é aí que o Provibr se liga. Não há sistema operativo para instalar nem máquina para arrancar. Uma conta é criada num servidor que já está em execução, recebe um pacote e, mais tarde, é suspensa, mudada para outro pacote ou removida.

O que é preciso

Um token de API do WHM, não uma palavra-passe nem um acesso do cPanel. É criado no próprio WHM e viaja como um cabeçalho normal em cada chamada que o agente faz.

  • Anfitrião: o endereço do WHM, incluindo https. Se a porta for omitida, o Provibr preenche 2087.
  • Utilizador do WHM: a conta a que o token pertence, normalmente root.
  • Token de API: criado em Manage API Tokens dentro do WHM e mostrado uma única vez.
  • Impressão digital TLS: opcional e, num servidor cPanel, normalmente fica vazia. A secção seguinte explica porquê.
shell
openssl s_client -connect <host>:2087 </dev/null 2>/dev/null | \
  openssl x509 -noout -fingerprint -sha256
Os comandos e a saída do terminal estão em inglês em todo o lado, no painel e nestas páginas. Um só texto, uma só verdade: o que aqui se lê é literalmente o que o seu host vai devolver.
O endereço tem de ser https, ao contrário do DirectAdmin e do Pterodactyl, onde um painel sem cifra é aceite com um aviso. O WHM responde na 2086 sem cifra e na 2087 com cifra, e o Provibr aceita apenas a segunda. Nessa ligação não viaja a chave de uma conta, mas um token que pode criar e eliminar todas as contas da máquina.

Criar o token

O token é criado no WHM, pelo utilizador a que vai pertencer. O Provibr não volta a vê-lo depois de guardado: é enviado uma vez para o agente e selado no cofre desse agente, e a plataforma guarda apenas os nomes dos campos.

  1. Iniciar sessão no WHM com o utilizador a que o token deve pertencer, normalmente root.
  2. Abrir Development e depois Manage API Tokens.
  3. Gerar um token e dar-lhe um nome que indique que pertence ao Provibr, para o reconhecer mais tarde quando quiser revogá-lo.
  4. Copiar o token antes de sair da página. O WHM mostra-o uma vez e não o pode mostrar de novo; perdê-lo obriga a criar outro.
Um token com todas as funções selecionadas equivale a root nessa máquina. Convém limitá-lo ao que a integração chama de facto: ler a versão, as contas, os pacotes, o tráfego e os domínios, e criar, suspender, retomar, mudar de pacote e remover contas. Uma chamada que o token não pode fazer falha com o motivo devolvido pelo WHM, e esse desfecho é melhor do que um token que pode tudo.

O certificado

A porta 2087 é a cifrada, e um servidor cPanel costuma apresentar um certificado de uma autoridade pública que o próprio painel renova, aproximadamente a cada noventa dias. Nesse caso comum, o campo da impressão digital fica vazio e o agente verifica o certificado tal como um navegador faria.

Fixar um certificado que se renova a cada noventa dias significa voltar a fixá-lo a cada noventa dias. Uma integração que para quatro vezes por ano é pior do que o problema que devia resolver, por isso convém deixar o campo vazio salvo se houver motivo para o contrário.

Só deve ser preenchido quando o servidor apresenta um certificado pelo qual nenhuma autoridade pública responde, o que na prática significa uma autoridade de certificação interna própria. A impressão digital é recolhida a partir do anfitrião do agente, para fixar exatamente o que o agente vai ver, e deve ser recolhida de novo sempre que esse certificado for substituído.

Definições

Não existem. Um WHM decide sozinho em que máquina uma conta fica e que endereço recebe, pelo que não sobra nada para escolher. O separador de definições continua a existir, porque é também aí que se reenviam as credenciais.

Pacotes de alojamento

Um pacote do WHM é a descrição que o próprio painel faz de uma conta: quota de disco, tráfego mensal, quantos subdomínios e caixas de correio, que lista de funcionalidades. Não é um plano do Provibr nem um sistema operativo. É um nome a que fazemos referência, e o seu conteúdo pode mudar no seu servidor sem que demos por isso.

A página da integração consegue ler a lista de pacotes com o respetivo conteúdo, de modo que se escolhe entre o que o servidor tem realmente em vez de escrever um nome de memória. Os pacotes criam-se no WHM; o Provibr não os cria.

Um plano web fixa um pacote numa integração e dá-lhe um nome próprio. Encomendar com um plano prevalece sobre escolher um pacote solto, e essa escolha solta continua disponível para os casos que um plano não cobre.

Um limite que um pacote omite não é um limite de zero, mas a ausência de limite. O pacote predefinido que vem com o WHM não tem quota de disco nem limite de tráfego, e isso é um pacote ilimitado e não um pacote avariado.

Se a quota de disco chega a ser aplicada

Um servidor cPanel só aplica quotas de disco quando o sistema de ficheiros onde as contas residem suporta quotas. Sem isso, o WHM aceita o pacote, aceita o número e não aplica nada.

O sintoma é silencioso. Ao mudar uma conta para um pacote com uma quota de dois gigabytes, a conta continua a declarar o seu limite como ilimitado: nada falhou, nada foi recusado, e o número desse pacote não significa nada naquela máquina.

O teste de ligação comunica isto. Lê as contas do servidor e diz se as respetivas quotas estão mesmo a ser aplicadas, ao lado da versão do WHM e das contagens. Num servidor sem contas não há nada para medir, e é isso que indica em vez de adivinhar.

É também por isso que o Provibr lê o limite de disco na conta e não no pacote. O que a conta declara é o que vigora; o número no pacote é o que alguém pretendia.

Ativar as quotas é trabalho no servidor e não no Provibr: o sistema de ficheiros tem de ser montado com quotas de utilizador e as contas têm de ser reanalisadas. O que isso exige depende do sistema de ficheiros e de como a máquina foi instalada, pelo que o fornecedor de alojamento ou a documentação do cPanel é o sítio indicado.

Como é uma conta no Provibr

Uma conta de alojamento é uma linha de servidor normal do tipo servidor web. O seu identificador é o nome de utilizador do cPanel, e o domínio principal, o pacote, a ocupação de disco e o tráfego chegam em cada sondagem.

  • Criar uma conta exige um nome de utilizador, um domínio principal, um endereço de contacto, um pacote e uma palavra-passe.
  • Os nomes de utilizador seguem a regra do próprio WHM: começam por uma letra, depois letras e algarismos, no máximo dezasseis caracteres. Sem hífenes e sem sublinhados.
  • A palavra-passe não fica registada em lado nenhum. Fica apenas o facto de ter sido fornecida uma; o valor viaja em separado.
  • Depois é possível suspender, retomar, mudar de pacote e eliminar. Não há consola, porque uma conta de alojamento não tem.
  • Nenhum resultado é aceite pela sua própria palavra. O WHM confirma uma alteração com uma página de saída de processo em vez do novo estado, por isso cada alteração termina com uma nova leitura da conta.
As maiúsculas são o ponto a vigiar. Ao escrever OMeuCliente, o WHM cria omeucliente, comunica sucesso e não o menciona. Um identificador que deixe de corresponder ao servidor faria a conta desaparecer do painel na sondagem completa seguinte, por isso o Provibr passa o nome a minúsculas antes de o enviar e regista o nome devolvido pelo servidor.

Adotar contas que já existem

O separador de importação lista as contas do painel e permite trazer para o Provibr as que interessarem. As contas já conhecidas são mostradas mas não podem ser selecionadas de novo, de modo que se vê o quadro completo e não um quadro filtrado.

As contas importadas contam para a capacidade tal como as contas encomendadas. Se forem importadas mais do que as que cabem, abre-se um excesso, com o período de tolerância habitual.

Consumo

A ocupação de disco e o tráfego seguem com a sondagem habitual, pelo que uma conta obtém um gráfico de consumo sem ativar mais nada. O tráfego é um total mensal que o próprio servidor repõe, por isso é apresentado como número na conta e não como linha no gráfico.

Logo a seguir a uma mudança de pacote, a conta declara o novo pacote de imediato e o novo limite de tráfego alguns minutos depois. O nome vale desde logo e o número acerta numa sondagem posterior; a divergência momentânea entre os dois não é uma avaria.

Bom saber

  • Administrar o próprio servidor não existe. O Provibr cria, altera e remove contas num WHM operado por si; os serviços, as zonas DNS, o encaminhamento de correio e as definições do próprio painel ficam onde estão.
  • Não há consola. Uma conta de alojamento não é uma máquina, por isso não há nada a que ligar um terminal.
  • As caixas de correio, as bases de dados e o DNS dentro de uma conta pertencem ao cPanel. O Provibr cria a conta e entrega-a; o que acontece lá dentro é entre o cliente e o painel.
  • As contas de revendedor não estão modeladas. O Provibr fala com o WHM como um único operador, e um token de um revendedor vê um mundo mais pequeno do que o root. Esse caso não foi medido e não é descrito aqui.