Offers Installation

Installation instructions for the Offers web application.

Dependencies

• php >= 5.3.x
• mysql >= 5.1.x (also tested with MariaDB >= 5.2.x)
• python-sphinx (to build documentation)
• git (to clone directly from the repository)

Required php modules:

• gd
• ldap
• mysql-pdo
• openssl
• soap

Get source code

Get the source code from the git repository (clone) or a release tag. Also, the CakePHP bootstrap-helper is required, see Deploy on how to download it as a git submodule or from a relsease tag.

Repositories:

• Offers (coupons.git - also contains CakePHP framework)
• Offers documentation (coupons-docs.git)
• CakePHP framework
• CakePHP bootstrap-helper

Deploy

Application setup:

• List of required configuration files and a list of the most important options.
• Permissions.
• Git submodules.

Configuration files

Rename each *.php.default file to *.php and edit accordingly if required.

• bootstrap.php.default

• configuration.php.default

  • APP_URL: set the application url (eg: http://offers.teiath.gr) no trailing slash here.
  • ISSUE_URL: redmine url
  • ISSUE_TOKEN: redmine’s user access token
  • ISSUE_PROJECT_ID: redmine project id to post issues to (project must have an issue tracker).
  • ADMIN_EMAIL: email for application’s administrator
  • MAX_OFFER_IMAGES: maximum number of images allowed in offers.
  • MAX_COMPANY_IMAGES: maximum number of images allowed in company profile.

• core.php.default

  • contains salt and hash algorithm settings - keep it safe.

• database.php.default

  • database settings - set database name/credentials
  • encoding: set to utf8.

• email.php.default

  • configure application email address / email charset etc

• ldap.php.default

  • LDAP settings - set ldap credentials here
  • if using LDAP with SSL remember that the port should remain empty and all parameters should be in the server directive in a form of url. eg: ldaps://foo.com:port. See: ldap_connect().

Permissions

The following folders must be writable from the http user (or the relevant user that run the webserver).:

app
|-- tmp
    |-- cache
    |   |-- models
    |   |-- persistent
    |   `-- views
    `-- logs

Git submodules

The application’s front-end uses Twitter’s Bootstrap through a CakePHP helper. This helper is not optional. It resides inside the plugins folder found in the project’s root directory as a git submodule. In order to fetch the helper, after the first clone run:

$ git submodule init
$ git submodule update

To keep up-to-date run:

$ git submodule foreach git pull

Note that this will fetch any other posible git submodules used by the application. See the project’s .gitmodules file for more information.

Database

Database setup:

• From command line
• From PHPMyAdmin

From command line

Run the setup script found in schema/reset-db.sh and provide the root username/password for your database when prompted. The database scripts assume you have the right to create databases. The default database created is named opendeals.

From PHPMyAdmin

1. import opendeals.sql
2. import days.sql
3. import counties.csv, skiping the 1st row
4. import municipalities.csv skipping the 1st row and re-arranging columns properly
5. import offercategories.sql

Cron scripts

• new_offers.sh

  • notify users for new offers
  • run: once / day a little after 00:00.

• notify_improper.sh

  • notify users for offers marked as spam (only if user has related coupons)
  • run every: 6 hours.

• remove_old_visits.sh

  • cleanup old status
  • run every: 3 days or longer.

• update_state.sh

  • check offer end time and mark finished offers as “finished”
  • run at least every: 15 min.

• update_total_stats.sh

  • calculate total stats for previous day
  • run: once / day a little after 00:00.