Changelogic Installation
Installing Changelogic server software
Changelogic's architecture
Changelogic consists of two parts:
web interface and
build script interface. Mostly everything – expect the operations that operate with your working directory and VCS – can be achieved through web interface.
Web interface (or the server) should be set up on one machine that every project participant can access. Web interface also includes web services that let the build script client know exactly what it should do next.
Changelogic's build script (or the
client) should be included in your projects source tree root and after that, all targets can be executed from developers' working directories.
Note: Changelogic web interface is known to work on Linux servers, but it probably runs on any operating system where all preconditions can be satisfied.
Absolute preconditions
It's inevitable to have:
- Apache web server (Changelogic has been tested with 2.x versions) from http://httpd.apache.org/
- PHP 4.x or 5.x (Changelogic currently does not work with PHP 6.x, please use an older version) from http://www.php.net/
- MySQL (please use MySQL 4.1.x or newer for running Changelogic) from http://www.mysql.com/
- A version control system, at least one of the following:
Note: Please give PHP module minimum of 64 MB of memory (128 MB is recommended) in php.ini (parameter “memory_limit”)
Additional information: it is not required to have VCS server, MySQL and web server installed on the same machine.
Strongly recommended external dependencies
It's strongly recommended to have:
Installation steps
- Once you have the Changelogic installation package, unpack the code to desired directory.
- Create blank database. Changelogic creates the database structure automatically, all you have to do is create new user and a blank database to MySQL server and then configure required parameters from configuration file. Important note: the user under which Changelogic connects to database, should have all privileges to manipulate the database, because the installations scripts do change the structure of database too (this is intended to make installation and upgrades whole lot easier).
- Now you can either allow the web server to write to changelogic_home/resources directory and make the first request from browser – it directs you to a page where you can enter the configuration parameters and generate conf.php file or you can make it old-school way – copy resources/sample_conf.php to resources/conf.php and define required parameters. Important note: don't leave the directory writable after configuration file is generated.
- If you chose the semiautomatic installation, you will be directed to login form, if not, make the first request now. Changelogic creates database and outputs password for user “admin” so you can log on. See our administration page to find out how to add new users, CVS servers etc or proceed to add new project.
Optional features
- To enable to browsing file differences between any two given versions on CVS, you must put the file CLROOT/lib/restricted/get_viewcvs_diff.php in the server, where your VCS resides into path accessible from web and then set the address in Changelogic VCS server registry from user menu->VCS servers. You probably also need to tweak your path to VCS repository and path to rlog tool that are configured in the first lines of file get_viewcvs_diff.php.
Here CLROOT refers to the directory where Changelogic's web interface installation resides in your server (for example /var/www/changelogic).
Installing Changelogic client software
The web interface can be browsed with any web browser supporting CSS and Javascript; any popular browser such as Firefox, IE, Opera, Google Chrome, Safari should do. Changelogic client software is needed only to manipulate source code of your product.
Preconditions
As the client build script must be added to project repository you should proceed to project setup. To start development of your first change you must also configure the build script client.