Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bdhoine/dispatcher-config-generator

AEM Dispatcher Config Generator
https://github.com/bdhoine/dispatcher-config-generator

adobe adobe-experience-manager aem apache configuration dispatcher generator

Last synced: 23 days ago
JSON representation

AEM Dispatcher Config Generator

Host: GitHub
URL: https://github.com/bdhoine/dispatcher-config-generator
Owner: bdhoine
License: gpl-3.0
Created: 2019-12-06T18:30:37.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-01-07T12:20:55.000Z (about 2 years ago)
Last Synced: 2024-12-17T15:49:06.878Z (about 1 month ago)
Topics: adobe, adobe-experience-manager, aem, apache, configuration, dispatcher, generator
Language: JavaScript
Size: 236 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# 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](CONTRIBUTING.md) documentation.

![Github Actions](https://github.com/bdhoine/dispatcher-config-generator/workflows/Build/badge.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bdhoine_dispatcher-config-generator&metric=alert_status)](https://sonarcloud.io/dashboard?id=bdhoine_dispatcher-config-generator)
[![Npmjs](https://img.shields.io/npm/v/dispatcher-config-generator?logo=npm&color=blue)](https://www.npmjs.com/package/dispatcher-config-generator)

Generate dispatcher configuration files from templates with YAML input.

## Usage

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

```sh
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.

```sh
dispatcher-config-generator -c config
```

Output will be generated in the [output](output) folder by default.

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

```sh
$ dispatcher-config-generator --help
Usage: -c [-o ]

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.

```txt
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:

```yaml
---
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:

```yaml
---
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:
- "*"
```