Setup

Rodan Client requires very little setup to get started. Only two files need to be managed:

• rodan-client/configuration.json

• rodan-client/js/Plugins.js When Rodan Client is cloned, these files do not yet exist. Instead, there is:

• rodan-client/configuration.json.example

• rodan-client/js/Plugins.js.example First, we need to copy these files without the .example extension.

user@computer:~/rodan-client$ cp configuration.json.example configuration.json
user@computer:~/rodan-client$ cp js/Plugins.js.example Plugins.js

Next, we need to make small edits to each.

configuration.json

At a minimum, we need to tell Rodan Client where the Rodan server is and how to connect to it.

• SERVER_HOST: This is the host name of the Rodan server you want the client to interact with. For example, if the server was at IP 123.456.789.1, you would set "SERVER_HOST": "123.456.789.1".

• SERVER_PORT: This is the port for connecting to the Rodan server.

• SERVER_HTTPS: The client will connect to the server using HTTPS iff SERVER_HTTPS is true. Else, HTTP will be used (not recommended).

• SERVER_AUTHENTICATION_TYPE: This tells the client which authentication type to use - token or session. Token is recommended, but it depends on the Rodan server. For example, if the server uses token authentication, you would set "SERVER_AUTHENTICATION_TYPE": "token".

Note: The WORKFLOWBUILDERGUI settings in configuration.json are the settings for the Workflow Builder GUI plugin. This plugin is discussed below.

js/Plugins.js

Rodan Client comes with a plugin that allows a user to create and edit Workflows via a GUI, the Workflow Builder GUI. js/Plugins.js lets Rodan Client know what plugins exist and where the are located. For a standard Rodan Client install, no modifications need to be made to js/Plugins.js. However, if you wish to add plugins in the future, this file will have to be modified.