Documentation

Development: Quickstart

So, you have found things in Cherokee worth improving and feel the urge to contribute to the project. But where to start?

The first thing, of course, is setting up a development/testing environming for Cherokee.

The relevant documents would be those about software requirements, downloading the SVN repository, and the quickstart installation notes.

In principle, provided you have the required tools in your system, it should be as easy as:

    git clone https://github.com/cherokee/webserver.git ~/cherokee_dev
    cd ~/cherokee_dev
    ./autogen.sh --enable-beta --enable-trace
    make

You should probably read all the development info section of the documentation, and go through the Github Issue Tracker to make sure you are not wasting your effort working on something already solved.

Joining the development list and hanging out at the #cherokee IRC channel are also good ideas.

Quick Tips

If you are modifiying the core of Cherokee, don’t forget to run the whole QA bench to ensure no regressions are being introduced by your changes.

Additionally, if you are modifying cherokee-admin, don’t forget to run the modified instance instead of the one in the system, which can be specified with the -d (--appdir) parameter:

    cherokee-admin -d ~/cherokee_dev/admin

And that’s about it. You should be able to get your hands dirty from here. Happy hacking!