Skip to content

Authoring Tool Configuration

Chuck Lorenz edited this page Mar 29, 2015 · 12 revisions

During installation of the Adapt authoring tool, a script is executed by running the command node install.

One task of the install script is to gather input for configuration variables. Below are the questions that you will encounter and comments that seek to clarify your input.

Tip:
Most configuration questions will appear with a default answer already in place. Most times you can simply accept the default value by pressing the Enter key. The only input you are required to provide are an email address and password for the super user account. The super user's email address and password will be used to login to the authoring tool.


Script Comment
This will install the Adapt builder. Would you like to continue? Y/n (Y) Y/n displays the acceptable input. You may type either Y or y or N or n. (Y) indicates that 'Y' is the default. To accept the default, do not type anything; simply press the Enter (or Return) key.
The Adapt framework was not found. It will be installed. The framework has not been installed yet. If you are rerunning node install, the framework was uninstalled earlier to prepare for a clean install at this time.

Clone from github was successful.
Running npm install for the Adapt framework.
Completed the npm install.
Installing plugins for the Adapt framework. Successfully installed Adapt framework plugins.

You will now be prompted to set configuration items. Just press enter to accept the default.

{ name: 'serverPort', type: 'number', description: 'Server port', pattern: /^[0-9]+\W*$/, default: 5000 }, { name: 'serverName', type: 'string', description: 'Server name', default: 'localhost' }, { name: 'dbType', type: 'string', description: 'Choose your database driver type (enter a number)' default: '1' }, { name: 'dbHost', type: 'string', description: 'Database host', default: 'localhost' }, { name: 'dbName', type: 'string', description: 'Master database name', pattern: /^[A-Za-z0-9_-]+\W*$/, default: 'adapt-tenant-master' }, { name: 'dbPort', type: 'number', description: 'Database server port', pattern: /^[0-9]+\W*$/, default: 27017 }, { name: 'dataRoot', type: 'string', description: 'Data directory path', pattern: /^[A-Za-z0-9_-]+\W*$/, default: 'data' }, { name: 'sessionSecret', type: 'string', description: 'Session secret', pattern: /^.+$/, default: 'your-session-secret' }, { name: 'auth', type: 'string', description: 'Choose your authentication method (enter a number)' default: '1' }, { name: 'useffmpeg', type: 'string', description: "Will ffmpeg be used? y/N", before: function (v) { if (/(Y|y)[es]*/.test(v)) { return true; } return false; }, default: 'N' }, { name: 'smtpService', type: 'string', description: "Which SMTP service (if any) will be used? (see https://github.com/andris9/nodemailer-wellknown#supported-services for a list of supported services.)", default: 'none' }, { name: 'smtpUsername', type: 'string', description: "SMTP username" }, { name: 'smtpPassword', type: 'string', description: "SMTP password", hidden: true }, { name: 'fromAddress', type: 'string', description: "Sender email address" }, { name: 'outputPlugin', type: 'string', description: "Which output plugin will be used?", default: 'adapt' } ];

Checking configuration, please wait a moment ...
You will now be prompted to enter details for the master tenant.

{ name: 'name', type: 'string', description: "Set a unique name for your master tenant", pattern: /^[A-Za-z0-9_-]+\W*$/, default: 'master' }, { name: 'displayName', type: 'string', description: 'Set the display name for your tenant', required: true, default: 'Master' }

Tenant already exists. It will be deleted."); return prompt.get({ name: "confirm", description: "Continue? (Y/n)", default: "Y" OR

Creating master tenant file system for " + (tenantName).blue + ", please wait ...
Master tenant " + (tenant.name).blue + " was created.

installing extensiontype plugins
installing componenttype plugins installing themetype plugins
installing menutype plugins

Create the super user account. This account can be used to manage everything on your Adapt builder instance.

{ name: 'email', type: 'string', description: "Email address", required: true }, { name: 'password', type: 'string', description: "Password", hidden: true, required: true }

Compiling the front end application, please wait a moment ...

Done, without errors.
The front end application was compiled.
Installation complete.
Run the command 'node server' (or 'foreman start' if using heroku toolbelt) to start your instance.
Bye!

Clone this wiki locally