Skip to main content
Star us on GitHub Star

Console Deployment

Installation​

Install the Package​

The package installs the console files in /opt/openziti/share/console.

Install the console package
sudo apt install openziti-console

Or, configure the package repository and install with this one-liner.

Configure the package repository and install openziti-console
curl -sS https://get.openziti.io/install.bash | sudo bash -s openziti-console

Install from GitHub​

Console versions >= 3.0.0 from GitHub may be used.

  1. Download a release.

    wget https://github.com/openziti/ziti-console/releases/latest/download/ziti-console.zip

  2. Unzip in a directory that is mounted the controller's filesystem namespace.

    sudo mkdir -p /opt/openziti/share/console
    sudo unzip -d /opt/openziti/share/console ./ziti-console.zip

Configuration​

  1. In /var/lib/ziti-controller/config.yml, ensure you have an API binding zac on the same web listener where edge-management is bound. Ensure the location matches the path to the console files.

    - binding: zac
      options:
        location: /opt/openziti/share/console
        indexFile: index.html

  2. Restart the controller service if you edited the configuration.

    sudo systemctl restart ziti-controller.service

  3. Visit the controller's web address in a browser to access the console.

    https://ctrl.ziti.example.com:1280/zac/

  4. Console certificate option - The console is served from the controller's API and can be used with the default API certificate. The controller can be configured to present a different certificate for the console when the API is accessed by a distinct URL for the console. For more information about using alternative server certs with the controller, see: the configuration reference for the identity property.