Self hosting

You can host the new web client using a ready-to-use Docker image. This guide provides instructions for its use, along with details on its functionality and the prerequisites needed.

• Where can I find the Docker image?

  • The Docker image is available in our image registry. You can find it at crncdeployment.azurecr.io/web-app-ng:main.

    • From version 1.25 and forward version specific will also be available by tag in format of: crncdeployment.azurecr.io/web-app-ng:1.25

• What components does the docker image contain?

  • The image includes two components:

    • All static files associated with the web client.

    • An NGINX web server, already configured to accurately serve the static files.

• Hosting options (choose between):

  • HTTP-based hosting, allowing connections to flow servers via HTTP.

  • HTTPS-based hosting, a secure method requiring the server to employ HTTPS, thus enhancing security (recommended).

• Suggested Proxy Configuration:

  • It's recommended to set up an extra proxy layer before the NGINX web server in our image. This step enables customization of the security settings to suit your IT infrastructure requirements.

• Exposed Port:

  • The bundled NGINX operates exclusively over HTTP on port 80, which needs to be exposed to any port of your choosing.

For a secure connection between the client and server, it is strongly advised to run it over HTTPS. This not only ensures security but also allows you to fully leverage the service-worker, which the new web client utilizes for caching. To explore more about the service-worker, visit: Mozilla Developer Network - Service Worker API.

You can pre-define a server by configuring the environment variable ´SERVER_ADDRESS` of the container. This will pre-fill the desired flow server for the end user to connect to (Supported from version v1.23 and above)

The content served by our image should always be delivered as is, without any automatic compression. If the content is not served correctly, the client will fail to start due to security integrity checks.