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
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
Run the following command
Replace
FALCON_SERVER_VERSIONwith the latest version of the software. Latest version can be here. For example, if the latest version is v1.2.1, replaceFALCON_SERVER_VERSIONwith1.2.1Replace
USERNAME,PASSWORD,HOST,PORT,DB_NAMEwith 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>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
Once the container is up and running navigate to
SERVER_IPin the browser. For example - http://localhost
Starting IZ Server - Using Docker Compose
Save the below docker compose script in a file. For example: iz-server-docker-compose.yml
Replace the value of
FALCON_SERVER_VERSIONwith a valid server versionReplace
USERNAME,PASSWORD,HOST,PORT,DB_NAMEwith appropriate Database credentials and DB nameRun the below command to start the server SHELL> docker compose -f iz-server-docker-compose.yml up
NOTE: Use option
-dto start the instance in backgroundOnce the container is up and running navigate to
SERVER_IPin the browser. For example - http://localhost
Starting IZ Instance - with SSL
Create a new directory called
confand file calledserver_sslwithin theconfdirectoryCopy the below contents to
server_sslfile
Make sure valid SSL certificates are copied to
confdirectory -tls.crt- CA signed certificatedtls.key- Key used to generate the certificate
Replace the value of
IZSUITE_SERVER_VERSIONwith a valid server versionReplace
USERNAME,PASSWORD,HOST,PORT,DB_NAMEwith appropriate Database credentials and DB nameRun 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>
(Optional) Below is an example of running the same command using docker compose -
Save the below docker compose script in a file. For example: iz-server-docker-compose.yml
Run the below command to start the server SHELL> docker compose -f iz-server-docker-compose.yml up
NOTE: Use option
-dto 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
Navigate to EC2 -> AMIs -> select
IZ Suite CIS 1.xand click onLaunch Instance from AMIClick on "Advanced details" and add the required configuration -
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
Example

See Also
Last updated
Was this helpful?

