|
|
| (62 intermediate revisions by 11 users not shown) |
| Line 1: |
Line 1: |
| = CDash Installation =
| | [[CDash | < CDash Main Page]] |
| ''Note: CDash is currently in beta, and no official documentation has been released yet, hopefully these unofficial notes are enough to get you started.''
| |
|
| |
|
| CDash is a [http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] application, running on [http://www.apache.org/ Apache] using [http://www.php.net/ PHP] to access a [http://www.mysql.com/ MySQL] database. | | CDash is a [http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP] application, running on [http://www.apache.org/ Apache] using [http://www.php.net/ PHP] to access a [http://www.mysql.com/ MySQL] or [http://www.postgresql.org PostgreSQL] database. |
|
| |
| == System Requirements ==
| |
| * Apache
| |
| * MySQL database (5.x and higher)
| |
| * PHP (5.0 recommended)
| |
| * XSL module for PHP
| |
| * cURL module for PHP (for site statistics)
| |
| * GD module for PHP (for regression tests)
| |
|
| |
|
| == Downloading CDash ==
| | Please visit [https://github.com/Kitware/CDash our GitHub repository] for download links and installation instructions. |
| Currently CDash is only available from the development [http://subversion.tigris.org/ Subversion] repository. Either extract the code into your web server tree, or another directory which will later be copied to the web server:
| |
| | |
| cd /srv/www/htdocs
| |
| svn co https://www.kitware.com:8443/svn/CDash/trunk CDash
| |
| | |
| Note: If this fails ensure any firewall allows outgoing access to port 8443.
| |
| | |
| == Configuration ==
| |
| The system configuration is stored in <tt>.../CDash/config.php</tt>, edit this with your favorite ASCII editor.
| |
| | |
| === Database ===
| |
| If you are running the MySQL database on the same server as the Apache web server the defaults should work with no changes:
| |
| | |
| // Hostname of the MySQL database
| |
| $CDASH_DB_HOST = 'localhost';
| |
|
| |
| // Login for MySQL database access
| |
| $CDASH_DB_LOGIN = 'root';
| |
|
| |
| // Password for MySQL database access
| |
| $CDASH_DB_PASS = '';
| |
| | |
| // Name of the MySQL database
| |
| $CDASH_DB_NAME = 'cdash';
| |
| | |
| === Email ===
| |
| You should probably edit the default email addresses:
| |
| | |
| // Default from email
| |
| $CDASH_EMAILADMIN = 'admin@cdash.org';
| |
| $CDASH_EMAIL_FROM = 'admin@cdash.org';
| |
| $CDASH_EMAIL_REPLY = 'noreply@cdash.org';
| |
|
| |
| === Backup directory ===
| |
| The backup/log directory by default is placed in <tt>.../CDash/backup</tt>, this must be made writable by the account that you run Apache under (typically wwwrun), you can move the directory via:
| |
| | |
| // Backup directory
| |
| $CDASH_BACKUP_DIRECTORY = 'backup';
| |
| | |
| === Google Maps ===
| |
| CDash can use [http://code.google.com/apis/maps/ Google maps] to display the location of submission sites. CDash comes with Kitware's which won't work for your site's URL. Every site that uses Google maps requires its own [http://code.google.com/apis/maps/signup.html Google maps key] which you should obtain, use this style URL when applying for a key:
| |
| | |
| http:://cdash.mysite.org/CDash
| |
| | |
| Paste your newly obtained key in place of Kitware's:
| |
| | |
| $CDASH_GOOGLE_MAP_API_KEY['localhost'] = 'paste key here';
| |
| | |
| If your submission machines uses private IP addresses you can add default location information, e.g. for all machines in the 192.x.x.x network (use http://maps.google.com to obtain your location):
| |
| | |
| $CDASH_DEFAULT_IP_LOCATIONS[] = array("IP" => "192.*","latitude" => "42.6612","longitude" => "-73.7689");
| |
| | |
| Sometimes site location are misreported (e.g. the ISP's location is used), you can override these:
| |
| | |
| $CDASH_DEFAULT_IP_LOCATIONS[] = array("IP" => "76.65.240.*","latitude" => "43.667","longitude" => "-79.417");
| |
| | |
| You'll probably want to replace the defaults that are present.
| |
| | |
| === Google Analytics ===
| |
| CDash can use [http://www.google.com/analytics/ Google analytics] to monitor site usage. CDash's main <tt>index.php</tt> contains a reference to a default Google analytics code:
| |
| | |
| $CDASH_DEFAULT_GOOGLE_ANALYTICS='UA-701656-6';
| |
| | |
| When you configure each project you will have the opportunity to set a per-project Google analytics code.
| |
| | |
| == RSS directory ==
| |
| Ensure that the <tt>.../CDash/rss</tt> (and <tt>.../CDash/backup</tt>) directory is writable by the user account that Apache runs under (typically wwwrun)
| |
| | |
| == Apache ==
| |
| Ensure that the /srv/www/htdocs/CDash tree is accessible, you have to add the following to your /etc/apache2/conf.d directory:
| |
| | |
| cdash.conf
| |
|
| |
| <Directory /srv/www/htdocs/CDash>
| |
| Order allow,deny
| |
| Allow from all
| |
| </Directory>
| |
| | |
| You may need to restart Apache:
| |
| | |
| rcapache2 restart
| |
| | |
| == Creating database ==
| |
| TBD
| |
