Page History

...

• Apache VCL 2.2.1 has been downloaded
• VCL database has been installed and configured

Web Server:

• Apache HTTP Server v1.3 or v2.x with SSL enabled
• PHP 5.0 or later
  Note: The VCL web frontend may run under other web server platforms capable of running PHP code, but has only been tested to work with Apache HTTP Server.

Required Linux Packages:

• libmcrypt - Encryption algorithms library

Required PHP Modules:

modules (some Some of these may already be included with your PHP distribution):

• php-gd
• php-json (required if your PHP version is 5.2 or later)
• php-mcrypt
• php-mysql
• php-openssl
• php-sysvsem
• php-xml
• php-xmlrpc
• php-ldap (if you will be using LDAP authentication)

1. Install the Required Linux Packages & PHP Modules

   If your web server is running a Red Hat-based OS, the required PHP modules can be installed with:

   Panel
   % yum install httpd mod_ssl php-gd php-mcrypt php-mysql php-xml php-xmlrpc php-ldap -y

   • If you will be using a self-signed certificate for SSL, this is a great HOWTO explaining how to set it up on CentOS
   • It is useful to configure the server set up to be able to send debugging emails

2. Configure & Start the Apache Server Daemon

   Panel
   /sbin/chkconfig --level 345 httpd on /sbin/service httpd start

3. Install the VCL Frontend Web Code

   1. If you have not already done so, download and extract the source files on the web server:

      Panel
      wget http://www.apache.org/dist/incubator/vcl/apache-VCL-2.2.1-incubating.tar.bz2 tar -jxvf apache-VCL-2.2.1-incubating.tar.bz2

   2. Copy the web directory to a location under the web root of your web server:

      Panel
      cp -r apache-VCL-2.2.1-incubating/web/ /var/www/html/vcl

   3. Copy or rename secrets-default.php to secrets.php:

      Panel
      cp /var/www/html/vcl/.ht-inc/secrets-default.php /var/www/html/vcl/.ht-inc/secrets.php

   4. Edit the secrets.php file:

      Panel
      vi /var/www/html/vcl/.ht-inc/secrets.php

      • Set the following variables to match your database configuration:
        • $vclhost
        • $vcldb
        • $vclusername
        • $vclpassword
      • Create random passwords for the following variables:
        • $mcryptkey
        • $mcryptiv (must be 8 hex characters)
        • $pemkey
      • Save the secrets.php file
   5. Run the genkeys.sh script, enter the value you set for $pemkey in secrets.php as the passphrase (3 times, copy/paste is a good idea)

      Panel
      /var/www/html/vcl/.ht-inc/genkeys.sh

   6. Copy or rename conf-default.php to conf.php:

      Panel
      cp /var/www/html/vcl/.ht-inc/conf-default.php /var/www/html/vcl/.ht-inc/conf.php

   7. Modify conf.php to match your site

      Panel
      vi /var/www/html/vcl/.ht-inc/conf.php

      • COOKIEDOMAIN needs to be the domain name your web server is using or left blank if you are only accessing the web server by its IP address
      • IMPORTANT: You really do need to modify every entry in the "Things in this section must be modified" part of the file
   8. Set the owner of the .ht-inc/maintenance directory to the web server user (normally 'apache'):

      Panel
      chown apache /var/www/html/vcl/.ht-inc/maintenance

   9. Open the testsetup.php page in a web browser:
      • If you set up your site to be https://my.server.org/vcl/ open https://my.server.org/vcl/testsetup.php
      • Debug any issues reported by testsetup.php

4. Log In to the VCL Website

   1. Open the index.php page in your browser (https://my.server.org/vcl/index.php)
      • Select Local Account
      • Username: admin
      • Password: adminVc1passw0rd
        ** TIP: Now would be a good time to change the password from the default by going to User Preferences

5. Add a Management Node to the Database

   1. Click the Management Nodes link
      1. Enter the hostname and IP address of your management node
      2. Click Add
      3. Fill in these additional required fields:
         • SysAdmin Email Address - error emails will be sent to this address
         • Install Path - this is parent directory under which image files will be stored - only required if doing bare metal installs or using VMWare with local disks
         • End Node SSH Identity Key Files - probably just enter "/etc/vcl/vcl.key"
      4. Optionally, fill in these fields:
         • Address for Shadow Emails - End users are sent various emails about the status of their reservations. If this field is configured, copies of all of those emails will be sent to this address.
         • Public NIC configuration method - this defaults to Dynamic DHCP - if DHCP is not available for the public interface of your nodes, you can set this to Static. Then, the IP configuration on the nodes will be manually set using Public Netmask, Public Gateway, Public DNS Server, and the IP address set for the computer under Manage Computers
   2. Click Confirm Management Node
   3. Click Submit
   4. Click the "Management Nodes" link
      1. Select Edit Management Node Grouping
      2. Click Submit
      3. Select the checkbox for your management node
      4. Click Submit

...