Configuring Plesk Sitebuilder after Installation

Plesk Sitebuilder parameters are configured automatically during installation. During this process, some configuration parameters are defined automatically from your system settings, and some acquire default meanings. If you wish to additionally configure your Plesk Sitebuilder after installation, you can do it using the sb_config utility.

Use the sb_config utility if you wish to:

To additionally configure Plesk Sitebuilder, run the sb_config utility with the necessary configuration keys. The configuration utility is started by root user in the command line mode. The available keys with descriptions are shown in the table below.

Key

Description

--phpcli_path

Path to PHP CLI executable.

Default value: /usr/bin/php5

--phpcgi_path

Path to PHP CGI executable.

Default value: /usr/bin/php5-cgi

--update_locales

Update locales.

Default value: no

--update_templates

Update templates.

Default value: no

--update_modules

Update modules.

Default value: no

--migrate_all

Migrate all sites.

Default value: no

--help

Displays the help message with the current information in the console.

Default value: no

--verbose

Be verbose.

Default value: no

--[no]use_rewrite

Enable/disable mod_rewrite usage.

Default value: yes

--sb_admin_passwd

Plesk Sitebuilder administrator's password.

Default value: not changed.

--db_host

MySQL database remote host.

Default value: localhost.

--db_port=PORT

MySQL database remote port.

Default value: 3306.

--db_admin_name

MySQL administrator's user name.

Default value: root

--db_admin_passwd

MySQL administrator's password.

--sb_db_user_name

Plesk Sitebuilder MySQL user name.

Default value: sitebuilder_db

--sb_db_user_passwd

Plesk Sitebuilder MySQL password. The default password is either generated automatically (during clean Plesk Sitebuilder installation), or inherited from the former Plesk Sitebuilder installation (during upgrade).

--sb_db_name

Plesk Sitebuilder database name. If there is no database, it will be created by Sitebuilder.

Default value: sitebuilder3

--httpd_port

Apache port.

Default value: 80

--sb_host_ip

Plesk Sitebuilder IP address used for virtual host creation on Apache.

Default behavior: Plesk Sitebuilder creates Apache virtual host on the IP address it automatically retrieves from the system (command /sbin/ifconfig).

--sb_hostname

Plesk Sitebuilder hostname used for virtual host creation on Apache.

Default behavior: the host name is defined automatically (command hostname). Plesk Sitebuilder adds the sitebuilder- prefix to the defined host name to form a virtual host name (sitebuilder.hostname).

--httpd_owner

Apache user and group.

--[no]enable_ssl

Enable/disable SSL.

Default value: no

Note: Make sure to run sb_config utility every time you have installed or removed Plesk Sitebuilder components, such as language packs and design templates. Running sb_config in this case won't re-generate Apache config: the config is regenerated only if major parameters, such as port or SSL option (enabled/disabled), have been changed.

Configuring Plesk Sitebuilder virtual host

To create a virtual host for Apache web server, the Plesk Sitebuilder server host name and IP address are required. Plesk Sitebuilder determines these parameters automatically during installation. It takes the server host name from the output of the command hostname, and adds the sitebuilder- prefix to it to form a Plesk Sitebuilder virtual host name (sitebuilder.hostname). The IP address is also retrieved from your system automatically (command /sbin/ifconfig).

You can specify your own host name and IP address for Plesk Sitebuilder virtual host. To do so, supply the appropriate --sb_hostname and --sb_host_ip parameters to the Plesk Sitebuilder sb_config utility.

The configuration file is stored in /sitebuilder home directory/config. By default, the Plesk Sitebuilder home directory is /usr/local/sitebuilder (on Debian and Ubuntu - /opt/sitebuilder/).

Note: When specifying data for virtual host, make sure that Plesk Sitebuilder hostname resolves to its IP address. For this to work correctly, a corresponding A DNS record (sb_hostname A IP) must exist on the authoritative name server.

Enabling Single-Sign-On (SSO)

To enable SSO support for your Plesk Sitebuilder server, do the following:

  1. Find out the URL of the SSO server that you will be using.

    It can be provided by your hosting company, or you can set up the SSO server on any machine that is accessible over the Internet, including your Plesk Sitebuilder server.

    You can use your Plesk Sitebuilder server as the SSO server only if you have installed the SSO component during Plesk Sitebuilder setup. To do so, you need to install Plesk Sitebuilder using Autoinstaller.

    In some cases, to make the Plesk Sitebuilder SSO server accessible, you may need to additionally configure the URL of the Plesk Sitebuilder server (generally, this is done automatically during Sitebuilder setup). To do so, run the sb_config utility on this server with the appropriate value specified for the --sb_hostname key.

  2. To register your server with the single sign-on server and switch on the single-sign-on feature, issue the command: sb_installation_directory/utils/sso_config register https://SSO_server_URL:11443

If later you wish to disable the SSO feature in your Plesk Sitebuilder, run the command sb_installation_directory/utils/sso_config unregister