Hosting Setup 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 :@setup_cmd
',
array('%script_user' => PROVISION_SCRIPT_USER, '@setup_cmd' => $setup_cmd));
return $help;
}
function _provision_cron_requirements() {
$username = PROVISION_SCRIPT_USER;
$cron_cmd['!queueconf'] = l(t("Queue administration"), "admin/settings/queues");
$cron_cmd['@cron_line'] = hosting_queues_cron_cmd();
$help['title'] = t('A cron entry for queue dispatcher.');
$help['summary'][] = t('Changes to this system are executed via a back end script which needs to be called by a user other than
the web server user for security reasons at regular intervals.');
$help['summary'][] = t('The intervals at which these commands are run can be customised by going to the !queueconf section.', $cron_cmd);
$help['summary'][] = t('The hosting setup command installs the required cron entry for you.', $cron_cmd);
$help['configuration'] = t('Add the following line to your crontab : @cron_line', $cron_cmd);
return $help;
}
function _provision_platform_requirements() {
$platform = node_load(HOSTING_OWN_PLATFORM);
$web_server = node_load(HOSTING_OWN_WEB_SERVER);
$db_server = node_load(HOSTING_OWN_DB_SERVER);
$task = hosting_get_most_recent_task($platform->nid, 'verify');
$help['title'] = t('Provisioning framework status');
$help['summary'][] = t('In order for the hosting system to be able to create sites, it needs a platform to publish these sites on. A platform is a Drupal site that has the provision back end installed. Each platform also requires one correctly configured web server and one correctly configured database server. Once a new platform has been created, Hosting will automatically schedule a task that will verify the new platform is working properly.');
$help['summary'][] = t('As hosting is also running on a platform, it is suggested that you succesfully configure your primary platform
before creating additional platforms and servers.', array('@platform' => url('node/' . HOSTING_OWN_PLATFORM)));
$help['summary'][] = t('Each platform must be verified at least once, but if you find your platform is not being verified, look at the error log on the Verify platform task of this platform', array("@verify_link" => url("node/" . $task->nid)));
return $help;
}
/**
* TODO: replace. this is OLD OLD OLD
*/
function _hosting_introduction() {
$create_site_link = l(t('Create a site now?'), 'node/add/site');
if ($_GET['q'] != variable_get('site_frontpage', 'node')) {
return t("No sites have been created yet. !link", array(
'!link' => $create_site_link));
}
else {
drupal_set_title('Welcome to your new Hosting website!');
$default_message = t('Please follow these steps to set up and start using your website:
');
$default_message .= '';
if (!$admin) {
$default_message .= '- '. t('Create your administrator account To begin, create the first account. This account will have full administration rights and will allow you to configure your website.', array('@register' => url('user/register'))) .'
';
}
$default_message .= '- '. t('Configure your website
Once logged in, visit the administration section,
where you can customize and configure all aspects of your website.',
array('@admin' => url('admin'), '@config' => url('admin/settings'))) .'
';
$default_message .= '- '. t('
Configure the Provisioning framework.
Before you configure the Provisioning framework, it is highly recommended that you first read the Provision Requirement documentation.
It provides a step by step guide for configuring your server to use the framework.
You will then need to complete the provisioning section to configure the framework.
',
array('@provision' => url('admin/settings/provision'),
'@requirements' => url('admin/help/provision/requirements'))) .' ';
$default_message .= '- '. t('Configure the Hosting framework.
Most of the configuration for the system is configured for provisioning, but there are a number of small configuration changes that need to set.
For all the information you will need, please follow the instructions in the Hosting help section.', array('@hosting_help' => url('admin/help/hosting/requirements'))) .'
';
$default_message .= '- '. t('Create your first hosted site. This system uses special site posts to store information about your sites, so you can simple create a site post to get your first hosted site running.', array('@create_site' => url('node/add/site'))) .'
';
$default_message .= '
';
$default_message .= ''. t('For more information, please refer to the help section, or the online Drupal handbooks. You may also post at the Drupal forum, or view the wide range of other support options available.', array('@help' => url('admin/help'), '@handbook' => 'http://drupal.org/handbooks', '@forum' => 'http://drupal.org/forum', '@support' => 'http://drupal.org/support')) .'
';
$output = ''. $default_message .'
';
return $output;
}
}
/**
* Per node type description text. To be stored in the node_type table.
*
* @param type
* The node type.
* @return
* Description text for the node type.
*/
function hosting_node_help($type) {
switch ($type) {
case 'site' :
return t("An instance of a hosted site.
It contains information relating to the site, most notably the domain name, database server
and platform it is being published on. A site may also have several aliases for additional
domains the site needs to be accessible on.");
break;
case 'platform' :
return t("The file system location on a specific web server on which to publish sites.
Multiple platforms can co-exist on the same web server, and need to do so for
upgrades to be managed, as this is accomplished by moving the site a platform
hosting an updated release.
Platforms are most commonly built for specific releases of Drupal.");
break;
case 'client' :
return t("The person or group that runs the site.
This information is usually required for billing and access purposes, to assure
that only certain people are able to view the information for sites they run.
If you do not intend on having more than one client access the system,
you will not need to create any additional clients for your purposes.");
break;
case 'web_server' :
return t("The physical machine where files will be stored for publication.
Each web server hosts one or more platforms, which act as publishing points for the hosted sites.
If you are not intending to use Hostmaster in a distributed fashion, you will not need to create
additional web servers for your purposes..");
break;
case 'db_server' :
return t("The database server on which sites will host their date.
Most web servers and database servers are on the same machine, but for performance reasons
external database servers might be required. It is not uncommon for one database server
to be shared amongst all site instances.
If you are not intending to use an external database server, or multiple database servers, you
will not need to create any additional database servers for your purposes.");
break;
case 'task' :
return t("The mechanism whereby Hostmaster keeps track of all changes that occurr to the system.
Each task acts as a command for the back end, and contains a full log of all changes that have occurred.
If an task should fail, the administrator will be notified with an explanation of exactly what went wrong,
and how to fix it.");
break;
}
}