cPanel and WHM

A WHM API token, not a password and not a cPanel login. You create it in WHM itself, and it travels as an ordinary header on every call the agent makes.

• Host: the address of WHM, including https. Leave the port out and Provibr fills in 2087.
• WHM user: the account the token belongs to, usually root.
• API token: created under Manage API Tokens in WHM, and shown to you once.
• TLS fingerprint: optional, and on a cPanel server you normally leave it empty. The section below says why.

openssl s_client -connect <host>:2087 </dev/null 2>/dev/null | \
  openssl x509 -noout -fingerprint -sha256

The token is made in WHM, by the user it will belong to. Provibr never sees it again after you save it: it is pushed once to your agent and sealed in that agent's vault, and the platform keeps only the field names.

1. 01Sign in to WHM as the user the token should belong to, usually root.
2. 02Open Development and then Manage API Tokens.
3. 03Generate a token and give it a name that says it belongs to Provibr, so you can recognise it later when you want to withdraw it.
4. 04Copy the token before you leave the page. WHM shows it once and cannot show it again; losing it means creating a new one.

Port 2087 is the encrypted one, and a cPanel server usually carries a certificate from a public authority that the panel renews by itself, roughly every ninety days. In that ordinary case the fingerprint field stays empty and the agent verifies the certificate the way a browser would.

Fill it in only when the server presents a certificate no public authority vouches for, which in practice means your own internal certificate authority. Take the fingerprint from the agent host, so you are fingerprinting exactly what the agent will see, and take it again whenever that certificate is replaced.

There are none. A WHM decides for itself which machine an account lands on and which address it gets, so there is nothing left for you to choose. The settings tab still exists, because that is also where you resend credentials.

A WHM package is the panel's own description of an account: disk quota, monthly bandwidth, how many subdomains and mailboxes, which feature list. It is not a Provibr plan and not an operating system. It is a name we refer to, and what is in it can change on your server without us noticing.

The integration page can read the list of packages with what is in them, so you pick from what your server really has rather than typing a name from memory. Packages are made in WHM; Provibr does not create them.

A web plan pins one package on one integration and gives it a name of your own. Ordering with a plan beats picking a loose package, and the loose picker stays available for the cases a plan does not cover.

A cPanel server only enforces disk quotas when the filesystem the accounts live on carries quota support. Without it WHM accepts the package, accepts the number, and enforces nothing.

The connection test reports this. It reads the accounts on the server and says whether their quotas are really being enforced, next to the WHM version and the counts. On a server without accounts there is nothing to measure, and it says that rather than guessing.

It is also why Provibr reads the disk limit from the account and not from the package. What the account reports is what is in force; the number in the package is what somebody intended.

Switching quotas on is work on the server rather than in Provibr: the filesystem has to be mounted with user quotas and the accounts rescanned. What that takes depends on the filesystem and on how the machine was installed, so your hosting provider or the cPanel documentation is the place for it.

A hosting account is an ordinary server row of the type webserver. Its identifier is the cPanel username, and its main domain, package, disk usage and bandwidth come along on every poll.

• Creating an account needs a username, a main domain, a contact address, a package and a password.
• Usernames follow WHM's own rule: starting with a letter, then letters and digits, at most sixteen characters. No hyphens and no underscores.
• The password is not recorded anywhere. Only the fact that you supplied one is; the value travels separately.
• Afterwards you can suspend, resume, change the package and delete. There is no console, because a hosting account does not have one.
• No result is trusted on its own word. WHM confirms a change with a page of process output rather than with the new state, so every change ends by reading the account back.

The import tab lists the accounts on the panel and lets you take the ones you want into Provibr. Accounts already known are shown but cannot be selected again, so you see the whole picture rather than a filtered one.

Disk usage and bandwidth ride along with the regular poll, so an account gets a usage graph without anything extra being switched on. Bandwidth is a monthly total that the server resets itself, so it is shown as a number on the account rather than as a line on the graph.

• Managing the server itself does not exist. Provibr creates, changes and removes accounts on a WHM you operate; the services, DNS zones, mail routing and the panel's own settings stay where they are.
• There is no console. A hosting account is not a machine, so there is nothing to attach a terminal to.
• Mailboxes, databases and DNS inside an account belong to cPanel. Provibr creates the account and hands it over; what happens inside it is between your customer and the panel.
• Reseller accounts are not modelled. Provibr talks to WHM as one operator, and a token owned by a reseller sees a smaller world than root does, and that case has not been measured and is not described here.