Skip to content

On-Premise Installation Instructions

Install the Zuar Portal on a prepared server. This guide assumes every prerequisite in On-Premise System Requirements is in place.

1. Before You Begin

Complete every step in On-Premise System Requirements and verify the server with the requirements check script:

curl -sL https://raw.githubusercontent.com/zuarbase/portal-on-prem-installer/main/check-requirements.sh | sudo bash -s -- --user <deploy-user>

If you are supplying a customer TLS certificate, add the --tls-cert flag:

curl -sL https://raw.githubusercontent.com/zuarbase/portal-on-prem-installer/main/check-requirements.sh | sudo bash -s -- --user <deploy-user> --tls-cert

All checks must pass before proceeding. When they do, contact Zuar Support to receive the install command.

2. Run the Install Command

Zuar Support will provide a single command to run on the server. It will look like this:

curl -sL https://raw.githubusercontent.com/zuarbase/portal-on-prem-installer/main/install-portal.sh \
  | sudo bash -s -- \
    --token <install-token> \
    --gist-url https://raw.githubusercontent.com/zuarbase/portal-on-prem-installer/main/install-portal.sh \
    --user <deploy-user> \
    --tls-cert

Flags

Flag Purpose
--token <install-token> One-time install token. Provided by Zuar and valid for 14 days.
--gist-url <url> Source URL of the install script. Provided by Zuar.
--user <deploy-user> The UID 1000 user created during server preparation.
--tls-cert Include only if you supplied a customer certificate. See step 4 of the system requirements.

Note: Use the exact command provided by Zuar Support. Do not substitute flag values unless your Zuar contact tells you to. Install tokens are single-use and expire after 14 days.

3. After Installation

When the script finishes, it prints:

  • The portal URL (HTTPS).
  • Admin credentials for first login.

Save these values, then open the portal URL in a browser and log in to confirm the install succeeded.

Note: If you did not supply a TLS certificate, the browser will show an "untrusted certificate" warning on first access. This is expected — the server is using a self-signed certificate. To remove the warning, supply a CA-signed certificate and re-run the installation with the --tls-cert flag.

Getting Help

If the install command fails or the portal does not come up, contact Zuar Support with:

  • The full output of the install command.
  • The output of check-requirements.sh from the same server.
  • The deploy user name and server hostname.