Skip to content
This repository has been archived by the owner on Apr 5, 2018. It is now read-only.

Plugin Admin

mheffner edited this page Jan 11, 2012 · 3 revisions

Admin Plugin

Handle various twke administrative tasks.

Commands

  • admin respawn

Cause twke to exit. Ideally this will respawn twke via inittab or upstart using a script like this one.

  • join <roomname>

Tell twke to join the room named <roomname>. Twke will add this room to the list of rooms it will automatically join on startup.

Configuration

  • admin.join_rooms

List of rooms that will automatically be joined on startup. Example: ['Dev', 'Ops', 'Chat'].

  • admin.load_plugins.*

By default, twke will load all the plugins under the top-level /plugins directory. To load additional plugins from third-party sources, you can specify additional plugins under the config setting admin.load_plugins.*. There are two ways to load plugins:

  1. From a directory. Setting admin.load_plugins.<myplugin>.path will load all plugin files (*.rb) under the file-system directory path admin.load_plugins.<myplugin>.path.

  2. From a git repo. Setting admin.load_plugins.<myplugin>.repo to a repo URI will clone the repo URI and load all plugin files (*.rb) from the directory plugins/ under the reposistory. You can also set admin.load_plugins.<myplugin>.path to a relative directory path to load plugin files under that directory instead of the default plugins/.

Plugins are only loaded during startup, so if you change admin.load_plugins.* you must restart twke.

Clone this wiki locally