VDI Handler Plugin Template

This repository is a template repo for creating new VDI handler plugins.

For more details about the scripts themselves and their inputs and outputs see the VDI Plugin Handler Server readme.

Usage

Demonstration

Prerequisites

• Docker

• sshuttle

Setup

1. Copy the example.env file from the root of this repo to a new file named .env in the repository root directory.
   The .env file will be ignored by Git by default.

2. Edit the new .env file by doing the following at minimum:

   1. Provide a valid LDAP_SERVER variable value.

   2. Provide a valid ORACLE_BASE_DN variable value.

   3. Provide the database TNS name and user credentials for at least one of the database configuration blocks provided.

   4. Comment out any unused database configuration blocks.

      ℹ️

      No connection to any databases will be attempted by the VDI Plugin Handler Server or any of the included example plugin scripts. The database connection details are simply required to pass server startup config validation. The TNS name is the only value that is required to be correct, the credential variables may be junk strings.

Run the Example

1. Build the target example docker container by using one of the included make build commands.

2. Start up sshuttle (see the VEuPathDB confluence documentation for running a service locally).

3. Run the target example docker container by running one of the included make run commands.

Example

ℹ️	This example assumes sshuttle is already running.

$ make build
$ make run

Creating a New Plugin Handler

To use this repository, click the green "Use this template" button near the top right of the repository source file listing table and create a new repository for your handler.

This repository follows the normal steps as outlined in the VEuPathDB Confluence doc titled "Deploy Containerized Services for Local Development".