Checklist Installation

The purpose of this document is to list common steps needed to install a Convier instance up until the creation of a project.

  • Obtain credentials for the Convier Docker registry (contact support@convier.com)
  • Determine the URL of the instance (e.g. https://convier.acme.com/convier)
    • The URL is later referred to as public_url
    • It has to end with /convier
    • The OIDC provider will require the URL to start with HTTPS and have a valid certificate
  • Create OIDC client (e.g. Enterprise Application in Azure)
    • Assign appropriate permissions (e.g. openid profile offline_access)
    • Copy client_id, client_secret and openid-configuration url
      • In Azure, the url looks like this: https://login.microsoftonline.com/<tenant_id>/v2.0/.well-known/openid-configuration
    • Add public_url as an accepted redirect URL for login
    • Create roles Task.Manage and Task.Read, assign users and groups to appropriate roles (users who will create projects and configure data collection and reporting should have Task.Manage)
  • Create App Service or Virtual Machine
    • Check network/firewall configuration to
      • Enable users to reach the installation
      • Enable the installation to communicate with the OIDC provider to authenticate users
      • Prevent external access
    • If Virtual Machine, obtain valid SSL certificate for URL, encode as PKCS#12 and add the entire chain as an envrionment variable called CERTBOT_FULL_CERT_CONTENT
      • If App Service, the certificate is managed by Azure
    • Enter Docker info
      • Platform: Linux
      • Docker repo: https://docker.convier.com
      • Obtained username and password
      • Image: convier:stable
  • Configure application
    • Consider whether to store configuration locally or in a database server
      • If external, prepare values for configuration variables
        • JDBC_CONNECTION_STRING
        • JDBC_USERNAME
        • JDBC_PASSWORD
    • See App Service Configuration for other required configuration
  • Consider enabling the sending of telemetry data to Convier
  • Consider enabling audit logging
  • Consider enabling report storage
  • Start or restart the App Service or Virtual Machine
  • Go to public_url and verify that you are able to log in and see an empty project list