First, obviously, you will want to get the Serenity Application Platform™. The latest stable can always be downloaded from the following location: http://labs.e29inc.com/dist/index.php/serenity.html

If you are using a *nix server with command line access, you can directly download the package to your server via the following command:

wget http://labs.e29inc.com/dist/index.php/serenity.html

After the package has finished downloading, unpack it using unzip, Winzip, etc.

For server installations, we recommend using Apache Ant with the included build scripts. If that configuration is not possible, Serenity can still be deployed by hand.

Using Apache Ant

After unpacking SerenityAP, there will be a build.properties file and build.xml file in the root directory, along with a sql folder and htdocs folder.

Open the build.properties file in your favorite text editor and change the following line:

dir.deploy=/path/to/web/server

To the location of your web root. On *nix machines it is usually under /var/www/html, on Windows it is sometimes under C:\Inetpub\www

Save the file and then execute the following command:

ant install serenityap

This will execute the build script and deploy Serenity to the directory you specified in the build.properties file.

The script will output information relating to the build process and then exit.

Manually Deploying

After unpackaging SerenityAP, copy the contents of htdocs/ to your web root.

Change the htaccess.txt file name to .htaccess

Change the permission mask on cache/ and all it's contents to 755

Currently SerenityAP ships with only MySQL 3.23+ support. The other drivers are considered Alpha quality, and will be released as a bundle at a later time.

SerenityAP does not have a web based installer, namely because this is not a product, but a platform to build products on. The initial tables have to be created by running the SQL script contained in the sql/install folder.

Fresh Installs Only

Find the SQL file that corresponds to your database system and load it into the database system, such as MySQL using a web-based utility or the command line.

Upgrading a previous version

Please view the upgrade instructions found here.

Once the database has been created, open config.php in your text editor and change the following two blocks to match the server and database details:

// @root
 
$INFO['root']['driver'] = 'mysql';
$INFO['root']['host'] = 'localhost';
$INFO['root']['port'] = '';
$INFO['root']['user'] = 'root';
$INFO['root']['pass'] = '';
$INFO['root']['dbname'] = 'rhapsody';
$INFO['root']['output_driver'] = 'sgen';
 
// @xhr
$INFO['app_xhr']['driver'] = 'mysql';
$INFO['app_xhr']['host'] = 'localhost';
$INFO['app_xhr']['port'] = '';
$INFO['app_xhr']['user'] = 'root';
$INFO['app_xhr']['pass'] = '';
$INFO['app_xhr']['dbname'] = 'rhapsody';
$INFO['app_xhr']['output_driver'] = 'xml';

Save the file. Serenity AP is now setup and ready for it's first application.

Next up: Creating the Application