Site Applications: siteapp Utility

The siteapp utility is used to manage site application packages on Plesk server. By using this utility, you can perform the following tasks:

Usage

siteapp <command> [
<option_1> [<param>]
[<option_2> [<param>]]
… [<option_N> [<param>]]
]

Example

The following command removes bbclone application package version 0.48 from the Plesk server application vault:

# ./siteapp --remove-from-server -sapp-name bbclone -sapp-version 0.48

Commands

Command

Parameter

Description

Example

--install-on-server or -i

 

Adds specified application package to the Plesk server application vault.

Requires -sapp-file option.

To add site application package to Plesk server application vault from file /usr/local/psa/siteapp/Drupal.app.zip:

# ./siteapp --install-on-server -file /usr/local/psa/siteapp/Drupal.app.zip

or

# ./siteapp -i -file /usr/local/psa/siteapp/Drupal.app.zip

--remove-from-server or -r

 

Removes specified application package from the Plesk server application vault.

Requires -sapp-name and -sapp-version options.

To remove Drupal application package version 4.7.8 from the Plesk server application vault:

# ./siteapp --remove-from-server -sapp-name Drupal -sapp-version 4.7.8

or

# ./siteapp --remove-from-server -sapp-name Drupal -sapp-version 4.7.8

-add-to-vault or -a

<client_login_name>

Adds a site application package to a Plesk client account's application pool.

Deprecated since Plesk 8.3. Use siteapp-item utility instead.

To add the WebCalendar application package version 1, release number 43 to the application pool of the client account with client login name JDoe:

# ./siteapp --add-to-vault JDoe -sapp WebCalendar -version 1 -release 43

or

./siteapp -a JDoe -sapp WebCalendar -version 1 -release 43

--info-packages-xml or -x

 

Displays information about site application packages available to clients in the Plesk server application vault in the XML format.

To view information in the XML format about site application packages available to clients in the Plesk server application vault:

# ./siteapp --info-packages-xml

or

# ./siteapp -x

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the siteapp utility:

#./siteapp --help

or

#./siteapp -h

Options

Option

Parameter

Description

Example

-sapp

<name>

Specifies a site application package name.

Deprecated since Plesk 8.3. Use -sapp-name instead.

To add the WebCalendar application package version 1, release number 43 to the application pool of the client account with client login name JDoe:

# ./siteapp --add-to-vault JDoe -sapp WebCalendar -version 1 -release 43

-version

<number>

Specifies a site application package version number.

Deprecated since Plesk 8.3. Use -sapp-version instead.

-release

<number>

Specifies a site application package release number.

Deprecated since Plesk 8.3. Use -sapp-release instead.

-sapp-name

<name>

Specifies a site application package name.

Required with --remove-from-server.

To remove Drupal application package version 4.7.8 release 2 from the Plesk server application vault:

# ./siteapp --remove-from-server -sapp-name Drupal -sapp-version 4.7.8 -sapp-release 2

-sapp-version

<number>

Specifies a site application package version number.

Required with --remove-from-server.

-sapp-release

<number>

Specifies a site application package release number.

Required with --remove-from-server.

-file

<path>

Specifies a path to a site application package file.

Required with --intsall-on-server.

To add a site application package to Plesk server application vault from the file /usr/local/psa/siteapp/Drupal.app.zip:

# ./siteapp -i -file /usr/local/psa/siteapp/Drupal.app.zip