dispatcher-config-generator v0.0.3

Dispatcher Config Generator

Warning: This project is work in progress, so please contribute to work towards a first release if you like the idea. Make sure to read the CONTRIBUTING documentation.

Generate dispatcher configuration files from templates with YAML input.

Usage

When you install the tool the dispatcher-config-generator command should be available

npm install -g dispatcher-config-generator

To Generate the config files you should issue the dispatcher-config-generator command with the config folder containing the config yaml files. How these can be can be found in the configuration section.

dispatcher-config-generator -c config

Output will be generated in the output folder by default.

All options can be checked by passing the --help argument.

$ dispatcher-config-generator --help
Usage: -c <config-directory> [-o <output-directory>]

Options:
  --help        Show help                                              [boolean]
  --version     Show version number                                    [boolean]
  -c, --config  Path to config files                         [string] [required]
  -o, --output  Path to write output files to                           [string]

Configuration

Configuration of the dispatcher and the corresponding farms should be done using the following directory structure.

config/
├── dispatcher
│   └── config.yaml
└── farms
    └── default.yaml
    └── farm.yaml

The subfolders dispatcher and farms are fixed. The config file for the dispatcher should also be config.yaml For the farms you can choose an aribtrary name. When no name key is present in the config the filename will be used.

Dispatcher

Example yaml config file for the dispatcher configuration:

---
apache-log-level: dispatcher:warn
config-dir: conf
decline-root: Off
keep-alive-timeout: 60
log-level: warn
log-path: logs/dispatcher.log
name: dispatcher
pass-error: 0
ssi-no-cache: Off
use-processed-url: On

Farms

Example yaml config file for the dispatcher farm configuration:

---
allowed-clients:
- type: allow
  glob: "*"
cache-rules:
- type: deny
  glob: "*"
client-headers:
- "*"
filters:
- type: allow
  glob: "*"
invalidate:
- type: allow
  glob: "*"
priority: 0
renderers:
- hostname: localhost
  port: 4503
virtual-hosts:
- "*"