Build.One Documentation
Page tree
Skip to end of metadata
Go to start of metadata

Each config file that you want to enable would require you to create a new .js file with the same name, based on the .example config..

config (required)

Base config options, such as port, moongodb host and dbname

  • <environment-name> - Environment type for which to use the configuration. Multiple environment configurations can be defined, Example: "local", "production"
    • root – Root path of the node-main server
    • host – Host name of the node-main server. For example on local: “localhost”
    • uploadDir – Directory where uploaded files are stored. Example: “d:/temp/uploads/”
    • secret – secret key that will be used to secure the express session.
    • port – Port that will be used by the node-main server.
    • [sessionTimeout] – session time to live, in seconds. Optional.
    • mongodb – Contains MongoDB configuration properties
      • host – host URI of the mongoDB server
      • dbname – database name
    • [headers] – additional headers to be used on node-main server responses. Optional.
    • [logfile] – express log file path. Optional.
    • jsdo - JSDO configuration
      • serviceURI – JSDO service URI
      • username – JSDO username
      • password – JSDO password

ad-config

Config used for setting up the ActiveDirectory Authentication

  • path – path for login authentication, ‘/login’ will setup a new http route at ‘ad/auth/login’ for authentication
  • url – LDAP server url
  • [bindDN] –  Admin connection DN, e.g. uid=myapp,ou=users,dc=example,dc=org. Optional. If not given at all, admin client is not bound, Giving empty string may result in anonymous bind when allowed.
  • [bindCredentials] – Password for bindDN. Optional.
  • searchBase – The base DN from which to search for users by username. E.g. ou=users,dc=example,dc=org
  • searchFilter – LDAP search filter with which to find a user by username, group, e.g. '(&(sAMAccountName={{username}})(memberOf=CN=OSIV-Ivdat,OU=OSIV,DC=de,DC=ivnet,DC=ch))'. Use the literal {{username}} to have the given username interpolated in for the LDAP search.

Related resources: LDAP Query Examples            

appdir-config

Config used for setting up the AppDirect Marketplace authorization

  • serviceURI – Service URI for the app direct, Example: “https://www.akiomacloud.de”
  • catalogURI – Catalog URI for the app direct, Example “Akioma.Swat.Integration.Provision.AppDirect”
  • username – username used for app direct service authentication
  • password – password used for app direct service authentication
  • path – where all the app direct routes will be defined on the node-main server
  • oauth_key – Public encryption key
  • oauth_secret – Private encryption key
  • oauth_signature – Encryption type
  • use_mocks – Use mocks for the controllers?
  • controllers – Controllers path

azure-config

Config used for setting up the AzureActiveDirectory Authentication

  • path - path for login authentication, '/login' will setup a new http route at 'auth/azure/login' for authentication
  • clientID - the clientID key required for the login. This will be automatically placed in the login request as a form paramenter
  • resource - your app id uri
  • clientSecret - When responseType is not id_token, we have to provide client credential to redeem the authorization code.
  • identityMetadata - The metadata endpoint provided by the Microsoft Identity Portal that provides the keys and other important information at runtime.
  • responseType - Must be 'code', 'code id_token', 'id_token code' or 'id_token'. For login only flows you can use 'id_token'; if you want access_token, use 'code', 'code id_token' or 'id_token code'.
  • responseMode - Must be 'query' or 'form_post'. This is how you get code or id_token back. 'form_post' is recommended for all scenarios.
  • redirectUrl - Must be a https url string, unless you set allowHttpForRedirectUrl to true. This is the reply URL registered in AAD for your app. Production environment should always use https for redirectUrl.
  • allowHttpForRedirectUrl - Required to set to true if you want to use http url for redirectUrl like http://localhost:3000.
  • validateIssuer - Required to set to false if you don't want to validate issuer, default value is true. We validate the iss claim in id_token against user provided issuer values and the issuer value we get from tenant-specific endpoint. If you use common endpoint for identityMetadata and you want to validate issuer, then you have to either provide issuer, or provide the tenant for each login request using tenantIdOrName option in passport.authenticate
  • issuer - This can be a string or an array of strings. See validateIssuer for the situation that requires issuer.
  • passReqToCallback - Required to set to true if using req as the first paramter in the verify function, default value is false. See section 5.1.1.3 for more details.
  • loggingLevel - Logging level. 'info', 'warn' or 'error'.
  • nonceLifetime - The lifetime of nonce in session in seconds. The default value is 3600 seconds.
  • nonceMaxAmount - The max amount of nonce you want to keep in session or cookies. The default number is 10.
  • clockSkew - This value is the clock skew (in seconds) allowed in token validation. It must be a positive integer. The default value is 300 seconds.

excel-config

Config used for importing and exporting of excel files.

  • formField – Name of the form field that contains the file for file upload.
  • [watchDirectory] – Directory that will be watched for file changes. Optional
  • Uploads – Configuration/s for specific upload paths
    • path – Directory path for the specific configuration
    • watchFilter – Regex file filter
    • businessEntity – Business Entity/Task that will be used for importing
    • invokeMethod – Name of the import method found within BE/BT
    • invokeParameterFormatter – Function for parsing file ‘records’ to proper parameter format of the invoke method
    • mandatoryFields – Mandatory field names.
    • [recordFormatter] – Function for formatting each record. Optional.
    • [mapping] – Maps file column fields to entity field names. Optional.

s3-config

Config for connecting to the S3 Bucket hosting

  • s3Host – host URI for s3 bucket hosting
  • s3Key – public key for connecting to s3
  • s3Secret – private key for connecting to s3

saml-config

Config for setting up the SAML Authentication (Single Sign-on)

  • path – path for saml authentication
  • entryPoint – saml server url
  • issuer - This can be a string or an array of strings. See validateIssuer for the situation that requires issuer.
  • [cert] – Certificate for SAML authentication. Optional.

dxf-config

Config file for the DocxFactory service primarily used for merging data and template to generate documents.

  • [key] - HTTP basic authentication key. Optional.
  • [secret] - HTTP basic authentication secret. Optional.

 

 

 

  • No labels