Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Server Installation

IZ Suite Server Installation

Container Modes

The IZ Suite server image starts different components depending on the FALCON_MODE environment variable:

FALCON_MODE

Components started

Typical use

all

Database migration, API, web UI on port 80 and a background worker

Default. Single-server installations and small clusters.

api

Database migration and API

Split deployments with separate web containers.

web

Web UI only

Split deployments.

worker

Background worker only (no port exposed)

Additional background-processing capacity. See Worker Nodes and the Server Work Queue.

Environment Variables

Variable
Required
Description

DATABASE_URL

Yes

PostgreSQL connection string, for example postgres://<USERNAME>:<PASSWORD>@<HOST>:<PORT>/<DB_NAME>. Append ?sslmode=require to connect over TLS.

FALCON_MODE

No

Container mode as described above. Default all.

SECRETS_ENCRYPTION_KEY

Yes

From 26.4.1. A 32-byte key written as 64 hexadecimal characters, for example generated with openssl rand -hex 32. Cloud credentials, secure settings, agent secrets and MFA secrets are encrypted with it. The server refuses to start without a valid key. Use the same value on every server container that shares the database, including worker containers. Never change it on an existing installation: stored credentials cannot be decrypted under a different key and would have to be re-entered.

AGENT_WRAPPER_SECRET

No

Shared secret that cloud agents present when they register themselves without a pre-created agent id. Required when running auto-registering (scaled) agents. See Agent Installation.

FALCON_SERVER_KEEP_ALIVE_SECONDS

No

Seconds after which a server node that stopped sending heartbeats is considered down and a new master is elected. Default 25. Relevant for cluster installations.

LOG_LEVEL

No

error, warn, info or debug. Default info.

Starting IZ Server - Using Docker

  1. Run the following command

  2. Replace FALCON_SERVER_VERSION with the latest version of the software. Latest version can be here. For example, if the latest version is v1.2.1, replace FALCON_SERVER_VERSION with 1.2.1

  3. Replace USERNAME,PASSWORD,HOST,PORT,DB_NAME with appropriate Database credentials and DB name SHELL> docker run -e DATABASE_URL=postgres://:@:/<DB_NAME> -p80:80 public.ecr.aws/h0h7r7j4/iz-suite-server:<ZSUITE_SERVER_VERSION>

  4. If there is any other process running on port 80, change the -p80:80 mapping. For example - to map to port 9000 change the -p80:80 to -p9000:80

  5. Once the container is up and running navigate to SERVER_IP in the browser. For example - http://localhost

Starting IZ Server - Using Docker Compose

  1. Save the below docker compose script in a file. For example: iz-server-docker-compose.yml

  1. Replace the value of FALCON_SERVER_VERSION with a valid server version

  2. Replace USERNAME,PASSWORD,HOST,PORT,DB_NAME with appropriate Database credentials and DB name

  3. Run the below command to start the server SHELL> docker compose -f iz-server-docker-compose.yml up

  4. NOTE: Use option -d to start the instance in background

  5. Once the container is up and running navigate to SERVER_IP in the browser. For example - http://localhost

Starting IZ Instance - with SSL

  1. Create a new directory called conf and file called server_ssl within the conf directory

  2. Copy the below contents to server_ssl file

  1. Make sure valid SSL certificates are copied to conf directory -

    1. tls.crt - CA signed certificated

    2. tls.key - Key used to generate the certificate

  2. Replace the value of IZSUITE_SERVER_VERSION with a valid server version

  3. Replace USERNAME,PASSWORD,HOST,PORT,DB_NAME with appropriate Database credentials and DB name

  4. Run the below command to start the server SHELL> docker run -e DATABASE_URL=postgres://:@:/<DB_NAME> -v $(pwd)/conf/server_ssl:/etc/nginx/sites-enabled/default -v $(pwd)/conf/tls.crt:/var/falcon/ssl/tls.crt -v $(pwd)/conf/tls.key:/var/falcon/ssl/tls.key -p80:80 public.ecr.aws/h0h7r7j4/falcon-suite:<FALCON_SERVER_VERSION>

  5. (Optional) Below is an example of running the same command using docker compose -

    1. Save the below docker compose script in a file. For example: iz-server-docker-compose.yml

    1. Run the below command to start the server SHELL> docker compose -f iz-server-docker-compose.yml up

    2. NOTE: Use option -d to start the instance in background

Once the container is up and running navigate to SERVER_IP in the browser. For example - https://localhost

From AWS Debian CIS Hardened Image

  1. Navigate to EC2 -> AMIs -> select IZ Suite CIS 1.x and click on Launch Instance from AMI

  2. Click on "Advanced details" and add the required configuration -

Key
Description
Required?

SERVER_VERSION

The latest version of IZ Server can be found here

Yes

AGENT_VERSION

The latest version of IZ Agent

Yes

PORT

Port on which the IZ Web should be exposed. Example 80 for http protocol and 443 for https protocol

Yes

PROTOCOL

Possible values http or https

Yes

CLOUD_WATCH_LOGS_GROUP

Optional AWS Cloud Watch group name where the IZ Suite logs should be redirected to. If this option is configured, make sure a new IAM role is created with AWS Service type, EC2 use case, CloudWatchAgentServerPolicy policy. Associate the same role to the EC2 Instance by navigating to Actions, Security, Modify IAM role

No

DB_URL

A valid Database url. Connection string example can be found below

Yes

  1. Example

See Also

Last updated

Was this helpful?