This guide describes how to install OpenX on your website.
The guide is intentionally brief and describes the most typical installation for new OpenX publishers. The OpenX Administrator Guide provides a more detailed information about installing OpenX.
After completing the installation, you will be ready to integrate OpenX on to your website and publish your first ad campaign.
Note: You may need to contact your website administrator or ISP for help completing the installation checklist.
OpenX will run on most standard web hosting environments. You will need to make sure your webserver includes:
- PHP support
- MySQL or PostgreSQL database
To complete the installation you need to know some configuration details about your web server and database. Make sure you can answer the following questions before you start the installation:
Q: How do I upload files to my web server?
Most people need to use an FTP application to upload files to their web server. To do this you need to know:
- the name of the FTP server
- the FTP account username
- the FTP account password
Q: What are the account details for connecting to my database?
The installation wizard will ask you for details in order to connect to your database. Most OpenX publishers use a MySQL database in which case you need the following details about your database:
- Database server name
- Port number
- Database username
- Database password
To perform the installation you will need to download and unpack the OpenX installation files.
Download the latest installation archive from: here
After downloading, unpack the ZIP file and rename the folder as 'openx'.
Upload OpenX to your webserver
Upload the openx folder to a location on your webserver which you can access from a web browser, for example: 'http://www.yoursite.com/openx'
Most web publishers will need to use an FTP client to upload the openx folder but this depends on your hosting arrangement. Contact your website administrator or ISP if you do not know how to upload these files.
Make the images and var folders writable
OpenX needs to be able to write to the files in the openx/var and openx/www/images folder to complete the installation successfully.
Most publishers will need to use an FTP client to set these permissions but this depends on your hosting arrangement. Since FTP client vary we have only included some general advice on how to do this.
You need to repeat this process for each folder in the openx/var folder, as well as the openx/www/images folder:
Note: If you are having trouble updating these folder permissions you may need to contact your website administrator or ISP for advice.
- Browse to the openx/var and select the folder.
- Look for an option to update the folder permissions. This function is often called chmod or set permissions in the program menu.
- You should see options to set the Owner, Group and Public permissions (see the screenshot of the FireFTP permissions dialog which is typical of FTP clients). Make sure all permissions are writable. Alternatively, set the three digit file permissions number to "0777".
- Repeat this process for the each of the folders in the openx/var folder as well as the openx/www/images folder.
Screenshot of setting file permissions using FireFTP (Firefox plugin)
Run the installation wizard
When all files are uploaded and the folder permissions are set, browse to the location of your openx folder, for example: 'http://www.yoursite.com/openx'
The installation wizard will guide you through the installation process, prompting you for information when required.
The installation steps are:
- Welcome screen
- Terms and conditions
- Privacy and data usage policy
- System check
- Database setup
- Review configuration setup
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.
The Terms page explains the terms and conditions associated with the OpenX ad server.
Click Accept to proceed to the Policy page.
The Policy page describes the OpenX privacy and data usage policy and includes a checkbox to tick to stay up-to-date with the latest software updates.
Click I Agree to proceed to the System Check page.
The System Check page checks your web server settings to ensure that the installation process can complete successfully.
You will need to resolve any configuration alerts before completing the installation. The alert should provide guidance on what needs to be done. Please visit the Administrator Guide for more information about compatibility.
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.
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 complete the installation.
When the installation is complete, OpenX displays the login page of your new ad server.
You should delete the install.php file from the openx/www/admin folder
You have successfully installed the OpenX ad server.
The next step is to integrate OpenX with your website and serve your first ad campaign. We've created a second Quick Start Guide to help you with this process...