JBoss.orgCommunity Documentation

Chapter 2. Installing Immutant

2.1. Introduction

There are currently two options for installing Immutant: using the Leiningen plugin and downloading a zip file.

2.2. Installation via Leiningen

To install Immutant via the Leiningen plugin, you'll need to first install Leiningen, followed by the lein-immutant plugin. The plugin supports both Leiningen 2.0.0 or higher. To install the plugin under 2.x, you'll need to add it to the plugin list in ~/.lein/profiles.clj:

{:user {:plugins [[lein-immutant "VERSION"]]}}

You can determine the current version of the plugin by looking at its page on clojars.

The plugin provides a number of subcommands, one of which is install. So installing Immutant is as easy as this:

$ lein immutant install [VERSION]

Without a VERSION specified, the most recent versioned release will be installed.

To obtain a specific version, you can specify an incremental build number (ex: 123) or a released version (ex: 1.0.0.Beta1). As a shortcut, you can install the latest incremental build by specifying :latest.

Releases installed via the plugin are installed by default under ~/.lein/immutant/releases, and ~/.lein/immutant/current is linked to that release. You can specify an alternative parent install directory by passing it as the third argument to install:

$ lein immutant install VERSION /path/where/you/want/it  

The plugin will install Immutant there, and link ~/.lein/immutant/current to that version.

This installed version of Immutant is shared across all Immutant applications on your machine, and does not need to be installed for each application.

$ lein immutant install [VERSION]

See Deployment for more details about the plugin.

2.3. Installation via Zip Download

You can manually download any of the same builds that you can install via the plugin. You can download incremental builds from our builds page and an official releases from our releases page.

Once you have the zip downloaded, expand it somewhere handy. If you want to use the Leiningen plugin with this build, you'll need to set $IMMUTANT_HOME:

$ mkdir immutant-releases
$ cd immutant-releases
$ unzip path/to/immutant-dist-slim.zip
$ export $IMMUTANT_HOME=~/immutant-releases/immutant-0.10.0-slim/
Immutant 1.1.4