Installation Script

Our installation script can be used interactively or non-interactively. The install.sh script will:

• create required databases
• create a new user account with limited access to the new databases
• configure and deploy the latest Helm chart

The following flags can be set:

• --pg-superuser - The connection string to Postgres with super-user access
• --valkey-icc - The URL for Valkey cache
• --valkey-apps - The URL for Valkey cache
• --prometheus - The URL for Prometheus, specifically for scraping
• --kube-context - Which kubernetes cluster to deploy to
• --public-url - The URL from which ICC will be accessed
• --gh-oauth-client-id/--github-oauth-client-id - Github OAuth
• --gh-oauth-client-secret/--github-oauth-client-secret - Github OAuth
• --google-oauth-client-id - Google OAuth
• --google-oauth-client-secret - Google OAuth

If any of these are not set, the script will prompt for the necessary information.

Prerequisites

This is information that will be necessary to complete the installation process.

PostgreSQL Super User Connection String

This is a connection string with super-user access. It is used to create the appropriate databases as well as a limited-access user. The connection string will be used with the new credentials inside of ICC.

Valkey

Platformatic supports the self-hosted version of Valkey or the Valkey variant of Elasticache. ICC has two cache systems which can use the same or different servers.

If Elasticache is in-use for --valkey-apps, the following flags must also be set:

--elasticache-role-arn <arn>
--elasticache-region <region>
--elasticache-cluster-name <name>

Note

More information about how we use the AWS SDK for Elasticache can be found in our Elasticache guide.

Kubernetes Context

The --kube-context flag can be left blank and a selection menu will be presented which uses information from ~/.kube/config.

Public URL

This is the URl which will be used to access the ICC Dashboard. The URL can be a subdomain or a path. Some examples:

• https://icc.mydomain.com
• https://mydomain.com/icc

OAuth credentials

At least one of Github or Google OAuth must be configured. This is used for accessing the ICC Dashboard. If neither is set, there will be an error when trying to load the Dashboard.

Download

Download the install script to review:

wget "https://raw.githubusercontent.com/platformatic/intelligent-command-center/refs/heads/main/scripts/install.sh" -O install.sh

Install

chmod +x install.sh
./install.sh