APS Catalog: aps-catalog Utility

The aps-catalog utility is used to install applications from APS Catalog in Parallels Plesk Panel Application Vault and to perform the related operations. Using the utility, you can perform the following tasks:

configuring/retrieving settings of connection to APS Catalog
installing APS Catalog applications in bundles
getting status of the installation progress
changing configuration of the predefined applications bundles

Location

%plesk_cli%

Usage

aps-catalog <command> [options]

Example

To make Parallels Plesk Panel work with APS Catalog accessible by the URL http://apscatalog.com:

>aps-catalog.exe -u -aps-catalog-url http://apscatalog.com

Commands

Command	Parameter	Description	Example
`--update` or `-u`		Changes settings of connection to APS Catalog.	To make Parallels Plesk Panel work with APS Catalog accessible by the URL http://apscatalog.com: >aps-catalog -u -aps-catalog-url http://apscatalog.com
`--install-applications-bundle` or `-i`	`1\|2\|3`	Installs specified applications bundle: `1` -Most Popular; `2` - Less Popular; `3` - All.	To install all applications from APS Catalog: >aps-catalog --install-applications-bundle 3
`--apply-own-bundles-config` or `-a`	`<path to file>`	Applies custom configuration from the specified file to applications bundles. See the configuration file format description and example below the commands and options reference.	To replace default configuration of applications bundles with the custom configuration defined in the file D:\tmp\bundles.config: >aps-catalog --apply-own-config D:\tmp\bundles.config
`--get-installation-progress` or `-g`		Gets current state of application(s) installation progress.	>aps-catalog -g
`--info` or `-f`		Displays information about settings of connection to APS Catalog.	>aps-catalog -i
`--help` or `-h`		Displays help on the utility usage.	>aps-catalog -h

Options

Option	Parameter	Description	Example
`-aps-catalog-url`	`<URL>`	Specifies URL of the APS Catalog service.	To make Parallels Plesk Panel work with APS Catalog accessible by the URL http://apscatalog.com: >aps-catalog -u -aps-catalog-url http://apscatalog.com

Option

Parameter

Description

Example

-aps-catalog-url

<URL>

Specifies URL of the APS Catalog service.

To make Parallels Plesk Panel work with APS Catalog accessible by the URL http://apscatalog.com:

>aps-catalog -u -aps-catalog-url http://apscatalog.com

Configuration File Format

Configuration file should be a plain text file in Unicode, listing application names (one per line) under the bundle name definition. In case APS Catalog contains various packages of an application with the same name and different version and/or release, the latest version/release of application will be installed.

Note: Bundle names (written in square brackets) must not be changed.

[mostused]

ApplicationName1

ApplicationName2

...

ApplicationNameN

[lessused]

ApplicationNameI

ApplicationNameII

...

ApplicationNameX

[all]

ApplicationName1

ApplicationName2

ApplicationName3

...

ApplicationNameZ

Configuration File Example

[mostused]

joomla

WordPress

Drupal

phpBB

osCommerce

[lessused]

VideoDB

phpMyChatPlus

OpenRealty

[all]

joomla

WordPress

Drupal

phpBB

osCommerce

movabletype

SugarCRM

VideoDB

phpMyChatPlus

OpenRealty