XL Deploy Community Plugins

Welcome to the XL Deploy community plugin repository on GitHub!

Here you will find plugins that can be used to add capabilities to your existing XL Deploy installation. The source code for the plugins is also provided if you are curious to see how a plugin works or want to improve it.

Note: the plugins here are provided on an as-is basis as a service to Deployit users. Support for these plugins is provided through XebiaLabs' professional services department.

Finding a plugin

All plugins are located in directories inside the main community-plugins repository. Browse the main directory to find the list of plugins and navigate into a plugin directory to find the plugin's documentation and source code.

deployit-udm-plugins

This directory contains XL Deploy plugins that are based on the Unified Deployment Model (UDM).

deployit-server-plugins

This directory contains XL Deploy server plugins that influence server behavior.

deployit-cli-plugins

This directory contains XL Deploy CLI plugins that influence CLI behavior.

tool-deployit-plugins

This directory contains plugins for external tools that interact with XL Deploy.

example-plugins

This directory contains example plugins that can be used for tutorials and as starting-off points for new plugins.

Downloading a plugin

You can find compiled, ready-to-install binaries in the Downloads location. If you want, you can clone or fork the repository and compile the plugin from the source code.

Installing a plugin

Installing a plugin is as simple as copying the plugin JAR file into the plugins directory in your XL Deploy server installation directory. See the XL Deploy System Administration Manual for more information.

Building community plugins

To build plugins in the community-plugins repository:

1. Check out the community-plugins repository https://github.com/xebialabs/community-plugins.
2. Ensure that Java 1.7 and Maven are installed
3. Ensure that Maven is using Java 1.7 (otherwise it will have issues while building).
4. Export an environment variable called DEPLOYIT_HOME and point it to the XL Deploy home directory on your machine.
5. Export an environment variable called DEPLOYIT_CLI_HOME and point it the XL Deploy CLI home directory on your machine.
6. Ensure that you have WebLogic plugin in XLDEPLOY_HOME/plugins because a LifeRay plugin requires it (otherwise, you can skip that plugin from build).
7. Run mvn package or mvn clean install to build all plugins.

You will find all the built plugins under each one's target folder

Note: If you are using OS X, in Step 3 you may need to set the version for Java and the Java version used by Maven using the following commands. To change the Java version:

export JAVA_HOME=\`/usr/libexec/java_home -v 1.7\`

To change the version of Java used by Maven:

echo JAVA_HOME=\`/usr/libexec/java_home -v 1.7\` | sudo tee -a /etc/mavenrc

Contributing to a plugin

If you want to add features to a plugin, fix a bug, or otherwise contribute, great! Fork the community-plugins repository, make your changes, test them and submit a pull request to us so we can incorporate your changes and make them available to other XL Deploy users.

Discussing plugins

The XL Deploy user forum is a place where you can discuss these community plugins (or other XL Deploy installation and configuration topics) with fellow XL Deploy users.

Enjoy!

We hope the plugins provided here will help you make the most of XL Deploy. Please let us know what you think by posting a message on our support site at http://support.xebialabs.com.

Sincerely,

XebiaLabs