This page describes the shell script atlas-install-plugin
, part of the Atlassian Plugin SDK.
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
.
This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.
Explaining the table columns:
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 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 |
--username | Username for the administrator account on the plugin's host application. Default is |
--password | Password for the above administrator account on the plugin's host application. Default is |
--plugin-key | Unique key identifying the plugin. This is the full key specified in your |
All above accepts a value.
The shell script will display some help text if you enter one of the following as the first argument:
For example:
1 2atlas-install-plugin -? atlas-install-plugin -help
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'.
1 2atlas-install-plugin --username myadmin --password secret --plugin-key com.atlassian.confluence.plugins.example
Rate this page: