CTIMS Environment variables

CTIMS depends on many environment variable for its configuration. They are stored in the .env file. The same .env file is used for both frontend and backend containers

Environment variables for CTIMS Backend

#Matchminer MySql database URL

DATABASE_URL=mysql://ctims:ctims@localhost:3306/ctims

KEYCLOAK_URL=http://localhost:4000/auth

KEYCLOAK_CLIENT_ID=ctims

# Keycloak client uuid. This is different from the id above.

# If you cannot find it in the client settings, the URL usually includes it. Example: http://localhost:8080/admin/master/console/#/ctims/clients/4565411a-***/settings, 3813811a-*** is the uuid

KEYCLOAK_CLIENT_UUID=d654ed51-7032-4389-8811-4d588d3181be

# new realm created for CTIMS

KEYCLOAK_REALM=Ctimsorg

# This is the client secret that stored under the Credentials tab in the client page.

# The realm needs to have client authentication enabled to see the Credentials tab.

KEYCLOAK_CLIENT_SECRET=TRlkjl987PmBPjr3wxyJcROIRCDsBFF

# ctimsadmin client with service account enabled

# It does not need to be a separate client. If ctims client already has service account enabled, use the same ID here.

KEYCLOAK_ADMIN_CLIENT_ID=ctimsadmin

KEYCLOAK_ADMIN_CLIENT_SECRET=Plkjlkj988nMwqfzZhLmqErM4LeGbVbK6

# This is the keycloak endpoint to get access token.

KEYCLOAK_TOKEN_ENDPOINT=http://localhost:4000/auth/realms/Ctimsorg/protocol/openid-connect/token

#if CTIMS is integrated with Matchminer then it can communicate with Matchminer API

MM_API_URL=http://localhost:5001/api

MM_API_TOKEN=r6ufuf6g-40ce-47b9-85f5-10e99f3043b5

#PRISMA key for saving CTML to Matchminer Mysql database

PRISMA_FIELD_ENCRYPTION_KEY=k1.aesgcm256.KJHKJ989089l5OKXUYQosqNLMRK1Nc3PicRp5iWa6I7Ko=

CTIMS_ENV=development

CTIMS_API_VERSION=2.1

#if CTIMS is integrated with Matchminer then it can send CTMLs to Matchminer using Rabbit MQ

RABBITMQ_URL='localhost'

RABBITMQ_PORT=5672

MATCHMINER_SEND_QUEUE='run_match'

MATCHMINER_RECEIVE_QUEUE='match_message'

Environment variables for CTIMS Frontend

#Backend API URL

REACT_APP_API_URL=http://localhost:3333/api

NEXTAUTH_API_URL=http://localhost:3333/api

#Frontend URL

NEXTAUTH_URL=http://localhost:3000

NEXT_PUBLIC_SIGNOUT_REDIRECT_URL=http://localhost:3000

Last updated