Skip to content

Commit

Permalink
Plugin path fix and add missing plugin documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonschipp committed Aug 5, 2015
1 parent ba77109 commit c84ad59
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
7 changes: 5 additions & 2 deletions ADMIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,14 @@ vim /etc/islet/islet/gcc.conf
### Configuration

* Global configuration file: */etc/islet/islet.conf*
* Per-image configuration file: */etc/islet/$IMAGE.conf*
* Per-image configuration files: */etc/islet/$IMAGE.conf*
* Plugin configuration files: */etc/islet/$PLUGIN.conf*

Per-image configs overwrite the variables specified in the global config file.
For each Docker image you want available for use by ISLET, create an image file with a .conf extension and place it in the /etc/islet/ directory.
These images will be selectable from the ISLET menu after authentication via SSH.
These images will be selectable from the ISLET menu after authentication via
SSH. Plugin configurations are also selectable from the ISLET menu and are
intended to add funtionality by running scripts from the ISLET plugins directory.

Common Tasks:

Expand Down
1 change: 1 addition & 0 deletions config/islet.conf
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ VERSION=ISLETVERS

CONFIG_DIR="/etc/islet" # Directory to search for configuration files. Used by scripts.
INSTALL_DIR="/opt/islet" # ISLET installation directory
PLUGIN_DIR="$INSTALL_DIR/plugins" # ISLET installation directory
LIBISLET="$INSTALL_DIR/lib/libislet" # Common functions are stored in libislet
SHELL="$INSTALL_DIR/bin/islet_shell" # User's shell: displays login banner then launches islet_login
LAUNCH_CONTAINER="$INSTALL_DIR/bin/islet_login" # User management script and container launcher
Expand Down
16 changes: 15 additions & 1 deletion docs/islet.5
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ engine or to ISLET scripts to define the settings a training environment. An env

There cannot be any whitespace between the variable name, the assignment operator, and the value.
Also, quoting is not required but recommended for security and whitespace issues.
ISLET has two types of configuration files that differ only with scope:
ISLET has three types of configuration files that differ only with scope:
.Bd -literal -offset indent
Config Description
------ --------------
Global Global values inherited by all images but optionally superseded in Image configurations
Image Per image configuration that are local to a specific image i.e. training environment
Plugin Plugin configurations are used to launch plugins
.Ed

The default locations for ISLET are
Expand All @@ -29,6 +30,7 @@ Location Description
/opt/islet Installation directory
/opt/islet/bin ISLET scripts
/opt/islet/cron Maintainance scripts
/opt/islet/plugins Plugin directory
/opt/islet/lib Library
.Ed

Expand All @@ -52,6 +54,7 @@ Variables used to configure containers are passed directly to
# System Configuration
CONFIG_DIR="/etc/islet" # Directory to search for configuration files, used by scripts.
INSTALL_DIR="/opt/islet" # ISLET installation directory
PLUGIN_DIR="INSTALL_DIR/plugins" # ISLET plugins directory
LIBISLET="$INSTALL_DIR/lib/libislet" # Common functions are stored in libislet
SHELL="$INSTALL_DIR/bin/islet_shell" # ISLET shell, displays login banner, menu, and then launches islet_login
LAUNCH_CONTAINER="$INSTALL_DIR/bin/islet_login" # User management script and container launcher
Expand Down Expand Up @@ -128,6 +131,17 @@ A place to try out Bro.
"
.Ed

.Ed
.Sh EXAMPLE PLUGIN CONFIG FILE
ISLET supports plugins which are any interpreted scripts that can be run as the ISLET user.
A plugin configuration file describes the plugin. The most important setting being the variable PLUGIN which points to the script to execute.
Plugin configuration files are placed in /etc/islet and the plugin scripts are located in /opt/islet/plugins.
.Bd -literal
ENABLE="yes" # Enable plugin
DESCRIPTION="Restart ISLET session" # Description of plugin
PLUGIN="restart" # Filename of plugin to run
.Ed

.Sh SEE ALSO
.Xr docker-run 1 ,
.Sh AUTHORS
Expand Down

0 comments on commit c84ad59

Please sign in to comment.