A configuration editing tool and API
Augeas C Shell Yacc Makefile M4 Nginx
Latest commit 6f19fc6 Mar 21, 2017 @domcleal domcleal Update gnulib to 7b8cbb9
Permalink
Failed to load latest commit information.
.gnulib @ 7b8cbb9 Update gnulib to 7b8cbb9 Mar 22, 2017
build/ac-aux Rename build/aux to build/ac-aux Jan 27, 2014
doc Version 1.7.0 Nov 8, 2016
examples * examples/fadot.c: free the result from FA_AS_REGEXP Oct 2, 2016
lenses Fix for rsyslog rainerscript module loading, with options Mar 16, 2017
man Update Copyright date to 2016 Aug 16, 2016
src Reorganize how help lists all commands Mar 17, 2017
tests Add radicale lens test to list Mar 14, 2017
.gitignore * test-perf.c (testPerfPredicate): add test showing slow predicates Sep 28, 2015
.gitmodules Use gnulib from a submodule Jul 19, 2010
.travis.yml .travis.yml: Use sudo false and the apt addons Apr 9, 2015
AUTHORS Update NEWS and AUTHORS with information about Radicale lens Mar 14, 2017
COPYING Autotools support for building Nov 27, 2007
HACKING.md * HACKING.md: add a note on using Homebrew to install readline on OSX Nov 26, 2015
INSTALL Autotools support for building Nov 27, 2007
Makefile.am gnulib: Allow tests to be disabled with ./configure --disable-gnulib-… Nov 1, 2016
Makefile.inc build: support for running with libfailmalloc preloaded Sep 30, 2009
Makefile.maint Version 1.1.0 Jun 14, 2013
NEWS Version 1.8.0 Mar 20, 2017
README Add README as a symlink to README.md to make autogen relax May 24, 2013
README.md Update README.md May 17, 2013
acinclude.m4 * src/augtool.c: add stubs for readline functions missing on OSX Nov 26, 2015
augeas.pc.in pkg-config: Augeas requires libxml2. Dec 3, 2011
augeas.spec.in augeas.spec.in: sync with latest from Fedora; add -static subpackage Mar 18, 2017
autogen.sh Rename build/aux to build/ac-aux Jan 27, 2014
bootstrap Rename build/aux to build/ac-aux Jan 27, 2014
configure.ac Version 1.8.0 Mar 20, 2017

README.md

Introduction

Augeas is a library and command line tool that focuses on the most basic problem in handling Linux configurations programmatically: editing actual configuration files in a controlled manner.

To that end, Augeas exposes a tree of all configuration settings (well, all the ones it knows about) and a simple local API for manipulating the tree. Augeas then modifies underlying configuration files according to the changes that have been made to the tree; it does as little modeling of configurations as possible, and focuses exclusivley on transforming the tree-oriented syntax of its public API to the myriad syntaxes of individual configuration files.

This focus on editing sets Augeas apart from any other configuration tool I know of. Hopefully, Augeas will form a more solid foundation on which these tools can be built; with a clean, simple API these tools should be able to focus more on their core concerns and less on the mechanics of running sed, grep, awk, etc. to tweak a config file.

If all you need is a tool to edit configuration files, you only need to concern yourself with the handful of public API calls that Augeas exposes (or their equivalent language bindings). However, to teach Augeas about a new file format, you need to describe that file format in Augeas's domain specific language (a very small subset of ML) Documentation for that language can be found on the Augeas website at http://augeas.net/ If you do that, please contribute the description if at all possible, or include it in the distribution of your software - all you need to do for that is add a couple of text files, there is no need to change existing code. Ultimately, Augeas should describe all config files commonly found on a Linux system.

Non-goals

Augeas is as much defined by the things it does not try to accomplish as by its goals:

  • No abstraction from native config format, i.e. the organization of the tree mirrors closely how the native config files are organized
  • No cross-platform abstraction - what is logically the same value may live in different places in the tree on different distributions. Dealing with that should be left to a higher-level tool
  • No remote management support. Augeas is a local API, other ways of access to Augeas should be built on top of it
  • No (or very little) modelling. Augeas is focused on syntax transformation, not on any higher-level understanding of configuration.

The above non-goals are of course important concerns in practice. Historically though, too many config mgmt projects have failed because they set their sights too high and tried to address syntax transformation, modelling, remote support, and scalable management all in one. That leads to a lack of focus, and to addressing each of those goals unsatisfactorily.

Building

These instructions apply to building a released tarball. If you want to build from a git checkout, see the file HACKING.

See the generic instructions in INSTALL. Generally,

  ./configure
  make && make install

should be all that is needed.

You need to have readline-devel installed. On systems that support SELinux, you should also install libselinux-devel.

Documentation

Documentation can be found on Augeas' website http://augeas.net/ The site also contains information on how to get in touch, what you can do to help etc.

License

Augeas is released under the Lesser General Public License, Version 2.1 See the file COPYING for details.