Skip to main content
Version: 4.1

Portals

hitechcloudcli portals installs and manages the customer portals: Mail (port 2091), DNS (2092) and S3 (2093), and the portal API they share on 127.0.0.1:2094. <portal> is mail, dns or s3. What the portals are and who can sign in: Customer portals.

hitechcloudcli mailportal ... is a deprecated alias of this command.

Install, update, turn on and off​

hitechcloudcli portals install [mail|dns|s3|all] # default: all
hitechcloudcli portals update [<portal>...]
hitechcloudcli portals enable <portal>
hitechcloudcli portals disable <portal>

From 4.1.2 a portal that is not switched off (off in hitechcloud.config) is installed and started by the installer and by every update.

  • install downloads the release's app, verifies it against the signed SHA256SUMS, installs it and turns it on.
  • update does the same for the installed portals. A new version is switched in, restarted and checked, and put back when it does not answer.
  • enable turns a portal on (installing it when it is not): its unit, environment, vhost and firewall port.
  • disable stops the unit, drops the vhosts and closes the port. The files and hostnames stay.

Status and logs​

hitechcloudcli portals status [--json]
hitechcloudcli portals logs <portal> [-n <lines>]

status shows, per portal: on or off, version, port, unit, health, the certificate, and why a vhost is not written.

Repair and converge​

hitechcloudcli portals repair
hitechcloudcli portals converge

repair renders everything again and restarts every enabled portal and the API. converge is what every update runs: the same, without a forced restart (only what changed is restarted).

Port​

hitechcloudcli portals port <portal> <n>

The public TLS port (default 2091, 2092, 2093). The panel's ports, 2094, ports below 1024 and a port something else is listening on are refused.

Hostnames​

hitechcloudcli portals host add <portal> <hostname> [--owner <user>] [--no-issue]
hitechcloudcli portals host remove <portal> <hostname>
hitechcloudcli portals host list [<portal>] [--json]
hitechcloudcli portals host issue <hostname>

host add also serves the portal at https://<hostname>/, for a reseller or an account with --owner. It is served under the panel's certificate at once, and the hostname's own certificate is ordered in the background (--no-issue skips that). host list shows the host, portal, owner and certificate state. host issue orders the hostname's certificate again.

Was this helpful?