Usage¶

The ood-portal-generator tool takes a user-defined YAML configuration file and generates an Apache configuration file from the provided template file. This Apache configuration file can then be used in an Apache HTTP server to host an Open OnDemand portal.

The command that generates the Apache configuration file is given as:

bin/generate [OPTIONS]

At any point you can display a quick reference of the capabilities offered by bin/generate with:

$ bin/generate --help
Usage: generate [options]
    -c, --config CONFIG              YAML config file used to render template
    -t, --template TEMPLATE          ERB template that is rendered
    -o, --output OUTPUT              File that rendered template is output to
    -v, --version                    Print current version
    -h, --help                       Show this help message

Default:
  generate \
    -c /etc/ood/config/ood_portal.yml \
    -t /opt/ood/ood-portal-generator/templates/ood-portal.conf.erb

Options¶

-c <config>, --config <config>¶

the ood-portal-generator YAML configuration file

Default

/etc/ood/config/ood_portal.yml

Example

Use a local configuration file

bin/generate -c my_conf.yml

-o <output>, --output <output>¶

the Apache configuration file that is rendered

Default

piped to standard output

Example

Output Apache configuration file to local file

bin/generate -o my_portal.conf

-t <template>, --template <template>¶

the ERB template that is used to render the Apache configuration file

Default

use built-in template

Example

Use a custom ERB template for the Apache config (not recommended)

bin/generate -t my_portal.conf.erb