There is essentially three ways to contribute to Pimp My Log :

  1. Add new type of logs for new softwares (want to display logs from sshd, nginx, ...)
  2. Add some new features, fix bugs, etc... in the main source code
  3. Add a new language

Current dev build status is Build Status

1 - New logs

1.1 - For your own usage

Basically, you just have to modify the configuration file config.user.json at root and it will work. To understand how the configuration file works, just read the documentation about configuration, it is easy.

The only difficulty should be the regular expression. There is a tool to help you to find the right expression. This tool is explained in the debug page.

1.2 - For the community

First of all, you have to make it work for you! This is the most difficult part.

1.2.1 - Simple way

To share your configuration file with other users, create a new discussion on the support website and provide these informations :

Here is a discussion template ready to modify and post:

Subject : Submission: Config for ___SOFTWARE___


Here is a configuration excerpt for software *---SOFTWARE---*:

- **name**   : ---SOFTWARE_NAME---
- **url**    : ---SOFTWARE_URL IF AVAILABLE---
- **config** :  
"---SOFTWARE_ID---": {
    "display" : "---SOFTWARE_NAME---",
    "path"    : "---SOFTWARE__PATH---",
    "refresh" : 20,
    "max"     : 20,
    "notify"  : false,
    "format"  : {
- **sample** :  
Jan 12 09:25:12 VNLAdapterStatus - ioctl: SIOCGIFFLAGS failed, error: Device not configured
Jan 12 09:25:12 VNL_EnableNetworkAdapter - Successfully enabled hostonly adapter on vnet: vmnet1
Jan 12 09:25:12 VNL_StartService - Started "DHCP" service for vnet: vmnet1
Jan 12 09:25:12 VNL_StartService - Started "NAT" service for vnet: vmnet8

1.2.2 - Add it in the configurator

You can share it with the community by adding some stuffs so that users will enable this new software during the auto-configuration process at first launch.

You must read the softwares page to understand how you can build your software own configurator.

2 - Active development

If you want to add new features, fix some bugs or something else, it is easy :

Got it!


You have to understand how the repository is organized at first. Pimp My Log has 5 branches:


To code in Pimp My Log, checkout the dev branch:

$ git clone -b dev PimpMyLog-dev
$ cd PimpMyLog-dev

You will need these tools on your computer:

Install some tools:

$ npm install
$ bower install
$ composer install

And launch grunt to watch your modifications and rebuild what is necessary:

$ grunt

Your Pimp My Log development instance is now available at http://localhost/PimpMyLog-dev/_site/

You need of course PHP on your local server!

When you are ready, test your code in production. Stop grunt and launch the production server now:

$ grunt build

Your Pimp My Log development instance ready for production is now available at http://localhost/PimpMyLog-dev/_build/.

This code will be the same as in the master branch :


To work on the documentation is really funny in my private opinion. The website that you are reading now is a static website without any database or script language. It is based on jekyll. It is served by Github servers but statically because plugins are great and Github does not allow them.

So the website in the gh-pages is already generated by grunt in the jekyll branch.

You will need these tools on your computer:

To write documentation or fix my poor english words on, checkout the jekyll branch:

$ git clone -b jekyll PimpMyLog-jekyll
$ cd PimpMyLog-jekyll

Install some tools:

$ bundle install
$ npm install
$ bower install

In 2 terminals, run at the same time :

Now you can watch the documentation website at http://localhost:4000.

Here is the file structure :

Install new css and js tools with bower install ... -S and do not modify original files in bower-components!

When you have finished and are ready, test your modification in production. Stop both grunt processes and launch:

$ grunt build server-prod

Now you can watch the production documentation website ready to deploy at http://localhost:4000.

As in the dev branch, this will minify css, js, html, build thumbnails, etc...

3 - Language

Existing languages

To contribute to an existing language in Pimp My Log (not the documentation website):

We will update Pimp My Log to embed your definitions.

New languages

There are 2 ways to add a new language in Pimp My Log (not the documentation website):