You are here

function _hosting_hosting_setup_requirements in Hosting 5

File

./hosting_help.inc, line 176
Hosting help subsystem

Code

function _hosting_hosting_setup_requirements() {
  $node = node_load(HOSTING_OWN_WEB_SERVER);
  $drush_path = $node->drush_path;
  $docroot = HOSTING_DEFAULT_DOCROOT_PATH;
  $uri = HOSTING_DEFAULT_BASE_URL;
  $username = HOSTING_DEFAULT_SCRIPT_USER;
  $setup_cmd = <<<EOF
    cd {<span class="php-variable">$docroot</span>}
    {<span class="php-variable">$drush_path</span>} hosting setup
EOF;
  $help['title'] = t('Perform initial configuration by running the <code>Hosting Setup</code> command');
  $help['summary'][] = t('The hosting setup command performs several useful installation functions, but it\'s primary responsibility
        is adding the crontab entry for the queue dispatcher and ensuring that has been correctly installed.');
  $help['summary'][] = t('The queue dispatcher runs every minute. It keeps track of what work needs to be done on the system
    and instructs the provisioning framework to perform the needed tasks in the task queue.');
  $help['summary'][] = t('Otherwise said, without the dispatcher, changes on the front end will not translate in the required backend configuration preventing actual sites management.');
  $help['configuration'] = t('Ensure that you are logged into the shell as %script_user, and then execute the following commands :<pre>@setup_cmd</pre>', array(
    '%script_user' => $username,
    '@setup_cmd' => $setup_cmd,
  ));
  return $help;
}