Configuration guide needed

[bcgov]

Configuration guide needed

[jujaga]

The custom-environment-variables.json file provides a complete mapping of ENV variables to the config that the node application will see, and the default.json provides generic defaults for all non-sensitive config values. If you do a search for config.get(...) on the repository, you'll get a sense of how the configuration variables are utilized.

If you are running this on a local machine, you'll need to create a local.json file the values you want set in the same directory as custom-environment-variables.json. For more information on how the config library loads and searches for environment variables, take a look at this article: https://github.com/lorenwest/node-config/wiki/Configuration-Files.

At an absolute bare minimum, you will want your local.json to at least have the following values defined:

{
  "frontend": {
    "keycloak": {
      "clientId": "REDACTED",
      "realm": "REDACTED"
    }
  },
  "server": {
    "keycloak": {
      "clientId": "REDACTED",
      "publicKey": "REDACTED",
      "realm": "REDACTED",
      "clientSecret": "REDACTED"
    },
    "logLevel": "debug",
    "morganFormat": "dev"
  }
}

You may need more configured depending on your own personal environments. Hope that helps.

[MGCataldo]

Thanks Jeremy.

Don't you think that the additional variables below are also necessary at a bare minimum?

• keycloak.serverUrl
• server.port
• server.keycloak.serverUrl

Best Regards

[jujaga]

Thanks Jeremy.

Don't you think that the additional variables below are also necessary at a bare minimum?

* keycloak.serverUrl

* server.port

* server.keycloak.serverUrl

Best Regards

Assuming you are using your own Keycloak provider, you will want to define your own keycloak.serverUrl and server.keycloak.serverUrl values instead of using one pre-defined for BCGov. The value server.port does not exist as that would be embedded as part of the serverUrls directly if necessary.

[MGCataldo]

Thank you Jeremy for your valuable support!

I'm using node since an year and this is my first time with "full-stack application which self-hosts the Vue frontend and consumes its API endpoint". I got really excited when I found this repository because it was exactly what I guess covers my needs for BioIngeenering laboratory I work .

I'm a bit confused with some of the configuration keys, I don't know exactly what to supply to the application.
I think that a description for them would help me and others to better understand and adopt the repository as valuable template
We use our instance of keycloack.

{
"frontend": {
"apiPath": "FRONTEND_APIPATH",
"basePath": "FRONTEND_BASEPATH",
"keycloak": {
"clientId": "FRONTEND_KC_CLIENTID",
"realm": "FRONTEND_KC_REALM",
"serverUrl": "FRONTEND_KC_SERVERURL"
}
},
"server": {
"apiPath": "SERVER_APIPATH",
"basePath" : "SERVER_BASEPATH",
"bodyLimit": "SERVER_BODYLIMIT",
"keycloak": {
"clientId": "SERVER_KC_CLIENTID",
"clientSecret": "SERVER_KC_CLIENTSECRET",
"publicKey": "SERVER_KC_PUBLICKEY",
"realm": "SERVER_KC_REALM",
"serverUrl": "SERVER_KC_SERVERURL"
},
"logFile": "SERVER_LOGFILE",
"logLevel": "SERVER_LOGLEVEL",
"morganFormat": "SERVER_MORGANFORMAT",
"port": "SERVER_PORT"
},
"serviceClient": {
"commonServices": {
"ches": {
"endpoint": "SC_CS_CHES_ENDPOINT"
},
"cdogs": {
"endpoint": "SC_CS_CDOGS_ENDPOINT"
},
"tokenEndpoint": "SC_CS_TOKEN_ENDPOINT",
"username": "SC_CS_USERNAME",
"password": "SC_CS_PASSWORD"
}
}
}

Thank you a lot
Best Regards
Maurizio