Environment setup¶
This page explains how to set up Decompose locally by using Docker. It covers the installation flow, the containers included in the standard deployment, and the main configuration values you may need to review. Use it as your baseline reference when preparing a local or project-specific environment.
Installation steps¶
Follow these steps in order to install the product and bring up the local services successfully. The sequence covers licensing, Docker prerequisites, registry access, and the initial startup flow. Review the notes in each step carefully because later features depend on a complete and healthy environment.
Step 1:
Obtain a valid Decompose license by reaching out to amiproductsupport@deloitte.com.
Step 2:
Install Docker for your respective operating system:
Step 3:
Open a command prompt and log into the GitLab container registry:
Info
This login step only needs to be executed once as your login credentials will be stored on your system.
Step 4:
To download and start the Decompose Docker containers, save the docker-compose.yaml file that was delivered in the Decompose release email to your local file system.
Step 5:
Place the license file innowake.lic (see step 1) into the same directory as the docker-compose.yaml.
Step 6:
Execute the following command in the same directory where the docker-compose.yaml resides:
For large customer projects, the default settings for Java heap sizes need to be adjusted.
The memory settings for db-cutter-service have to be adapted by adding an environment entry in the docker-compose.yaml, for example:
Docker Desktop also requires sufficient memory allocation.
Step 7:
Once the docker-compose command has finished, the Decompose can be accessed via your browser: http://localhost:5001/
The default user credentials are username "TruNorth Decompose" and password "password".
Docker containers¶
The standard Docker Compose package starts several containers that together provide the UI, backend services, identity management, storage, and messaging components. Understanding the role of each container helps you troubleshoot startup issues and size the environment appropriately. The following table summarizes the containers included in the default setup.
The following containers are pulled via the docker-compose.yaml:
| Container | Description |
|---|---|
| db-cutter-service | The core of the Unified Cutter. This spring boot application contains all the logic for importing data, processing data and providing data (REST API). |
| db-cutter-ui | The web server hosting the Blazor web UI of the Unified Cutter (interface to the end user). |
| keycloak | The service used for authentication and IAM (Identity and Access Management). This involves the login to the Unified Cutter, maintaining group privileges etc. |
| pgadmin | The UI for accessing the postgres database (only required for administrative purposes) |
| postgres | The relational database used to store the uploaded data (modules, queries, bounded contexts etc), project information and generated data which is produced by the Unified Cutter. |
| postgres-keycloak | The database used by the keycloak container to store IAM data. |
| redis | Needed by the db-cutter-service. It is used for storing temporary update data which can by fetched by clients (like progress updates for an import task). |
| Kafka | Apache Kafka is an open-source distributed event streaming platform. Used for event sharing, client and project CRUD events and logics will be managed by separate service, UI services will raise events to get request payloads and send back the response via Kafka topics. |
| MinIO | MinIO is a high-performance, S3 compatible object store. It is used for storing traced application logs. |
| Zookeeper | ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. It is used for Kafka management. |
The list of backend server variables:
| Environment Variables | Definition/Description | Default Value | Format |
|---|---|---|---|
| DECOMPOSE_SERVER_PORT | Server port configuration with default value | 8080 | String |
| POSTGRES_URL | Database URL with default value | jdbc:postgresql://postgres:5432/dbcutter | String |
| POSTGRES_USER | Database username with default value | root | String |
| POSTGRES_PASSWORD | Database password with default value | Worx2000 | String |
| KAFKA_BOOTSTRAP_SERVERS | Kafka bootstrap servers with default value | kafka:29092 | String |
| USE_REDIS_AS_CACHE | Use Redis as cache with default value | true | String |
| REDIS_HOST | Redis host with default value | redis | String |
| REDIS_PORT | Redis port with default value | 6379 | String |
Types of roles¶
Decompose uses role-based access to separate administration, editing, and read-only activities. Knowing these roles helps you assign permissions that match each team member's responsibilities without granting unnecessary access. The table below summarizes the default role definitions.
| Role Name | Description |
|---|---|
| Manager | The Manager role has full access to the projects he was granted access to, can create new projects, can import data, can do manual edits, and add or remove viewers and/or editors to clients and projects they have access to. |
| Editor | The Editor role has access to the clients and projects they have access to, manual editing capabilities, and can import data. |
| Viewer | The Viewer role has read-only access to the clients and projects assigned to them and can view and export reports. |
Types of cache¶
There are two types of caches, a redis cache and an in-memory cache. The redis cache is the default and requires the redis container to get started. Both types of cache are used by the Decompose Service and Decompose UI. The in-memory cache was only added as a fallback strategy for situations in which the client does not want to use redis as a cache.
For the Decompose Server, we have a property called redis.use-redis-as-cache in our application.yaml file. To change the value, you can either edit the file inside the jar or start the Decompose Service with the following arguments:
-Dspring-boot.run.arguments="-redis.use-redis-as-cache=false".
We have an EnvironmentVariable.cs to change the cache behavior for the Decompose Service.
For the Decompose Client, we have a property called UseRedisAsCachein our appsettings.json file. To change the value you can either edit the file or set the environment variable Redis:UseRedisAsCache=false.
Environment variable¶
Frontend behavior is controlled through environment variables that define service endpoints, authentication settings, caching, and optional AI integrations. Review these values when you deploy the UI in a new environment or need to change defaults for an existing installation. The following table lists the available frontend variables and their purpose.
Below are the list of frontend variables:
| Environment Variables | Definition | Default Value | Format |
|---|---|---|---|
| DB_CUTTER_BACKEND_URL | It stores the URL where the UI-Server can find the backend service | http://db-cutter-service:5080/ | String |
| DB_CUTTER_APP_BASE_PATH | The base path of the application | / | String |
| REDIS_HOST | The host name of the redis server | redis | String |
| REDIS_PORT | The port of the redis server | 6379 | String |
| DB_CUTTER_USE_REDIS_AS_CACHE | True to enable redis as cache – otherwise in-memory cache is used | TRUE | String |
| DB_CUTTER_AUTHORITY | The oauth authority server from UI perspective | http://localhost:28080/realms/Phaidon-realm | String |
| DB_CUTTER_AUTHORITY_INTERNAL | The oauth authority server from server perspective | http://keycloak:8080/realms/Phaidon-realm | String |
| DB_CUTTER_RESPONSE_TYPE | The oauth response type, for example. “code” | code | String |
| DB_CUTTER_CLIENT_ID | The client id for keycloak, for example. “db-cutter” | db-cutter | String |
| DB_CUTTER_REDIRECT_URL | The redirect URL, where Keycloak sends an authenticated user | http://localhost:5001/ | String |
| DB_CUTTER_AUDIENCE | The Keycloak audience, for example, account | account | String |
| DB_CUTTER_ISSUER_ADDRESS | The Keycloak issuer address | http://localhost:28080/realms/Phaidon-realm/protocol/openid-connect/auth | String |
| DB_CUTTER_CONNECTIONSTRING | The connection string to the postgres database | Host=postgres;Database=dbcutter;Username=root;Password=Worx2000 | String |
| GEN_AI_AZURE_URI | The URI of the GPT instance | https://iw-dev-ai.openai.azure.com/ | String |
| GEN_AI_AZURE_KEY_CREDENTIAL | The ApiKey for GPT | 0004abba388e400492a1c65429d9c42b | String |
| GEN_AI_DEPLOYMENT_NAME | The deployment name of the GPT model, for example, gpt-4-32k. | "gpt-35-turbo" or "gpt-4-32k" or "gpt-4o" | String |
| GEN_AI_INFERENCE_TEMPERATURE | The inference temperature for GPT | 0.7 | String |
| GEN_AI_MAX_TOKENS | The maximum number of tokens returned by GPT | GPT3.5: 2k, for GPT4-32k: 10k, for GPT4o: 4k | String |
| GEN_AI_IS_GEN_AI_ENABLED | True to enable GenAI, else the Generator section in the UI is not shown. | TRUE | String |
| GEN_AI_TYPE | The type of GenAI that is used to generate content: “default” or “LlmService” | default or LlmService | String |
| LLM_SERVICE_SERVICE_ADDRESS | The URL of the LlmService container | "http://llmservice:8000" or "https://appmodil.deloitte.com/genai/staging/llm-service" | String |
| LLM_SERVICE_PLUGIN | The llm service plugin, for example. “azure gpt 3.5” or “azure gpt 4”. Must match a plugin that is configured in the LlmService container | "azure gpt 3.5" or "azure gpt 4" or "azure gpt omni" | String |
| LLM_SERVICE_INFERENCE_TEMPERATURE | The llm service inference temperature | 0.7 | String |
| LLM_SERVICE_MAX_TOKENS | The maximum number of tokens returned by the LlmService | for GPT3.5: 2k, for GPT4-32k: 10k, for GPT4o: 4k | String |
| DB_CUTTER_MIGRATE_DB_ON_STARTUP | Indicates whether this webserver will migrate the database schema to the current version on startup (true/false) | TRUE | String |
| DB_CUTTER_MIGRATE_DB_USER | The name of the database user that will become the owner of all migrated tables, that is, replaces ${flyway:user} | root | String |
| GEN_AI_DEPLOYMENT_NAME_EMBEDDING | The deployment name of the GPT model for embeddings, for example, gpt-4-32k | text-embedding-ada-002 | String |
| GEN_AI_EMBEDDING_MODEL | The embedding model to be used | text-embedding-ada-002 | String |
| QDRANT_HOST | qdrant | String | |
| QDRANT_PORT | 6334 | String | |
| QDRANT_SCORE_THRESHOLD | 0.5 | String | |
| IS_SEMANTIC_SEARCH_ENABLED | TRUE | String | |
| QDRANT_VECTOR_SIZE | 1536 | String | |
| QDRANT_RESULT_LIMIT | 1000 | String | |
| GEN_AI_STORE_TOKEN_USAGE | True to log all prompts for GenAi and used tokens in the database | FALSE | String |
| KAFKA_BOOTSTRAP_SERVER | The KAFKA_BOOTSTRAP_SERVER | kafka:29092 | String |
| KAFKA_CONSUMER_GROUP_ID | The KAFKA_CONSUMER_GROUP_ID | integration-group | String |
| INNOWAKE_SSL_DISABLE | To disable the SSL certificate check, set this variable to true | FALSE | String |