Skip to content
Browse files

Added build and updated README.md to include installation instructions.

  • Loading branch information...
1 parent e5031c0 commit 36ad437e8ddf9c76e36a7f2250d9e14c2b425d70 @nmische committed Jun 15, 2012
Showing with 28 additions and 1 deletion.
  1. +15 −1 README.md
  2. +13 −0 build.xml
View
16 README.md
@@ -3,7 +3,21 @@ ColdFusion Configuration Manager
The ColdFusion Configuration Manager provides remote access to setter functions in the [ColdFusion Administrator API](http://help.adobe.com/en_US/ColdFusion/9.0/Admin/WSc3ff6d0ea77859461172e0811cbf364104-7fcf.html) via a very simple wrapper API.
-To set a value simply post a JSON document to /CFIDE/administrator/configmanager/api/index.cfm including administrator credentials via basic authentication. The JSON document should identify the administrator api component, method, and method invocation arguments. For example, to call the `runtime.cfc`'s `setCacheProperty` method with and argument collection of `{ propertyName="TrustedCache", propertyValue=true }` you would post the following JSON.
+Installation
+------------
+
+Download the configmanager.zip file and extract to a folder named `configmanager` under the ColdFusion Administrator directory. You can optionally create a link to the extension by adding the following to the Administrator's `custommenu.xml`.
+
+ <submenu label="Configuration Manager">
+ <menuitem href="configmanager/index.cfm" target="content">Recent Changes</menuitem>
+ </submenu>
+
+For more information see the [Custom Extensions](http://help.adobe.com/en_US/ColdFusion/9.0/Admin/WSc3ff6d0ea77859461172e0811cbf3638e6-7fbf.html) section of the ColdFusion Administrator documentation.
+
+Usage
+-----
+
+To set a configuration value simply post a JSON document to /CFIDE/administrator/configmanager/api/index.cfm including administrator credentials via basic authentication. The JSON document should identify the administrator api component, method, and method invocation arguments. For example, to call the `runtime.cfc`'s `setCacheProperty` method with and argument collection of `{ propertyName="TrustedCache", propertyValue=true }` you would post the following JSON.
{
"runtime" : {
View
13 build.xml
@@ -0,0 +1,13 @@
+<project name="cf-configmanager" basedir="." default="buildzip">
+
+ <target name="clean">
+ <delete file="${basedir}/configmanager.zip"/>
+ </target>
+
+ <target name="buildzip" depends="clean">
+ <zip destfile="${basedir}/configmanager.zip"
+ basedir="${basedir}"
+ excludes=".*/**,.*,settings.xml,build.xml,tests/**" />
+ </target>
+
+</project>

0 comments on commit 36ad437

Please sign in to comment.
Something went wrong with that request. Please try again.