Appendix D: Plesk Installer Options

This reference covers only the Plesk Installer options related to installing Plesk using CLI.

To learn about options related to upgrading already installed Plesk or the host operating system, issue the following command:

plesk-installer --help

     

Option Description and possible arguments

--source <path>|<url>

When retrieving the Plesk packages from a local file system, specify the --source option to point to the .inf3 file that contains information on the Plesk build you want to install.

When retrieving the Plesk packages from a network server, specify the --source <URL> option to point to the directory where the mirror of the Plesk update server resides.

--target <path>

By default, the installer saves the retrieved files in the directory /<current user name>/psa. For instance, if the installer was executed by user root, the /root/psa directory will be created and used. If you want to use a custom directory for storing the retrieved files, use the --target option.
Example:

--target /opt/storage/psa
OR
--target D:\temp

--proxy-host <network address>

When using a proxy server or a firewall, use this option to specify the proxy server's domain name or IP address.

Example:

--proxy-host proxy.example.com

--proxy-port <port number>

The default port for connecting to a proxy server is 3128. If your proxy server uses different port number, you should specify it using this option.

Example:

--proxy-port 5741

Proxy authentication options:
--proxy-user <user-name>
--proxy-password <password>

If your proxy server requires authentication, you should use these options to authenticate the installer at the proxy server.

Example:

--proxy-user smith --proxy-password f1sZ9AnQ4EnO52

--all-versions

Show all available Plesk versions regardless of their release tiers.

--tier <release-tier>

Show all available Plesk versions with a specified release tier.

--show-releases


Specify this option to retrieve a list of available releases for the operating system where the installer is executed. You will be given a list of release identifiers and release descriptions. The release identifiers are what you will need to deal with.

--show-all-releases

This option shows all releases available from the Plesk updates server.

--select-release-id <ID>

Use this option to specify a release version that you want to install or view properties of.

--select-release-latest

Use this option to select the latest release available for your operating system.

--show-components


Specify this to obtain the information on the components available for the selected release. Components’ descriptions and names will be displayed.
The component names are what you need to specify when selecting additional components to install.

--install-component <component-name>

Use this option to specify a component that you wish to install. If you want to install two or more components at once, repeat this option for each component.

Example:

--install-component base --install-component postgresql --install-component spamassassin

--installation-type

Use this option to specify the installation type: Typical or Full.

--show-os-list

Use this option to find out what operating systems are supported by the Plesk version you selected.

--no-space-check

Installs packages even if you are low on disk space.

--no-daemon

Performs installation process in the foreground.

--notify-email <email>

Use this option to have the installer send you status reports by email. A successful completion report includes a list of installed/upgraded packages with a detailed log.

--enable-xml-output

This option is designed for communicating with Plesk, and it may be used for interaction with other applications.

When you specify this option, all output of the installer is XML-wrapped. Note that this option disallows the installer to report errors by exit code. Exit code is always zero and all errors are reported inside XML output.

--query-status

Because RPM database does not allow multiple accesses, the installer makes a lock on its functionality. Run this option to find out if the installer is active. This will check for a lock, and will return either an exit code (0 - the installer is idle, 1 - the installer is running and busy), or XML-formatted output.

--truncate-log

 

Clears the log file on Plesk Installer start.

--separate-log

Uses a new log file for each start of Plesk Installer.

--debug

Turns on detailed output into the log file.

--version

Shows Plesk Installer's version.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.