Difference between revisions of "ADF Installation"
From ADF Docs
(→Get the code) |
Gcronkright (talk | contribs) (→ADF 2.5 and above!) |
||
| (63 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| + | |||
| + | '''IMPORTANT:''' ADF 2.5 or above requires CommonSpot 10.6.1 or 10.5.2 or above. | ||
| + | |||
== Get the code and configure CF/Web == | == Get the code and configure CF/Web == | ||
| − | The following steps outline the | + | The following steps outline how to download the ADF and configure CommonSpot and your sites to use the ADF |
# Download the ADF (two options) | # Download the ADF (two options) | ||
| − | #* Latest zip archive (http:// | + | #* Latest zip archive (http://community.paperthin.com/projects/ADF/) |
| − | #* SVN (http://community.paperthin.com/svn/ | + | #* SVN (http://community.paperthin.com/svn/ADF/) |
| − | # | + | # Create a directory on your server named "ADF" at the same level as CommonSpot. The name of the folder is "ADF" and must be all capital letters. The ADF should not be created within a CommonSpot site directory. |
| + | # Copy the contents of this zip file into the ADF directory. | ||
# Create a ColdFusion Mapping ( /ADF ) to the ADF directory | # Create a ColdFusion Mapping ( /ADF ) to the ADF directory | ||
# Create a Website Mapping ( /ADF ) to the ADF directory | # Create a Website Mapping ( /ADF ) to the ADF directory | ||
| − | + | ||
| + | '''Note:''' At this point the ADF has been set up for the server. | ||
==Set up the ADF to work with a site== | ==Set up the ADF to work with a site== | ||
| − | Starter Files are located in the ''/ADF/core/site-sample'' directory. This contains a starter 'custom-application.cfm', 'ADF.cfc', and ' | + | Starter Files are located in the ''/ADF/core/site-sample'' directory. This contains a starter 'custom-application.cfm', 'ADF.cfc', 'ajaxProxy.cfm', and 'lightboxProxy.cfm'. These files contain the basic initialization code for the ADF configuration into a site. |
| − | # Copy the ''ADF.cfc'' and '' | + | <!-- (OLD) # Copy the ''ADF.cfc'', ''ajaxProxy.cfm'', and ''lightboxProxy.cfm'' into the sites ''/_cs_apps/'' directory. --> |
| + | # Copy the ADF.cfc, ajaxProxy.cfm, and lightboxProxy.cfm from the ADF/core/site-sample into your site's /_cs_apps/ directory. | ||
# Identify if your site is currently using a ''custom-application.cfm'' file. | # Identify if your site is currently using a ''custom-application.cfm'' file. | ||
| − | #* If your site is running a ''custom-application.cfm'' file, then | + | #* If your site is running a ''custom-application.cfm'' file, then add a cfinclude tag with the template path ''/ADF/core/load_site_adf.cfm'' into the top of your sites ''custom-application.cfm''. |
| − | #* If not, then copy the ''custom-application.cfm'' to your | + | #* If not, then copy the ''custom-application.cfm'' to your site's root (ColdFusion restart is required). |
# [[Reset ADF|Reset the ADF]] for the Server and Site. | # [[Reset ADF|Reset the ADF]] for the Server and Site. | ||
| + | # Register the ADF Script Resources with CommonSpot (for ADF 2.0 and above only!) | ||
| + | ## Run the [[Register All Scripts|Register ALL Scripts]] tool. | ||
| + | # You are good! | ||
| + | |||
| + | |||
| + | '''Note:''' You will need to repeat these steps for each 'site' utilizing the ADF. | ||
| + | |||
| + | '''REMEMBER:''' When going LIVE the '''ADF''' setup on each server (Authoring and each ROPS) should mirror each other. | ||
| + | Copying '''ADF''' files between servers is a manual process. At this time CommonSpot does NOT have a UI for this. | ||
== Related Guides == | == Related Guides == | ||
| − | * [[Site Configuration | + | * [[Site Configuration (ADF.cfc)]] |
| − | * [[ | + | * [[ADF Applications|Create New ADF Application]] |
* [[Add_New_Library_Component|Add New Component to Library]] | * [[Add_New_Library_Component|Add New Component to Library]] | ||
* [[Load_ADF_Components_into_Site|Load ADF Components into Site]] | * [[Load_ADF_Components_into_Site|Load ADF Components into Site]] | ||
| − | + | === ADF 2.0 and above! === | |
| + | * [[ADF Scripts and CommonSpot Registered Resources]] | ||
| + | * [[Register All Scripts|Register ALL ADF Scripts as CommonSpot Resources]] | ||
| + | === ADF 2.5 and above! === | ||
| + | * [http://community.paperthin.com/projects/ADF/docs/release-notes/Release-Notes-v2-5.cfm v2.5 Release Notes] | ||
| + | * [[ADF AjaxProxy CSRF Safe Mode]] | ||
[[Category: Installing the ADF]][[Category: How-to Guide]] | [[Category: Installing the ADF]][[Category: How-to Guide]] | ||
Latest revision as of 14:57, 4 March 2020
IMPORTANT: ADF 2.5 or above requires CommonSpot 10.6.1 or 10.5.2 or above.
Contents
Get the code and configure CF/Web
The following steps outline how to download the ADF and configure CommonSpot and your sites to use the ADF
- Download the ADF (two options)
- Latest zip archive (http://community.paperthin.com/projects/ADF/)
- SVN (http://community.paperthin.com/svn/ADF/)
- Create a directory on your server named "ADF" at the same level as CommonSpot. The name of the folder is "ADF" and must be all capital letters. The ADF should not be created within a CommonSpot site directory.
- Copy the contents of this zip file into the ADF directory.
- Create a ColdFusion Mapping ( /ADF ) to the ADF directory
- Create a Website Mapping ( /ADF ) to the ADF directory
Note: At this point the ADF has been set up for the server.
Set up the ADF to work with a site
Starter Files are located in the /ADF/core/site-sample directory. This contains a starter 'custom-application.cfm', 'ADF.cfc', 'ajaxProxy.cfm', and 'lightboxProxy.cfm'. These files contain the basic initialization code for the ADF configuration into a site.
- Copy the ADF.cfc, ajaxProxy.cfm, and lightboxProxy.cfm from the ADF/core/site-sample into your site's /_cs_apps/ directory.
- Identify if your site is currently using a custom-application.cfm file.
- If your site is running a custom-application.cfm file, then add a cfinclude tag with the template path /ADF/core/load_site_adf.cfm into the top of your sites custom-application.cfm.
- If not, then copy the custom-application.cfm to your site's root (ColdFusion restart is required).
- Reset the ADF for the Server and Site.
- Register the ADF Script Resources with CommonSpot (for ADF 2.0 and above only!)
- Run the Register ALL Scripts tool.
- You are good!
Note: You will need to repeat these steps for each 'site' utilizing the ADF.
REMEMBER: When going LIVE the ADF setup on each server (Authoring and each ROPS) should mirror each other. Copying ADF files between servers is a manual process. At this time CommonSpot does NOT have a UI for this.
Related Guides
- Site Configuration (ADF.cfc)
- Create New ADF Application
- Add New Component to Library
- Load ADF Components into Site
