README.md

AxoSyslog CFG Helper

This tool makes configuring AxoSyslog a bit easier by listing the options of each available driver.

The options are generated from AxoSyslog v4.9.0.

Quickstart

Install with pipx

pipx install axosyslog-cfg-helper

Or pull the container image

docker pull ghcr.io/alltilla/axosyslog-cfg-helper

List the contexts

axosyslog-cfg-helper

List the drivers in a context

axosyslog-cfg-helper --context parser

List the options of a driver

axosyslog-cfg-helper --context parser --driver csv-parser

Example

Development

The tool is still in development, but most of the drivers are supported.

Missing features are:

• Proper rewrite support.
• Proper filter support.
• Drivers defined in SCLs.
• Drivers defined with confgen.

Any contribution is welcome :)

Local setup

The project uses poetry as a dependency management system.

Building of the option database needs the neologism pip package, which gets installed by poetry, however it has another dependency, which is bison. Make sure to install bison (at least 3.7.6) on you system if you wan't to develop locally. make bison can help with that.

The Makefile consists of some useful commands:

• make venv prepares the venv.
• make bison downloads bison 3.7.6, builds it and installs it under /usr/local.
  • You can change the install path with make bison BISON_INSTALL_PATH=...
• make check runs the unit tests, style-checkers and linters.
• make format formats the code.
• make db downloads the axosyslog release tarball and generates the option database.
• make db AXOSYSLOG_SOURCE_DIR=/path/to/axosyslog creates a tarball from the state of the axosyslog source dir and generates the option database.
• make package creates the pip package.

Community

You can reach out to the AxoSyslog community on Discord: