atlas-run-standalone

This page describes the shell script atlas-run-standalone, part of the Atlassian Plugin SDK.

Basic usage

atlas-run-standalone [options] - Runs an Atlassian application standalone, without a plugin project (that is, not requiring atlas-create-<product>-plugin). Interpreted parameters: version, container, http-port, ajp-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins, lib-plugins, bundled-plugins, product.

Parameters

This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.

Explaining the table columns:

'Full Parameter' and 'Shortened' - Some parameters allow you to choose a full or a shortened version of the parameter, others just support the full version.
'Accepts a Value?' - 'Yes' means that you should specify a value in addition to the parameter, e.g. for the 'version' parameter you should specify the version number. 'No' means that the parameter does not accept a value.

Interpreted parameters:

Full parameter	Description
--version	Version of the application to run. Default is `RELEASE`. Examples: `3.1` `3.1-m7` If you want to change versions, you need to clean the target directory by deleting it or running atlas-clean Shortened: -v
--container	Container to run in. Default is `tomcat8x`. Other available values are `tomcat5x`, `resin3x` and `jboss42x`. Shortened: -c
--http-port	HTTP port for the servlet container. The defaults are as described in the SDK overview. You may need to change this if you already have a process listed for the default port, such as when you want to bring up two instances of Confluence. Shortened: -p
--ajp-port	AJP port for the servlet container. The defaults are as described in the SDK overview. You may need to change this if you already have a process listed for the default port, such as when you want to bring up two instances of Confluence. Shortened: -ajp
--context-path	The application context path. You will need to include the leading forward slash. For example, if your application is running at http://localhost:1990/confluence then you should enter `/confluence`. To run your application in the root web application context (eg. http://localhost:1990), then you should enter `ROOT`.
--server	Host name of the application server. The default is `localhost`.
--jvmargs	Additional JVM arguments if required.
--log4j	Log4j properties file.
--test-version	Version to use for test resources. DEPRECATED: use data-version instead.
--data-version	Version to use for data resources (default is RELEASE)
--sal-version	Version of SAL (Shared Access Layer) to use.
--rest-version	Version of the Atlassian REST module to use.
--plugins	A list of plugin artifacts, separated by commas, in the form `GROUP_ID:ARTIFACT_ID:VERSION`. Version is optional. Default is `LATEST`. These plugins will be installed into the application.
--lib-plugins	A list of lib artifacts, separated by commas, in the form `GROUP_ID:ARTIFACT_ID:VERSION`. Version is optional. Default is `LATEST`. Use this to add additional JARs into your `/lib` folder.
--bundled-plugins	A list of bundled plugin artifacts, separated by commas, in the form `GROUP_ID:ARTIFACT_ID:VERSION`. Version is optional. Default is `LATEST`. These plugins will be loaded as bundled plugins in the application.
--product	The application to launch.
--maven-plugin-version	Specify the Maven AMPS plugin version to use. A full list of versions can be found at AMPS SDK release notes. Shortened: -u

All above accepts a value.

Getting help

The shell script will display some help text if you enter one of the following as the first argument:

-?
-h
help
-help
--help

For example:

1
2
atlas-run-standalone -?
atlas-run-standalone -help

Examples

Running an Application

Say you want to quickly spin up an instance of Jira, without having previously created a Jira plugin project using atlas-create-jira-plugin. At the command line, type:

1
2
atlas-run-standalone --product jira

This will create a directory called amps-standalone in your current working directory, which will contain a Jira home directory, database and server logs.

Specifying a Version of the Application

Say you want to start up Confluence version 3.2.2 specifically, rather than the latest version. At the command line, type:

1
2
atlas-run-standalone --product confluence --version 3.2.2

Default ports for each application

The table below shows the applications currently supported by the Atlassian Plugin SDK, the default port, and the product key for each host application.

Atlassian Application	Default port	Product key
Bamboo	6990	bamboo
Bitbucket	7990	bitbucket
Confluence	1990	confluence
Crowd	4990	crowd
Crucible	3990	fecru
FishEye	3990	fecru
Jira	2990	jira
RefApp	5990	refapp
Stash	7990	stash

Caveat for Jira: Plugins developed for versions of Jira before 4.0 are supported, but using the SDK with versions of Jira earlier than 4.0 is not.

Limitations

Currently if you want to run multiple products, or multiple versions of each product, you must either use different working directories to contain the amps-standalone data for each product, or you must manually remove the target directory under amps-standalone. See issue AMPS-403.

Working with the SDK