import Config from 'tsugi-node/src/config/Config.js'

public class | source

Config

This is a sample of the configuration file. Copy this to Config.js in the top directory and edit all the values to set your Tsugi configuration.

Calling sequence in a NodeJS app:

 var config  = require('tsugi-node/src/core/Config'),
     CFG     = new Config ();
 var Tsugi   = require('tsugi-node/src/core/Tsugi');

 launch = Tsugi.requireData(CFG, req, res, session, Tsugi.ALL);
 if ( launch.complete ) return;

Constructor Summary

Public Constructor
public	constructor(configuration: Object)

Member Summary

Public Members
public	LTI: *
public	OFFLINE: boolean Effectively an "airplane mode" for the appliction.
public	dbhost: string The host name, it could be an IP address or a name.
public	dbname: string The database name.
public get	dbpass: string The database password (encrypted)
public	dbport: number The database port.
public	dbprefix: string The dbprefix allows you to give all the tables a prefix in case your hosting only gives you one database.
public get	dbuser: string The database user (encrypted)
public	maildomain: boolean Where the bulk mail comes from - should be a real address with a wildcard box you check.
public	maileol: string Mail end of line - Depends on your mailer - may need to be \r\n By default: '\n'
public get	mailsecret: string The mail secret (encrypted)
public	noncecheck: number Set the nonce clearing check proability By default: 100
public	noncetime: number Set the nonce expiry time By default: 1800
public	pdox: *
public	sessionsalt: string This is used to make sure that our constructed session ids based on resource_link_id, oauth_consumer_key, etc are not predictable or guessable.
public	staticroot: string You can use the CDN copy of the static content in testing or light production.
public get	staticrootDir: * Returns the local directory where client libraries are.
public	timezone: string The desired timezone.
public	unitTesting: boolean Unit testing flag By default: false
public	universal_analytics: boolean
public	wwwroot: string This is the URL where the software is hosted Do not add a trailing slash to this string

Public Constructors

public constructor(configuration: Object) source

Params:

Name	Type	Attribute	Description
configuration	Object	optional	Object to initialize the public properties with alternative values. Look at public properties to see which properties can be overrided.

Example:


var config = new Config ({
    'dbport': '3306',
    'dbhost': 'mydomain.com'
 });

Public Members

public LTI: * source

public OFFLINE: boolean source

Effectively an "airplane mode" for the appliction. Setting this to true makes it so that when you are completely disconnected, various tools will not access network resources like Google's map library and hang. Also the Google login will be faked. Don't run this in production. By default: false.

public dbhost: string source

The host name, it could be an IP address or a name. By default: '127.0.0.1'

public dbname: string source

The database name. By default: 'tsugi'

public get dbpass: string source

The database password (encrypted)

public dbport: number source

The database port. By default: '8889'

public dbprefix: string source

The dbprefix allows you to give all the tables a prefix in case your hosting only gives you one database. This can be short like "t_" and can even be an empty string if you can make a separate database for each instance of TSUGI. This allows you to host multiple instances of TSUGI in a single database if your hosting choices are limited. By default: '' empty.

public get dbuser: string source

The database user (encrypted)

public maildomain: boolean source

Where the bulk mail comes from - should be a real address with a wildcard box you check. By default: false

public maileol: string source

Mail end of line - Depends on your mailer - may need to be \r\n By default: '\n'

public get mailsecret: string source

The mail secret (encrypted)

public noncecheck: number source

Set the nonce clearing check proability By default: 100

public noncetime: number source

Set the nonce expiry time By default: 1800

public pdox: * source

public sessionsalt: string source

This is used to make sure that our constructed session ids based on resource_link_id, oauth_consumer_key, etc are not predictable or guessable. By default: warning:please-change-sessionsalt-xxxx'

public staticroot: string source

You can use the CDN copy of the static content in testing or light production. If you check out a copy of the static content locally and do not want to use the CDN copy (perhaps you are on a plane or are otherwise not connected) change this configuration. By default: /tsugi-static

public get staticrootDir: * source

Returns the local directory where client libraries are. Only if the staticroot is not an CDN address

public timezone: string source

The desired timezone. By default: Pacific/Honolulu

public unitTesting: boolean source

Unit testing flag By default: false

public universal_analytics: boolean source

public wwwroot: string source

This is the URL where the software is hosted Do not add a trailing slash to this string