Wiki

Clone wiki

cloudengine / Install

CloudEngine Installation Instructions

Contents

Minimum requirements

  • Apache 2 or IIS.
    • We recommend that you use Apache with mod_rewrite (we have not yet tested on other setups)
    • If you have .htaccess files disabled (AllowOverride none), please copy the contents of .htaccess to the Apache httpd.conf file before installation, and re-start your web server.
  • PHP 5.0 or greater.
    • You need the following PHP extensions: gd2, cURL, MySQL. (You should only need cURL if you want to use either the Twitter or Mollom features).
    • In the php.ini file, you need to set short_open_tag = On
  • MySQL.

Step 1: Check the requirements

Please check the requirements above.

Step 2: Get the code

There are two options for getting the code:

A. Download and unzip

Download and unzip the code within the document root of your web server server. Normally the index.php file will be at your document root but you can put the code in a sub-directory if you wish.

B. Clone the repository

Its fairly easy to install a Mercurial client - see Hg. Then you can clone the public repository, and keep up to date:

hg clone http://bitbucket.org/cloudengine/cloudengine

Step 3: Set up the database

You will need a database user and password with permissions to create and drop tables.

You will also need an empty database. You can either

  • create this empty database yourself (ensure that the database character set and collation are UTF-8) or
  • let the installation script create it for you from the name you will specify later in the database.php file (if you want to follow this option your database user must also have permission to create databases)

Step 4: Set up the data directories

CloudEngine needs a directory to use to store data related to the application such as uploaded images, the search index and log files. We recommend that this directory is outside the document root of your web server.

You need to create this directory and the following subdirectories:

  • logs
  • search/index
  • uploads/cloudscape
  • uploads/user
  • tmp

and make sure that the webserver has write permission for all of these directories.

Windows

For example, you might create:

  • C:\cloudengine_data\
  • C:\cloudengine_data\logs\
  • C:\cloudengine_data\search\index\
  • C:\cloudengine_data\uploads\cloudscape\
  • C:\cloudengine_data\uploads\user\
  • C:\cloudengine_data\tmp

For Windows, the web server should automatically have write permission to the directories once you create them.

Linux

For example, you might create:

  • /var/www/cloudengine_data
  • /var/www/cloudengine_data/logs/
  • /var/www/cloudengine_data/search/index/
  • /var/www/cloudengine_data/uploads/cloudscape/
  • /var/www/cloudengine_data/uploads/user/
  • /var/www/cloudengine_data/tmp

On Linux, you will need to use the chmod/chgrp commands to give apache write access to the directories.

Step 5: Set up the config files

Copy the following files files in system/application/config/ in your installation

  • cloudengine.dist.php, to cloudengine.php
  • config.dist.php to config.php
  • database.dist.php to database.php

In the database.php file

  • Enter the username and password of the database user
  • Enter the name of the database (unless you want the install script to create the database for you)and hostname

In the cloudengine.php file

  • Enter the site email address e.g. $config[‘site_email’] = “support@example.org”
  • Enter the address of your SMTP host.
  • Enter the path to the data directory e.g. $config[‘data_dir’] = “/var/www/cloudengine_data/”; or $config['data_dir'] = 'C:\xampp\htdocs\cloudengine_test_data
    '; Note that for a Windows path you need a double backslash at the end of the path.
  • These are the settings required to install the software - there are lots of other settings in this file that you can edit later.

In the config.php file

  • Set the log path to the directory you created previously e.g. $config[‘log_path’] = “/var/www/cloudengine_data/logs/”
  • Set the encryption key $config['encryption_key'] to a random key of at least 32 characters. See http://codeigniter.com/user_guide/libraries/encryption.html for more on setting your encryption key.

Step 6: Run the install script

To run the install script, go to the URL for your installation in a web browser and add “install/” to the end of the URL, for example if you installed the software in the cloudengine directory of the web root then go to http://<your server>/cloudengine/install/ . Follow the instructions.

Troubleshooting

  • If you encounter a “404 Not Found” error page during installation it probably means that the installer thinks database tables already exist. Check that the database you have specified is empty and try again.
  • If you get a blank page, it probably means that your config.php file contains a syntax error

Step 7: Configure your site

Your installation should now be complete and you should be able to view it at e.g. if you have installed in in the cloudengine directory of the web root, you can view the site at http://<your server>/cloudengine/

  • Look through and edit the configuration options in system/application/config/cloudengine.php For example you can configure:
    • The site name and tag line
    • The files to use for the theme for your site - we suggest you put these in a subdirectory of the themes directory. You can specify a logo, favicon, banner and also a stylesheet which will override corresponding styles in the default stylesheet .
    • Whether various features are turned on or off and the settings for various features
  • The installation contains a sample cloud and two sample cloudscapes. You may wish to delete these.
  • You may wish to edit the profile for the admin user
  • There are also configuration options that you can set in system/application/config/config.php.
  • You can reach the admin panel by pointing your browser at admin/panel in your intallation. You can add content to the support and about sections here. There is a link to terms and conditions in the footer and a link to these on the sign up page, so you may want to make sure that you create and about page for these.
  • To set up multiple languages, see separate instructions available soon.

Step 8: Setting up additional components that you want to use

Please refer to the Configuration page.

Updated