Installing OpenX

OpenX provides an install wizard that guides you through the installation process and makes sure that your system is set up correctly. If the wizard detects that OpenX already exists on the system, additional upgrade tasks are performed. See also: Upgrading OpenX

Installing OpenX

To install OpenX for the first time:

  • Review the system requirements
  • Choose the type of installation
  • Prepare for the installation
  • Perform the installation
  • Secure the installation
  • Schedule maintenance to run

Preparing for an installation

If you have not already done so, review the system requirements and have the following information ready to provide during the installation:

  • If you intend to use an FTP client to upload OpenX to the server you'll need:
    • the name of the FTP server
    • the FTP account username
    • the FTP account password
  • For the OpenX database you'll need:
    • Database server name
    • Port number
    • Database username
    • Database password

Download OpenX

Download the latest version of OpenX from the OpenX website to your local computer. Unpack the archive (the unpacked directory will be named something similar to 'OpenX vX.X.XX'). Remove the numbers from the filename to make it easier to navigate to OpenX, and also to simplify future upgrades.

Copy OpenX to your server

Upload the OpenX directory in the standard way you load files to your server, for example FTP or SCP. Load the directory to a location on your server that is accessible from a browser. For example, if your web server structure is /var/www/html/ you can place your extracted folders and files in /var/www/html/openx, then access it with the www.example.com/openx URL.

When you have uploaded OpenX to the server, open a web browser and visit your OpenX website to launch the installation wizard.

Running the installation wizard

The OpenX install wizard guides you, step-by-step, through each stage of the install process.

To start the installer, open a web browser and navigate to the directory where OpenX is stored. For example: www.example.com/openx.

If the installer does not start automatically, perhaps your web server does not allow PHP files to be used as the index file in a directory. To start the installer manually, navigate to the index.php file in the admin directory. For example /openx/admin/index.php.

The wizard guides you through the following sections:

Welcome

The Welcome page tells you which version of OpenX you are going to install and links to the available documentation and support.

Click Continue to proceed to the Terms page.

Terms

The Terms page provides important information about the OpenX licence. Before you continue with the installation you are advised to read and agree to the terms and conditions of the GPL license.

Click Accept to proceed to the Policy page.

Policy

The Policy page describes the OpenX Privacy and Data Usage policy. Please review this information to learn about the data that OpenX collects and how it is used. You must agree with this policy before continuing with the upgrade. In the Synchronisation settings section tick the Check for Updates checkbox if you want to receive software update alerts in OpenX.

Click I Agree to proceed to the System Check page.

System Check

The System Check checks that the PHP setup is correct, that correct file permissions are set for OpenX folders, and whether a previous version of OpenX exists. All issues are reported in the PHP, File permissions and Application Check sections at the bottom of the page. You must resolve all reported issues and run another system check before you can proceed.

PHP setup

If you prepared your system correctly, there will be no issues with the PHP setup.

See also: System requirements for information about the PHP requirements.

Permission to write to OpenX folders

OpenX needs permission to write to many files in the system. The system check verifies the permissions set for application folders and lists folders with incorrect permissions in the File Permissions section. The list includes shell commands you can enter to correct these permissions. Alternatively, in an FTP client, change the CHMOD setting to 0777 for each problematic folder. If you cannot find where to set these values in your FTP client look for a menu entry for permissions or properties, or consult the documentation for the application.

Completing the system check

You must resolve all reported issues before you are allowed to proceed. When the system is configured correctly, you can click Continue to proceed.

Database Setup

In the Database Setup page, enter the details necessary to connect to your database. If you do not know these details, contact your website administrator or ISP.

Click Continue to open the Configuration Setup page.

Configuration Setup

The Configuration Setup page provides some extra configuration options. Most publishers do not need to change any of these options. Review the settings to ensure that they are correct and click Continue to proceed.

Admin setup

Enter a username, password, and contact email address for the administrator. This account sets up the "super admin" user, who will have full control over your OpenX installation. Ensure that the username and password are memorable and keep a secure record of them. Click Continue when you are finished.

The Password Recovery section in Managing passwords explains how to reset your password if you forget it.

Data setup

In the Data Setup page, you can choose to add a sample inventory to your database. This is a useful way to learn the relationship between advertisers, campaigns, and banners, and to see how zones are set up. Click Continue to proceed.

Finished

When the installation is complete, the OpenX login page is displayed.