Booked Installation

Prerequisites

Note: for users without web hosting service or existing environment, packages like XAMMP or WampServer can help you get set up quicky.

Fresh Installation

Application Deployment to Server

Application Configuration

You can configure Booked to fit your environments and needs, or use the minimal default settings which should be enough for the application to work. We recommend you to change according to your specifics. Additional information on all configuration settings can be found in the application help page. Note: If you try to load the application at this time (eg. http://yourhostname/booked/Web/), you will probably get a white page. This is because there is no backend database configured yet. So continue on ...

Database Setup

You have 2 ways to set up your database for the application to work.

Automatically

You must have the application configured correctly before running the automated install.
OR

Manually

The packaged database scripts make assumptions about your desired database configuration and set default values. Please edit them to suit your environment before running. The files are located in booked/database_schema/.

Import the following sql files in the listed order (we recommend phpMyAdmin for this):

On a remote host with no database creation privileges

If you are installing Booked on a remote host, please follow these steps. These steps assume you are using cPanel and have the ability to create databases via the cPanel tool and phpMyAdmin.

Adding the database and user

Creating tables

If you have database creation privileges in MySQL

You are done. Try to load the application at (eg. http://yourhostname/booked/Web/).

Registering the Administrator Account

After the database has been set up you will need to register the account for your application administrator. Navigate to register.php register an account with email address set in $conf['settings']['admin.email'].

Upgrading

Upgrading from a previous version of Booked 2.x (or phpScheduleIt 2.x)

The steps for upgrading from a previous version of Booked are very similar to the steps described above in Application Deployment to Server.

Recommended

The recommended approach is to backup your current Booked files, then upload the new files to the that same location. This prevents any old files from interfering with new ones.

After the new files are uploaded, copy your old config/config.php file to the config directory in the new version. Then run /Web/install/configure.php to bring your config file up to date.

If you have any uploaded resource images you will need to copy them from their old location to the new one.

Alternative

An alternative upgrade approach is to overwrite the current Booked files with the new ones. If doing this, you must delete the contents of /tpl_c. This approach will not allow you to roll back and will not clear out any obsolete files.

Database

After the application files have been upgraded you will need to upgrade the database.

Automatically

The automatic database upgrade is exactly the same as the automatic database install. Please follow the instructions in the Automatic Database Setup section above.

Manually

The packaged database scripts make assumptions about your desired database configuration and set default values. Please edit them to suit your environment before running. The files are located in booked/database_schema/upgrades.

Depending on your current version, import the upgrade.sql file within each subdirectory to get to the current version (we recommend phpMyAdmin for this).

For example, if you are running version 2.0 and the current version is 2.2 then you should run booked/database_schema/upgrade/2.1/upgrade.sql then booked/database_schema/upgrade/2.2/upgrade.sql

Migrating from version 1.2

A migration from 1.2 to 2.0 is supported for MySQL only. This can be run after the 2.0 installation. To run the migration open /Web/install/migrate.php directory in a web browser and follow the on-screen instructions.

Getting Started

The First Login

There are 2 main types of accounts, they are admin and user account.

Log Files

Booked logs multiple levels of information categorized into either application or database logs. To do this, the log4php library is used. By default, logging is turned OFF.

Enabling Booked API

Booked has the option to expose a RESTful JSON API. This API can be leveraged for third party integration, automation or to develop client applications.

Prerequisites

Configuration

API Documentation

Auto-generated documentation for API usage can be found by browsing http://your_booked_url/Web/Services. This documentation describes each available service, indicates whether or not the service is available to unauthenticated users/administrators, and provides example requests/responses.

Consuming the API

If URL rewriting is being used, all services will be available from http://your_booked_url/Web/Services
If not using URL rewriting, all services will be available from http://your_booked_url/Web/Services/index.php

Certain services are only available to authenticated users or administrators. Secure services will require a session token and userid, which can be obtained from the Authentication service.

Support

Please post any questions or issues under the Booked 2 section of the forums on http://php.brickhost.com/forums. Here you may also find some answers to your questions previously asked by other people.