Setup

App Configuration

Overview

The config/appConf.js file defines many aspects of how the system will run.

appConf.js

This repo comes with several config/*.sample.js files; copy each of them over to config/*.js e.g. config/adobe.js and update the values with local variables and API keys as indicated by the comments in the file.

Request API keys from LibCal and Adobe. You will enter these values in the configs described below.

• config/appConf.js:

  • cryptoConfig: The value defined here will be used as an encryption key to keep any anonymized data encrypted, while keeping values consistent so you can identify the number of distinct users of the system over time. Change the cryptoConfig.secret value to any random long string when you set up the app. You should not change it afterwards.

  • admin: setup of the admin web console, including authentication details, port number, and server information.

    • onServer: use false for running over http://localhost, true for https:// on a server

    • server: https key/cert pair

    • port: port on which Express will listen for web calls; default is 3010

    • requireLogin: whether or not to require Google login for users to access the admin web console. Only set this to false when running on localhost and/or for debugging purposes. Should be set to true in production.

    • allowedUsers: array of permitted users; if requiredLogin: true, user email must be included in this array to access the web admin console.

    • apiKey: This is the API key required to access the API that powers the admin web console. Make this value up for yourself, the app uses it to authenticate to its own API. You will only need it if you want to connect to the web admin console API externally.

    • hostname: set to 'localhost' or the server address without protocol (e.g. 'sc.lib.myorg.edu')

    • googleClientId: create a googleClientId from the Google Develop Console: https://console.developers.google.com/apis/credentials

    • googleClientSecret: this will be generate when you generate the googleClientId

    • authCallback: you will set this value in the Google Developer Console. Set it to a value like 'http://localhost:3010/google/callback' or 'https://sc.lib.yourorg.edu:3010/google/callback' -- use the server and port you've specified above + '/google/callback'.

  • db_connection: mongodb connection string (optional; used for caching converted email aliases)

  • logLevels: for each level, set one of: false, 'daily', 'monthly'; false for no logs at that level; 'daily' for logs that start a new logfile each day; 'monthly' for a new logfile per year. Use daily logs for levels that output obnoxiously large amounts of data like 'debug'. Currently, only 'info','error', and 'debug' are used by the app.

  • emailConverter: LibCal may accept users' aliased email addresss (e.g. [e-mail]) even though license providers may only use the uniqueId version of a user Id (e.g. [e-mail]). If your organization has an API that will convert email aliases to the uniqueId/authoritative email address, use these settings to configure the use of the API.

    • .active: When emailConverter.active: true, the app will look up each user email and get the authoriative username. In order for this to work, your organization will need a public API to perform this service.

    • .baseUrl and .endOfUrl: In the emailConverter settings use the baseUrl and endOfUrl properties to establish the query URL for that api. (You may not need endOfUrl but it is provided in case the needed query does not end with the user's email, e.g. "https://fake.org/api/email/[e-mail]/convert" would use baseUrl: 'https://fake.org/api/email/' and endOfUrl: 'convert')

    • .objectPropForReturnValue: the name of the property in the API's return value needed to access the uniqueId, e.g. data.user.uid

    • .affixSuffixToReturn: true/false; indicates whether the value returned by the API will need to have an email "@..." added to it to create a valid email address. If the API returns '[e-mail]' then set affixSuffixToReturn: false because the email address is complete. If the API just returns 'user', set affixSuffixToReturn: true so the app knows to append the rest of an email address.

    • .suffix: the string to be appended to the unique Id returned by the API, e.g. @fake.org

  • software: array of objects describing the connections between LibCal's names for the software and the related vendor permissions groups. One object per license group package; potentially multiple objects/license groups per vendor.

    • .active: true/false: is this license currently being used/checked by the software

    • .vendor: Software license vendor. Current allowed values: 'Adobe', 'Jamf'

    • .libCalName: LibCal equipment category name (this is for human readability, not for the app)

    • .libCalCid: LibCal CategoryID for the group (used by the app)

    • .vendorGroupName: license group name (used by Adobe)

    • .vendorGroupId: license group id (used by Jamf and Adobe)