Distribution README.txt
This comprehensive README.txt is included in the application root of the FarCry Community code distribution. The most recent version of this document can always be found at: https://farcry.jira.com/wiki/display/FCDEV60/README
TODO:
- better define links to deployment options
- explain the contents of the distribution vs the libraries
TODO:
- better define links to deployment options
- explain the contents of the distribution vs the libraries
License
FarCry is licensed under the GPL 3.0. Commercial options are available from Daemon Pty Limited. An exception is provided for the inclusion of LGPL licensed FarCry plugins, and graphical themes.
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, OpenBD, 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 MSSQL database servers (additional database platforms are under consideration)
Installation
There is a more comprehensive installation guide online at: https://farcry.jira.com/wiki/display/FCDEV60/FarCry+6.x+Installation
Upgrading from Earlier Versions
You may need to run an updater or perform code changes to your project customisations if upgrading from earlier versions. The exception to this is maintenance releases – these should never require developer intervention beyond restarting the application.
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.
https://farcry.jira.com/wiki/display/FCDEV60/Book+of+FarCry
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:
- Community website: http://farcrycore.org
- forums: http://groups.google.com/group/farcry-dev
- bug tracking: http://farcry.jira.com
- fisheye for code tracking: https://farcry.jira.com/source/browse
- documentation wiki: https://farcry.jira.com/wiki/display/FCDEV60
Commercial Support
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. http://www.daemon.com.au/