atlas-install-plugin

This page describes the shell script atlas-install-plugin, part of the Atlassian Plugin SDK.

Basic Usage

atlas-install-plugin [options] – Installs the plugin into a running application. (Runs mvn amps:install.) Interpreted parameters: http-port, context-path, server, username, password, plugin-key.

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

--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

--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.

--username

Username for the administrator account on the plugin's host application. Default is admin.

--password

Password for the above administrator account on the plugin's host application. Default is admin.

--plugin-key

Unique key identifying the plugin. This is the full key specified in your atlassian-plugin.xml, including the group and artifact IDs. For example, "com.atlassian.confluence.plugins.example".

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:

atlas-install-plugin -?
atlas-install-plugin -help

Examples

Go to the plugin's project directory (where you created the plugin) and run the following command to install your plugin com.atlassian.confluence.plugins.example into the host application, where the administration username is 'myadmin' with password 'secret'.

atlas-install-plugin --username myadmin --password secret --plugin-key com.atlassian.confluence.plugins.example
Was this page helpful?
Powered by Confluence and Scroll Viewport