Man pages: cherokee-tweak

This command-line tool is also not as well known as it should. Again this is not by lack of merits, which in fact are considerable. Its intended audience are also system administrators and developers.

cherokee-tweak is a swiss army knife that allows to perform several administrative tasks from the command line. It can connect to a running Cherokee instance, be it in the local computer or at a remote location, and request it to perform several actions.

These actions are:

  • Log rotation: logrotate.

  • Live tracing: trace.

  • Provide information: info.

  • Report the list of Information Sources of a running server and their individual statuses.

  • Kill remotely any information source.

This is the full information provided by the manpage.

To use cherokee-tweak, an administrative interface must be defined within cherokee-admin. That is, you must define a path managed by the handler Remote Administration. This can be done through the Virtual Servers option, in Behavior and using the Add new rule option.


Please note that while you are at it, the definition of a security (through the Security tab) is highly encouraged. Although you have the choice to, you should never use None as security mechanism since this would leave your system exposed to third parties using cherokee-tweak.

Also note that the usage of the trace command has no effect unless Cherokee is compiled with the --enable-trace. This is a debugging option and it is unlikely to be present in binary version of Cherokee not specifically compiled with this in mind.

Every module traceable with CHEROKEE_TRACE can also be traced this way. Refer to the "Debugging" section of the documentation for more information on this matter.

Keep in mind one important thing: when the trace command is specified, cherokee-tweak activates the tracing functionality within the cherokee instance. It does not provide tracing of its own. This means the debugging information will appear in the machine that is actually running the cherokee instance. This may or may not be the same that is running the cherokee-tweak process.