https://github.com/syslog-ng/syslog-ng-cfg-helper
https://github.com/syslog-ng/syslog-ng-cfg-helper
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/syslog-ng/syslog-ng-cfg-helper
- Owner: syslog-ng
- License: gpl-3.0
- Created: 2025-02-13T13:27:35.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-18T10:24:21.000Z (over 1 year ago)
- Last Synced: 2025-06-01T16:16:19.416Z (about 1 year ago)
- Language: Python
- Size: 146 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# syslog-ng CFG Helper
This tool makes configuring [syslog-ng](https://github.com/syslog-ng/syslog-ng) a bit easier by listing the options of each available driver.
The options are generated from [syslog-ng v4.6.0](https://github.com/syslog-ng/syslog-ng/releases/tag/syslog-ng-4.6.0).
## Quickstart
### Install with pipx
```
pipx install syslog-ng-cfg-helper
```
### List the contexts
```
syslog-ng-cfg-helper
```
### List the drivers in a context
```
syslog-ng-cfg-helper --context parser
```
### List the options of a driver
```
syslog-ng-cfg-helper --context parser --driver csv-parser
```
### Example
[](https://raw.githubusercontent.com/syslog-ng/syslog-ng-cfg-helper/assets/example.gif)
## 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 `SCL`s.
* Drivers defined with confgen.
Any contribution is welcome :)
### Local setup
The project uses [poetry](https://python-poetry.org/) as a dependency management system.
Building of the option database needs the [neologism](https://github.com/alltilla/neologism) pip package, which gets installed by poetry, however it has another dependency, which is [bison](https://www.gnu.org/software/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](https://github.com/alltilla/syslog-ng-cfg-helper/blob/master/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 syslog-ng release tarball and generates the option database.
* `make db SYSLOG_NG_SOURCE_DIR=/path/to/syslog-ng` creates a tarball from the state of the syslog-ng source dir and generates the option database.
* `make package` creates the pip package.
# NOTE
This is a retro fork of [axosyslog-cfg-helper](https://github.com/alltilla/axosyslog-cfg-helper), as that no longer supports syslog-ng.