PX:Installation

From Peroxide

This page provides installation instructions for perOXide. We will describe two possible setups, the singular installation and the spawned installation type.

Contents 1 Requirements 2 Installation types 2.1 Singular Installation Style 2.2 Spawned Installation

Requirements

The default installation of perOXide requires a basic installation of PHP5. Nothing more, nothing less, especially PHP4 is no longer supported. We ship a copy of required PEAR classes and libraries we use together with the installation package, so the package is supposed to work on a plain vanilla PHP5 installation. You need the following extra modules for some features:

• XSLT extension, in case you want to make use of the XSLT features.

perOXide has been extensively tested on Windows and Linux operating systems using the Apache2 and IIS web servers and should work on both without any hassle. The database abstraction uses the great ADODb framework so perOXide is supposed to support all databases to the same extent ADODb does. We have thoroughly tested on MySQL only, so we appreciate your feedback on other databases.

Installation types

There are two types of installation, singular and spawned, which differ slightly in how they work. If you don't want to read about the intrinsics of each style, take the following statements as a rule of thumb for choosing your style:

• If you plan to do only a single project with perOXide on the machine you want to install perOXide on, go with the singular installation style.
• If you plan to create multiple projects on the machine you want to install perOXide on, go with the spawned installation style.

Singular Installation Style

This is the easiest way of installing perOXide. Get a copy from our Download section and put the files on your development machine. You should get a structure like this:

/
/adodb_lite
/cache
/content
/engine
/pear
/Config.php
/Permissions.php
/Runner.php
/SpawnConfig.php
/Users.php

Make sure that the folders cache and content and all the files and subfolders within them are writable for the web server. You're halfway done already. Now open up SpawnConfig.php and edit the configuration settings. In 99% all you need to do is setting up the database connection settings and the URL-Schemes to Runner.php and the files located in /content/external. These URL schemes are used by perOXide to create links inside your project so filling them out correctly is quite important, otherwise all the links in your project will not work correctly. The following example should give you an idea what to fill in there. Suppose you have installed perOXide on a path on your server that is bound to http://yourdomain.com/peroxide. Then you have to fill in:

$EXTERNAL_RESOURCE_LINK_SCHEME = "http://yourdomain.com/peroxide/content/external/!!!FILE!!!";

$LINK_SCHEME="http://yourdomain.com/peroxide/Runner.php?".
    "filename=!!!FILE!!!&variant=!!!VARIANT!!!&language=!!!LANGUAGE!!!&!!!PARAMS!!!";

As you can see this isn't exactly difficult. After you have set this up, perOXide is ready to rock and you can start coding your own cool projects. You can take the Basic Tutorial or have a look at our Documentation page if you need help.

Spawned Installation

The spawned installation is in fact not much different from the singular one. The main intention behind it is being easier on upgrades. Suppose you have five projects using perOXide on your machine and a new version with a ton of nice features is released. Then you would have to upgrade five installations of perOXide. Or maybe you are a hoster and want to offer perOXide to your clients so they can write nice programs with it. Then installating a copy for each user isn't probably a very good idea. This is where the spawned installation comes to the rescue. It allows you to install perOXide once and only once on the machine and then create so called spawns which are merely referring to the base installation but consist only of Runner.php and a custom configuration.

This section is yet to be finished...