Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The docker-compose.yaml which you downloaded requires some environmental variables to function .

...

All conatiners marked in RED are mandatory, rest are optional and needed only if respective tools are in use.

KnowHOW Specific Variables

MongoDB service

  • MONGO_INITDB_ROOT_USERNAME=<DB ROOT USER> (used for DDL comands within the application.)

  • MONGO_INITDB_ROOT_PASSWORD=<DB ROOT PASSWORD>(password for admin user)

  • MONGODB_APPLICATION_USER=<DB READ/Write User>

  • MONGODB_APPLICATION_PASS=<DB READ/WRITE PASSWORD>

CustomAPI

  • forgotPassword.uiHost=<DNS > (DNS of the Knowhow server)

  • corsFilterValidOrigin=<DNS> (DNS of the Knowhow server)

  • versionnumber=<Current version installed>

  • spring.data.mongodb.uri=<pass mongo db connection url in this format “mongodb://<DB USER NAME>:<DB PASSWORD>@mongodb:27017/kpidashboard“>

  • aesEncryptionKey=<aesEncryptionKey>(this is the passphrase for generating AES key, this can not be changed during lifetime of application)
    (min lenght - 8, sample value - 7DLHllMii14pId0FSSwGWwtga5dckGHW)

  • auth.secret=<auth secret>(this the passphrase used to generate sign jwt token)
    (min length -4, sample value - C0GNAIDS8upDNnkE)

  • isRepoToolEnable= <true for repotool(developer tab) enable or false for repotool disable>

  • JAVA_OPTS= <configuring Java runtime settings>

  • auth.subDomainCookie= <true for auth Auth service enable and false for auth Auth service disable>

  • auth.domain= <auth service is on then added to parent domain(required only when auth.subDomainCookie=true)>

  • auth.centralAuthBaseURL= <central auth UI Auth Backend DNS(required only when auth.subDomainCookie=true)>

  • exposed_api_key= < api key for the exposed kpi like repo tool, sample value:UvcP8HOTwcJVFR4DYVZZwwSh5p6dVue7DExY6m0nblPSIYGCl1K/c89oQMVD2nVqN1N443vkDofkROBFiHjDxw==> (required only when isRepoToolEnable=true)

  • mongock.start-system-version=<current version>
    mongock.end-system-version=9.x.0
    mongock.migration-scan-package=com.publicissapient.kpidashboard.apis.mongock.upgrade in case u are upgrading

UI service

  • DNS_SSL=<Your IP/DNS address>

  • API_HOST=<customapi backed host>

  • API_PORT= <port of api>

  • AUTHENTICATION_SERVICE= <true for central authentication service or false local authentication>

  • CENTRAL_LOGIN_URL= < url of central authentication service (required only when AUTHENTICATION_SERVICE=true) >

...

  • spring.data.mongodb.uri=<pass mongo db connection url in this format “mongodb://<DB USER NAME>:<DB PASSWORD>@mongodb:27017/kpidashboard“>

  • aesEncryptionKey=<aesEncryptionKey>(same Key as defined in CustomAPI)

AuthnAuth Specific Variables: Use Only When Deploying Knowhow with Auth Application

...

  • POSTGRES_USER=<DB ROOT USER>(Specify the Postgres user name)

  • POSTGRES_PASSWORD=<DB ROOT PASSWORD>(Specify the Postgres user password)

authnauth:

  • auth.baseUrl=< central <Central auth UI Backend url>

  • auth.baseUiUrl=<central auth UI url>

  • auth.secret=<auth secret>(this the passphrase used to generate sign jwt token)
    (min length -4, sample value - C0GNAIDS8upDNnkE)

  • forgotPassword.uiHost=<DNS > (DNS of the installation server)

  • auth.corsFilterValidOrigin= <DNS> (DNS of the installation server)

  • spring.datasource.password= < postgres db passowrd>

  • auth.holdingEntityId= <SAML entity ID>

  • auth.assertingEntityId = <SAML Url of the tenent ID>

  • auth.alias = <alias of the saml>

  • auth.samlLoginUrl= <login url saml>

  • spring.kafka.producer.bootstrap-servers= <kafka end point>

  • flag.mailWithoutKafka= <true for the smtp or false for the kafka>

  • auth.domain= <auth service is on then added to parent domain>

  • auth.holdingEntityId= <SAML entity ID>

  • auth.assertingEntityId = <SAML Url of the tenent ID>

  • auth.alias = <alias of the saml>

  • auth.samlLoginUrl= <login url saml>

authnauth-ui:

  • REACT_APP_DNS=<central auth frontend url> <Central Auth UI Url>

  • DNS_SSL=<UI DNS >

  • REACT_APP_PSKnowHOW= < knowhow frontend url>Knowhow UI Url>

Repotool:

PostgreSQL config:

...