Skip to content

Developer Guide

Michael Boelen edited this page Sep 14, 2015 · 9 revisions

Getting Started

Developing is not that hard, as our tool is written in shell script. It uses Bourne shell (not to be confused with Bourne again shell, or BASH). The benefit is that it is available to all UNIX based systems, and a common language to every system administrator. No deep programming language is needed to be able to contribute.

Structure

The first part when developing, is understanding the structure of the project.

Directories

Root directory

The most important files, like the Lynis script can be found in the root of the directory, together with the man page and documentation.

Include directory

The directory is named "include", as more intelligence is included (or sourced) by the main script. It includes important functions, initializes variables, and shows the report. Also the individual tests are stored in this directory. So this directory is definitely where most of the magic happens.

Extra directory

Supporting documents and scripts are stored here.

Style

Clone this wiki locally