Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(KUI-1320): updated env variables and README #341

Merged
merged 2 commits into from
May 24, 2024
Merged

fix(KUI-1320): updated env variables and README #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bf987e
fix(KUI-1320): updated env variables and README
axelbjo May 23, 2024
7deb0aa
fix(KUI-1320): updated API_KEY to KURSINFO_API_KEY in a few missed spots
axelbjo May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .azure/prod.parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"secretNames": {
"value": [
"REDIS_URI",
"API_KEY",
"KURSINFO_API_KEY",
"KURSPLAN_API_KEY",
"SESSION_SECRET",
"SESSION_KEY",
Expand All @@ -25,7 +25,7 @@
"SERVER_HOST_URL": "https://www.kth.se",
"SERVICE_PUBLISH": "/student/kurser/kurs",
"SERVER_PORT": "3000",
"API_URI": "https://api.kth.se/api/kursinfo?defaultTimeout=60000",
"KURSINFO_API_URI": "https://api.kth.se/api/kursinfo?defaultTimeout=60000",
"CAS_SSO_URI": "https://login.kth.se",
"CM_HOST_URL": "https://www.kth.se/cm/",
"KOPPS_URI": "https://api.kth.se/api/kopps/v2/?defaultTimeout=60000",
Expand Down
4 changes: 2 additions & 2 deletions .azure/ref.parameters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"secretNames": {
"value": [
"REDIS_URI",
"API_KEY",
"KURSINFO_API_KEY",
karlandindrakryggen marked this conversation as resolved.
Show resolved Hide resolved
"KURSPLAN_API_KEY",
"KURS_PM_DATA_API_KEY",
"KURSUTVECKLING_API_KEY",
Expand All @@ -25,7 +25,7 @@
"SERVICE_PUBLISH": "/student/kurser/kurs",
"SERVER_HOST_URL": "https://www-r.referens.sys.kth.se/",
"SERVER_PORT": "3000",
"API_URI": "https://api-r.referens.sys.kth.se/api/kursinfo?defaultTimeout=60000",
"KURSINFO_API_URI": "https://api-r.referens.sys.kth.se/api/kursinfo?defaultTimeout=60000",
"CAS_SSO_URI": "https://login-r.referens.sys.kth.se",
"CM_HOST_URL": "https://www-r.referens.sys.kth.se/cm/",
"KOPPS_URI": "https://api-r.referens.sys.kth.se/api/kopps/v2/?defaultTimeout=60000",
Expand Down
31 changes: 8 additions & 23 deletions .env.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,16 @@
# If API_URI is omitted, "http://localhost:3001/api/kursinfo?defaultTimeout=10000" will be used
API_URI=https://api-r.referens.sys.kth.se/api/kursinfo?defaultTimeout=10000
# If API_KEY is omitted, default key 123489 will be used
API_KEY=[key]
KURSINFO_API_KEY=[Available in Azure KeyVault]

# If KURSPLAN_API_URI is omitted, http://localhost:3001/api/kursplan?defaultTimeout=10000 will be used
KURSPLAN_API_URI=https://api-r.referens.sys.kth.se/api/kursplan?defaultTimeout=10000
# If KURSPLAN_API_KEY is omitted, default key 5678 will be used
KURSPLAN_API_KEY=[key]
KURSPLAN_API_KEY=[Available in Azure KeyVault]

# If KURS_PM_DATA_API_URI is omitted, http://localhost:3001/api/kurs-pm-data?defaultTimeout=10000 will be used
KURS_PM_DATA_API_URI=https://api-r.referens.sys.kth.se/api/kurs-pm-data?defaultTimeout=10000
# If KURS_PM_DATA_API_KEY is omitted, default key 9876 will be used
KURS_PM_DATA_API_KEY=[key]
KURS_PM_DATA_API_KEY=[Available in Azure KeyVault]

# If KURSUTVECKLING_API_URI is omitted, http://localhost:3001/api/kursutveckling?defaultTimeout=10000 will be used
KURSUTVECKLING_API_URI=https://api-r.referens.sys.kth.se/api/kursutveckling?defaultTimeout=50000
# If KURSUTVECKLING_API_KEY is omitted, default key 1234 will be used
KURSUTVECKLING_API_KEY=[key]
KURSUTVECKLING_API_KEY=[Available in Azure KeyVault]

# If KOPPS_URI is omitted, https://api-r.referens.sys.kth.se/api/kopps/v2/?defaultTimeout=10000 will be used

APPLICATIONINSIGHTS_CONNECTION_STRING=[Azure, Application insights, connection string, can be found in Overview]
REDIS_URI=[connection string to redis]
REDIS_URI=[Available in Azure KeyVault]

# Connection Properties of UG Rest Api to fetch names of course staff
UG_REST_AUTH_API_TOKEN_URI=https://<LOGIN_HOST>/adfs/
UG_REST_AUTH_CLIENT_ID=<FROM AZURE KEYVAULT>
UG_REST_AUTH_CLIENT_SECRET=<FROM AZURE KEYVAULT>
UG_REST_AUTH_CLIENT_ID=[Available in Azure KeyVault]
UG_REST_AUTH_CLIENT_SECRET=[Available in Azure KeyVault]
UG_REST_API_URI=https://<UG_URL>
UG_REST_API_SUBSCRIPTION_KEY=<FROM AZURE INTEGRAL OR KEYVAULT>
UG_REST_API_SUBSCRIPTION_KEY=[Available in Azure Integral or KeyVault]
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ Kursinfo-web fetches data from:

### Secrets for Development

Secrets during local development are stored in a `.env` file in the root of your project. This file should be in `.gitignore`. Template for `.env` with all needed environment variables are available in the `env.in` file.

Secrets (names, passwords, keys, and uri:s) for dev and prod are stored in the the course information project’s Azure key vault.
Secrets during local development are stored in a gitignored `.env` file (`env.in` can be used as template for your `.env` file). More details about environment variable setup and secrets can be found in [confluence](https://confluence.sys.kth.se/confluence/x/OYKBDQ).

## For Development

Expand Down
12 changes: 6 additions & 6 deletions config/serverSettings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ const {
const devPort = devDefaults(3000)
const devSsl = devDefaults(false)
const devUrl = devDefaults('http://localhost:' + devPort)
const devInnovationApi = devDefaults('http://localhost:3001/api/kursinfo?defaultTimeout=10000') // required=true&
const devKursplanApi = devDefaults('http://localhost:3001/api/kursplan?defaultTimeout=10000')
const devKursInfoApi = devDefaults('http://api-r.referens.sys.kth.se/api/kursinfo?defaultTimeout=10000') // required=true&
const devKursplanApi = devDefaults('http://api-r.referens.sys.kth.se/api/kursplan?defaultTimeout=10000')
const devKoppsApi = devDefaults('https://api-r.referens.sys.kth.se/api/kopps/v2/?defaultTimeout=10000')
const devKursPmDataApi = devDefaults('http://localhost:3001/api/kurs-pm-data?defaultTimeout=10000')
const devKursutvecklingApi = devDefaults('http://localhost:3001/api/kursutveckling?defaultTimeout=10000') // required=true&
const devKursPmDataApi = devDefaults('http://api-r.referens.sys.kth.se/api/kurs-pm-data?defaultTimeout=10000')
const devKursutvecklingApi = devDefaults('http://api-r.referens.sys.kth.se/api/kursutveckling?defaultTimeout=10000') // required=true&
const devTimeTableApiUri = devDefaults('https://api-r.referens.sys.kth.se/api/timetable/v1/?defaultTimeout=10000')
const devSessionKey = devDefaults('kursinfo-web.sid')
const devSessionUseRedis = devDefaults(true)
Expand All @@ -42,14 +42,14 @@ module.exports = {

// API keys
apiKey: {
kursinfoApi: getEnv('API_KEY', devDefaults('123489')),
kursinfoApi: getEnv('KURSINFO_API_KEY', devDefaults('123489')),
kursplanApi: getEnv('KURSPLAN_API_KEY', devDefaults('5678')),
kursPmDataApi: getEnv('KURS_PM_DATA_API_KEY', devDefaults('9876')),
kursutvecklingApi: getEnv('KURSUTVECKLING_API_KEY', devDefaults('1234')),
},

nodeApi: {
kursinfoApi: unpackNodeApiConfig('API_URI', devInnovationApi),
kursinfoApi: unpackNodeApiConfig('KURSINFO_API_URI', devKursInfoApi),
kursplanApi: unpackNodeApiConfig('KURSPLAN_API_URI', devKursplanApi),
kursPmDataApi: unpackNodeApiConfig('KURS_PM_DATA_API_URI', devKursPmDataApi),
kursutvecklingApi: unpackNodeApiConfig('KURSUTVECKLING_API_URI', devKursutvecklingApi),
Expand Down
Loading