The Setup Tool

The CUE Front setup tool is intended to simplify the configuration of the CUE Front components. Currently, setup only supports Docker-based installations. setup is a command line tool that runs in a Docker container.

If you don't use setup, then configuring CUE Front involves editing a number of different configuration files. In some cases, the same value must be specified in several places, both within the same file and in different files. It is relatively easy to make mistakes during this process. setup simplifies this task by issuing a series of prompts and using your responses to generate all these files. The tool carries out this task in two phases:

add: Prompt for values, create a configuration set folder and save the responses in a blueprint.yaml file in the folder (cue-front/configuration-name/blueprint.yaml, for example).
generate: Generates a set of configuration files by merging the responses in cue-front/configuration-name/blueprint.yaml with the default configuration files in the cue-front/setup/defaults folder. The generated configuration files are saved together with blueprint.yaml in the configuration folder.

setup has two corresponding subcommands that execute these phases:

add: Executes the add and generate phases for a named configuration set.
generate: Executes the generate phase for a named configuration set.

In addition to add and generate setup has the following subcommands:

login: Prompts for the credentials needed to download software from Stibo DX's repositories.
edit: Lets the user modify an existing configuration set.
list: Lists the names of all available configuration sets.
help: Displays a short help message listing setup's subcommands.

The setup command must always be run in the cue-front folder.