README

Owned by Geoff Bowers
Last updated: Aug 09, 2008Version comment

Distribution readme.txt

This is a working paper for a comprehensive readme.txt to be included in the application root of the FarCry Community code distribution. Your feedback is appreciated.

License

FarCry is licensed under the GPL 3.0. Commercial options are available from Daemon Pty Limited.

add: information about plugin and skin/theme licensing under LGPL

Systems Requirements

We're always doing our best to get folks involved in the FarCry community, and to that end we've invested heavily in making FarCry available on all sorts of systems:

  • FarCry runs on Adobe ColdFusion, New Atlanta Bluedragon, and Railo, incorporating a range of ColdFusion application servers, from commercial options, to those that are free for community use.
  • FarCry supports Linux, Solaris, Windows, and OSX (basically anything you can get a ColdFusion server running on).
  • FarCry works with mySQL, Postgres, Oracle and MS SQL database servers.

Installation

The Fortress Release Requires An Updater

Fortress has a modified installer that accommodates all of the underlying schema changes that are part of the 5.0 release. You cannot use Fortress with an existing FarCry project without modification.

Simple Install From Webroot

  • Make sure you do not have a web mapping for /farcry (if you do, remove it now)
  • Download the latest milestone release (http://www.farcrycore.org/go/download)
  • Unpack the zip in to a folder called ./farcry under the webroot
  • You should have ./farcry/core, ./farcry/projects, ./farcry/plugins, ./farcry/skeletons when you are done
  • Create a blank database and point a datasource to it in CF Administrator
  • Browse to http://localhost/farcry or equivalent
  • Follow the installer instructions on your screen
  • Yep. It's that easy.

CRITICAL: Remove Old FarCry CF Mappings

If you are installing farcry framework under the webroot, make sure you do not have a coldfusion mapping for /farcry. This may be the case if you are installing on a server where a previous version of FarCry was installed.

There are four Deployment Configurations supported by the Fortress installer:

  • Standalone
  • Sub-Directory
  • Advanced: CF Mapping
  • Advanced: Web Server Mapping

Getting Started

We've recently released Daemon's entire FarCry Developer Course (130+ pages) under Creative Commons. We hope this will go a long way to helping developers become familiar with the platform quickly.

Support Options

The community itself is a vibrant and friendly place. We provide as many services as we can to help people learn, participate, and see what's going on in the code base day to day:

forums
bug tracking
fisheye for code tracking
crucible for peer code review (running under fisheye)
documentation wiki

And of course, Daemon provides a range of commercial support, development, and training services for companies investing in FarCry as a platform for their online business.