FuseGuard Web Application Firewall for ColdFusion
=====================================================================
Installation Instructions
=====================================================================
Step 1 - Read and Agree to the License.txt file.
---------------------------------------------------------------------
Step 2 - Create a database 
---------------------------------------------------------------------
Note: you can configure fuseguard to work without a database but 
certain features will not work (such as web based log viewing and configuration edit).

FuseGuard will use 6 tables, all tables are named with the prefix: fuseguard_. You can either add these tables to an existing database or create a new one (recommended). 

There are SQL database creation scripts in the sql folder of this zip file. 

	If you are using SQL Server run: sql/sqlserver.sql script 
	For MySQL run: sql/mysql.sql 
	For PostgreSQL run: sql/postgresql.sql
	For Oracle run: sql/oracle.sql
	Otherwise if on Adobe CF8+ run: sql/derby.cfm to use the embedded Derby Database engine.

The database user only needs permission to SELECT, INSERT, UPDATE, DELETE

For added security you can make the fuseguard_log table INSERT only.

---------------------------------------------------------------------
Step 3 - Create a datasource 
---------------------------------------------------------------------
Create a datasource (for example using the ColdFusion Administrator)
for FuseGuard pointing to the database used in step 2. 

The default datasource name is "fuseguard" but you can specify
any datasource name you want by editing a configurator CFC.

The datasource only needs permission to SELECT, INSERT, UPDATE, DELETE

---------------------------------------------------------------------
Step 3 - Copy the /fuseguard/ folder to site root (or mapping)
---------------------------------------------------------------------
Copy the fuseguard directory onto your web site root directory. 

If you are configuring multiple CFML applications you should create
a CF mapping instead of copying the folder into multiple directories.

---------------------------------------------------------------------
Step 4 - Edit Configurator
---------------------------------------------------------------------
If you need to specify any custom configuration create a new configurator:

Copy the file 
	"fuseguard/components/configurators/ExampleConfigurator.cfc" 
	to 
	"fuseguard/components/configurators/MyConfigurator.cfc" 

Edit the it to match the needs of your web application. 


---------------------------------------------------------------------
Step 5 - Add Code to Application.cfm or Application.cfc
---------------------------------------------------------------------

IF you are using Application.cfc:

a) In your <cfcomponent> tag add extends="fuseguard.components.FuseGuardApplication" (if your Application.cfc already extends another component simply copy the fuseguard function definition into your Application.cfc instead of changing your extends attribute.)
b) Edit your onRequestStart or onRequest function to invoke fuseguard()

For example:

<cfcomponent extends="fuseguard.components.FuseGuardApplication">
	<cffunction name="onRequestStart" returntype="boolean">
		<cfset fuseguard(configurator="DBConfigurator", scope="server")>
		<!--- your custom onRequestStartCode goes here --->
		<cfreturn true>
	</cffunction>
</cfcomponent>

Be sure not to have multiple onRequestStart functions in your Application.cfc

IF you are using Application.cfm files, insert the following on top, just below your <cfapplication> tag: 

<cfif NOT structKeyExists(server, "fuseguard") OR server.fuseguard.shouldReInitialize()>
	<cfset server.fuseguard = new fuseguard.components.firewall(configurator="DefaultConfigurator")>
</cfif>
<cfset server.fuseguard.processRequest()>

You may now login at /fuseguard/manager/ to view reports

=====================================================================
Important Notes:
=====================================================================
Be sure that the code is placed before any other custom code in your 
Application.cfm or Application.cfc file.

The /fuseguard/ folder does not need to be placed under the web root,
you can setup a CF mapping for it. Additionally it doesn't need to be called /fuseguard/ it 
could be placed anywhere. 

You can move/rename the /fuseguard/manager/ folder anywhere you want under
the web root.

Changes to your Configurator will not effect the firewall until it 
is reinitialized. You can do this in the web manager or by running
the following code:
 	server.fuseguard.reconfigure("YourConfiguratorName")

You can run FuseGuard in any scope, server, application or request.

=====================================================================
NEED HELP:
=====================================================================

If you are having trouble installing it, please contact us we are 
happy to help. https://foundeo.com/contact/

=====================================================================
Copyright (c) 2009-2019 Foundeo Inc.