README

Elektra has many different aspects to explore. Not all parts are needed by everyone. In this document we classify which parts should be read by whom.

General Information

Read this first to get the basic concepts of Elektra.

• Namespaces
• Key names
• Cascading
• Arrays
• Mount Configuration Files

Developers

For these tutorials we assume you want to elektrify your application, that means, you want your application to participate in the global key database Elektra provides.

• Hello, Elektra in C
• Integration of your C Application
• Writing a specification for your configuration
• Meta specification language
• Plugins Introduction
• Storage Plugins
• Compilation Variants of plugins (advanced topic)
• High Level API
• Command Line Options
• Python Bindings
• Java Bindings
• Java Plugins
• Ruby Bindings
• High Level API Bindings
• Notifications
• Changetracking

System Administrators

For these tutorials we assume that you want to work with the configuration of applications already somehow integrated with Elektra.

• Import Configuration
• Export Configuration
• Intercept Environment
• Intercept File System
• Merge Configuration (new version)
• Merge Configuration (deprecated)
• Validate Configuration
• Encrypt Configuration
• Install Configuration Files
• Write a specification for dockerd
• Recording Changes
• Configure Xfconf Applications

Elektra Developers

These tutorials are for persons that want to contribute to Elektra:

• Contributing with CLion
• Contributing with Visual Studio (Windows)
• Run all Tests with Docker
• Run Reformatting with Docker
• Using Podman instead of Docker
• Language Bindings
• Code Generator
• Benchmarking
• Profiling
• Logging
• Changetracking

Installation Manuals

These tutorials provide additional information on how to install and set up specific tools.

• ODBC Backend
• Webui