Contribute

How can I help ?

One easy way to help is to write a description for your favorite config file; you don't need to be a developer to do that.

If you want to roll up your sleeves and help, the Todo list has some items that desparately need somebody to look at, including some items that only take a few minutes but would be enormously useful to us to make sure Augeas correctly processes as many files as possible.

Where is the mailing list ?

The mailing list is augeas-devel@redhat.com. Subscribe by going to the list page.

The list is for any discussion around Augeas, be it bug reports, feature requests, trouble writing file format descriptions etc.

Where is the IRC channel ?

The best place to find somebody connected to Augeas on IRC is #augeas on Freenode. Use the following settings in your IRC client:

  • Server: chat.freenode.net
  • Port: 6667 (the default IRC port)
  • Channel: #augeas

Where is the Bugtracker ?

Bugs are kept in the GitHub project issues.

Where is the source ?

Sources are in a GitHub repository. To check out the code, run

git clone https://github.com/hercules-team/augeas.git

If you want to follow repository changes, you can use GitHub's "Watch" feature on that repository.

To build and explore, you need to:

cd augeas
./autogen.sh && make
# Start a session with augtool that reads lens descriptions from ./lenses
# and runs with AUGEAS_ROOT=./build/try, populated from ./tests/root/
./src/try cli

Besides autotools (in particular, autoconf, automake, and libtool), you will need to have readline-devel, Bison and Flex installed to build Augeas successfully.

What language bindings are available ?

Ruby

Ruby bindings have been contributed by Bryan Kearney and can be found in a separate GitHub repository. To check them out, run

git clone https://github.com/hercules-team/ruby-augeas.git

To build them, you need rake. Simply run rake build to compile them.

Python

Python bindings have been contributed by Harald Hoyer and can be found in their own GitHub repository. To check them out, run

git clone https://github.com/hercules-team/python-augeas.git

OCaml

OCaml bindings have been contributed by Rich Jones and can be found in this git repository. To check them out, run

git clone git://git.annexia.org/git/ocaml-augeas.git

Perl

Perl bindings have been contributed by Dominique Dumont and are currently maintained by Raphaƫl Pinson. Their source can be found on github and is also documented.

Haskell

Haskell bindings have been contributed by Jude Nagurney. Their source can be found at code.haskell.org

Java

Java bindings have been written by Bryan Kearney. Sources are kept in this GitHub repository and release can be downloaded from here

PHP

PHP bindings are maintained by Pedro Padron. Sources are kept in a git repository and releases can be downloaded from the PECL site.

Lua

Lua bindings are maintained by the lua-augeas project.

Node.js

Node.js bindings are maintained by Igor Pashev. Sources are kept in this git repository.

Go language

Bindings for the Go language have been contributed by Dominik Honnef. Sources are kept in this git repository.