Skip to content

Configuring Plugins

Matthew Hutchinson edited this page Sep 15, 2013 · 1 revision

Lolcommits currently has 6 plugins that (when enabled) perform additional work on your lolcommit image after capturing. To list or configure the available plugins use the following commands:

lolcommits --plugins
lolcommits --config
# OR
lolcommits --config -p plugin_name

Set the enabled flag to true or false to turn a plugin ON or OFF. You can always check the current lolcommits configuration file (per repository and stored at $HOME/.lolcommits/$REPOSITORY_NAME/config.yml) with this command:

lolcommits --show-config
# OR
lolcommits -sc

And now... the plugins!

loltext

The default plugin that overlays your git commit message onto the lolcommit capture. If you want naked images, disable this.

twitter

Sends your commit images and messages to a Twitter account. To enable run:

lolcommits --config -p twitter

Then on your next commit, you'll be asked to open your browser to generate a new authentication PIN. Enter the PIN when prompted. This saves a Twitter access_key and token to your lolcommits config file.

NOTE: if you enable this plugin for another repository you may want to copy the yaml credentials too (so Twitter does not de-authorize the connection).

dot_com

lolcommits.com is web app hosting lolcommit images for multiple repositories! You can signup for free via GitHub authentication. After signing up, click 'New Repo' to create a new repository, then configure the lolcommits gem with:

lolcommits --config --plugin dot_com
enabled: <true>
api_key: <your lolcommits.com api key>
api_secret: <your lolcommits.com api secret>
repo_id: <repo external id>  

tranzlate

TRANZLATE YOAR COMMIT MSG TO LOLSPEKK - U CAN HAZ ENABLEZ WITH:

lolcommits --config -p tranzlate` and set enabled to `true

uploldz

Uploads your lolcommits to any remote server with an HTTP POST request. For central storage and/or more lolz.

The request will include the image under the key file, and the repository it came from under repo. Useful for teams who want to share their lolcommits with each other! To enable, run:

lolcommits --config -p uploldz

Set an endpoint (the URL of where you want to send the POST requests) and enabled to true.

lolsrv

lolsrv is a small Rest-ful Sinatra app you can host to show off your lolcommits. It uses mongodb and can be easily hosted on Heroku. Configure the plugin to upload and sync with the following:

lolcommits --config -p lolsrv

Specify the server's host name (e.g. http://mylolsrv.com), and set enabled to true.