Home

Install and upgrade wizard

The OpenX install wizard guides you, step-by-step, through each stage of the install or upgrade process. The wizard performs both new and upgrade installations because it checks if a previous version exists and performs additional upgrade tasks if an earlier version is detected. This section describes both new and upgrade installations.

To start the installer, open a web browser and navigate to the directory where OpenX is stored, for example, http://www.example.com/openx. If the installer does not start automatically, perhaps your web server does not allow PHP files to be used as a directory index. 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:

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

Welcome

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

Click Continue to proceed to the Terms page.

Terms

The Terms page provides important information about the OpenX license. 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 your copy of OpenX to alert you to software updates.

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. The PHP setup requirements are described in the System Preferences page.

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 Help files for the application.

Schema check

Upgrade only

If a previous version of OpenX is detected, the wizard checks the database schema to ensure that it has all the correct tables, columns and indexes for this version of OpenX. If any elements are missing, a general description is provided by the system check and you can find the names of the missing elements in the install.log in the /var directory.

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.

Login

Ugrade only

Type the administrator username and password of your existing system in the appropriate fields and click Continue to proceed to the Database Setup page.

Database Setup

New install only

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.

Upgrade only

The Database Setup page displays database settings detected from your existing installation. Check the settings to ensure they are correct. If the settings are not correct, amend them in your configuration file and go back to the start of the install and upgrade wizard. When you are satisfied the settings are in order, click Continue to start the process of altering your database. This process can take some time. When the process is finished, the screen updates to report that your database has been upgraded successfully.

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

New install only

Enter a username, password and contact email address for the administrator. This account sets up the 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.

Data setup

New install only

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

Finished

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

Password recovery

If you forget your login password, to reset your password:

  1. At the login screen, enter your username
  2. Click the "Forgot your password?" link to display the Password Recovery page.
  3. Type the administrator email and click Proceed:
  4. The screen refreshes and reports the "Recovery email sent".
  5. Click the Password reset link.
  6. In the Password reset page, enter a new password in the Password field and confirm it in the Repeat Password field, then click Proceed.
  7. You can log in with your existing Username and the Password that is sent to you by email.