Getting Started

This documentation is intended for an audience that is familiar with CFML. It is also assumed the reader has a basic knowledge of how ArangoDB works.

Prerequisites:

• Have a running Railo/Coldfusion server (http://getrailo.org/download)
• Have a running ArangoDB server (http://www.arangodb.org/download)

Add the CFArango library to your application

CFArango is now available on the Railo extension store - install at either the server or the web level based as needed. Otherwise, follow the steps outlined below:

1. Clone the repository:

   git clone https://github.com/dajester2013/CFArango.git

2. Add mapping to the code (not necessary if project is cloned into your project/webserver root). Use one of the following methods:
   1. Railo/ACF Application.cfc mapping:

   this.mappings["/org"] = [/path/to/CFArango]/org

   2. Railo Component resource mapping:
      • Navigate to the administrator page (server or web depending on how wide you desire access)
      • Under Archives & Resources > Component, add a resouce:
        • Name = cfarango
        • Resource = /path/to/CFArango (NOTE: do not add the /org to the resource path!)
      • Can be set in Application.cfc

      this.componentpath = ["/path/to/CFArango"];

   3. ACF custom tag path
      • Add /path/to/CFArango to the custom tags path
        • Can be set in the Administrator under Extensions > Custom Tag Paths
        • Can be set in Application.cfc

        this.customtagpaths="/path/to/CFArango";

Next steps

Head over to the Getting Connected page to see a sample connection configuration.