Installing Zulu 2

From 360Works Product Documentation Wiki
(Difference between revisions)
Jump to: navigation, search
(Standard Installation)
(Servlet rather than a "plugin")
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{template:Zulu}}
 
{{template:Zulu}}
==Installing Zulu on your server==
+
==Installing Zulu 2 on your server==
  
 
===Servlet rather than a "plugin"===
 
===Servlet rather than a "plugin"===
Line 7: Line 7:
  
 
To install the standalone server application, simply run the Windows Installer or Mac Installer that came packaged with your Zulu download and open the Zulu2SampleData example file.
 
To install the standalone server application, simply run the Windows Installer or Mac Installer that came packaged with your Zulu download and open the Zulu2SampleData example file.
 +
 +
'''For FileMaker Server 17''' Refer to this page for how to enable your XML Web Publishing Engine [[Enable_XML_FileMaker_17]]
  
 
=Standard Installation=
 
=Standard Installation=
Line 14: Line 16:
  
 
=====Installation Steps=====
 
=====Installation Steps=====
* Run the installer downloaded from the [http://360works.com/zulu/ Zulu product page]
+
* Unzip the package downloaded from the [http://360works.com/zulu/ Zulu product page].
* Follow the prompts, entering a username and password when prompted.
+
* Run the installer provided in the package.
* Register Zulu when the Welcome Page launches. (if you're using other 360Works products, and would like to try the demo license, simply restart the Tomcat Application Server using the 360Works Admin tool. For more detailed instructions, check out the [[Zulu_2#Troubleshooting|Troubleshooting]] section.
+
* Follow the installer prompts, entering a username and password when prompted. (this is your sync admin password, write it down!)
 +
 
 +
=====Post Installation=====
 +
* Register Zulu when the Welcome Page launches. (if you're using other 360Works products, and would like to try the demo license, simply restart the Tomcat Application Server using the 360Works Admin tool.  
 +
 
 +
=====Troubleshooting=====
 +
Having trouble installing? For more detailed instructions, check out the [[Zulu_2#Troubleshooting|Troubleshooting]] section.
  
 
==Custom Installation==
 
==Custom Installation==
====Manual Installation====
+
Users who need a more customized solution may choose to perform a manual installation of the Zulu 2 software. Zulu 2 runs on your server as an Apache Tomcat application, so you will need to download and install the Apache Tomcat server application for your operating system. (this may involve setting Tomcat up to start automatically with your system, as well as configuring your web server to forward traffic for Zulu to port 80). '''Installing Zulu inside the FileMaker Server Web Publishing Engine is no longer supported.'''
Users who need a more customized solution may need to perform a manual installation of the Zulu software. Zulu runs on your server as an Apache Tomcat application; therefore, it will run alongside the Web Publishing engine using the existing Tomcat instance installed by FileMaker Server or you can download and install the Apache Tomcat server application for your operating system to run Zulu in a standalone Tomcat Server (this may involve setting Tomcat up to start automatically with your system, as well as configuring your web server to forward traffic for Zulu to port 80).  
+
  
Zulu can be installed into the Web Publishing Engine. This is the easiest installation method to configure, and is easily redirected to port 80. Alternatively, you may install Zulu in a standalone Tomcat server of your choice. This option is available if you do not want to modify the Web Publishing Engine or if you need further customization.
+
=====Prerequisites=====
 +
* Check your Java version to make sure you are running at least Java 6
 +
* Be sure FileMaker Server is installed and running with XML Custom Web Publishing enabled. (FMS does not need to necessarily run on the same machine as Zulu, but is required for Zulu to function.)
 +
* Download and install Apache Tomcat 6.x or 7.x from http://tomcat.apache.org, for Windows make sure to download the installer
 +
* Follow Tomcat documentation for running Tomcat as server, for Windows make to make the service selection during installation
 +
* Start up Tomcat (this usually happens automatically when using the installer, otherwise you will need to run the Catalina shell script with a 'start' command).
  
===Installing in the FileMaker Server Web Publishing Engine===
+
=====Installing Zulu 2=====
====Prerequisites====
+
* Copy the Zulu.war file from the Installer Data folder into the <code>$TOMCAT_HOME/webapps</code> folder in your Tomcat instance.
* Be sure FileMaker Server is installed and running with XML Custom Web Publishing enabled.
+
* (Tomcat 6) Modify the <code>zulu.xml</code> file located in the <code>$TOMCAT_HOME/conf/Catalina/localhost/</code> folder.
 
+
* (Tomcat 7) Modify the <code>context.xml</code> file located in the <code>$TOMCAT_HOME/webapps/zulu/META-INF/</code> folder.
====Installing Zulu====
+
** Specify your username and password on these two lines of the <code>zulu.xml</code> file:
* Copy the Zulu.war file from the Installer Data folder into the jwpc-tomcat folder located at <code>FileMaker Server/Web Publishing/publishing-engine/jwpc-tomcat/</code> (a Zulu folder will be created automatically when the .war file is dropped in place).
+
* Now you should be able to access the Zulu sync admin splash page by visiting <code>http://localhost:16020/zulu</code> verify that you are able to successfully access this page.
+
* (FMS13) Back in the jwpc-tomcat folder, navigate to <code>jwpc-tomcat/zulu/META-INF/</code> and edit the context.xml
+
* (FMS12) Back in the jwpc-tomcat folder, navigate to <code>jwpc-tomcat/conf/Catalina/localhost/</code> and edit the zulu.xml
+
** Specify your username and password on these two lines of the <code>zulu.xml/context.xml</code> file:
+
 
*** <code><Parameter name="zulu.adminUsername" value="" override="false" /></code>
 
*** <code><Parameter name="zulu.adminUsername" value="" override="false" /></code>
 
*** <code><Parameter name="zulu.adminPassword" value="" override="false" /></code>
 
*** <code><Parameter name="zulu.adminPassword" value="" override="false" /></code>
 +
* If necessary for your configuration, set up URL forwarding from IIS / Apache to your Tomcat connectors. See Tomcat documentation on how to do this.
  
====URL Redirection====
+
==Important notes about using Zulu 2 with FileMaker Server 11 or 14==
NOTE: These instructions apply only to users installing inside the FMS13 Web Publishing Engine.
+
Zulu 2 utilizes FileMaker Server's native AJP connector port for communication with FileMaker Server. This port is unavailable on FileMaker Server 11 and FileMaker Server 14. Please follow these instructions to correct the host port number in order to use Zulu 2.
=====Windows=====
+
FileMaker Server uses the URL Rewrite module of IIS to redirect traffic from standard web traffic through port 80 to our default HTTP Tomcat port 42424 (or port 16020 if installed in the FMS WPE).
+
 
+
* Launch the IIS Manager, expand the Sites folder, then click on the FMWebSite site. You will see a collection of modules in the center pane of IIS Manager.
+
* Double click the module that reads <code>URL Rewrite.</code>
+
* In the right hand pane, click <code>Add Rule(s)</code> at the very top of the list of actions.
+
* From here, choose <code>Blank rule</code> and press OK
+
* Set up the rule to match the pattern for the requested URL using regular expressions.
+
* Set the pattern as <code>^zulu(.*)</code>
+
* Scroll down to the action section and be sure the action type is set to <code>Rewrite</code>
+
* Set the Rewrite URL as <code>http://localhost:42424/zulu{R:1}</code> (replace 42424 with 16020 if Zulu is installed inside the Web Publishing Engine)
+
* Be sure <code>Append query string</code> and <code>Stop processing of subsequent rules</code> are both checked, then apply the settings.
+
* Go to the ARR proxy settings (they're hidden under IIS -> Application Request Routing Cache -> Server Proxy Settings) and uncheck the "Reverse rewrite host in response headers" checkbox.
+
* Finally, test the the zulu URL in your browser (http://localhost/zulu)
+
 
+
=====Mac=====
+
 
+
If Zulu is installed in it's own instance of Tomcat (Default Installation)
+
* Navigate to <code>FileMaker Server/HTTPServer/conf/</code> and open the <code>httpd.conf</code> file with a text editor. You will need elevated permissions to modify this file.
+
* Add these lines to the end of the <code>httpd.conf</code> file:
+
** <code>ProxyPass /zulu ajp://127.0.0.1:42423/zulu retry=1 timeout=7200</code>
+
* Save the file back to its original location.
+
 
+
If Zulu is installed inside the FileMaker Web Publishing Engine
+
* Navigate to <code>FileMaker Server/Admin/admin-helper/WEB-INF/conf/</code> and open the <code>mod_proxy.conf</code> file with a text editor. You will need elevated permissions to modify this file.
+
* Add these lines to the end of the <code>mod_proxy.conf</code> file:
+
** <code>ProxyPass /zulu ajp://127.0.0.1:16021/zulu retry=1 timeout=7200</code>
+
* Save the file back to its original location.
+
 
+
 
+
Now Apache needs to be restarted, but we need to be sure to restart Apache with the FMS13 configuration.
+
* Open a terminal window and enter <code>cd "/Library/FileMaker Server/HTTPServer/bin"</code> and press return.
+
* Enter this command to restart Apache (you will need to enter your system password when prompted): <code>sudo ./httpdctl graceful</code>
+
* Test the Zulu URL in your browser (http://localhost/zulu)
+
 
+
=====Using Filemaker Server 11?=====
+
 
+
  
 
Navigate to:
 
Navigate to:
  
* Windows: Program Files/360Works/Application/webapps/Zulu/META-INF/context.xml
+
* Windows: C:\Program Files\360Works\Application\webapps\Zulu\META-INF\context.xml
  
 
* Mac: Library/360Works/Application/webapps/Zulu/META-INF/context.xml
 
* Mac: Library/360Works/Application/webapps/Zulu/META-INF/context.xml
  
 
+
Copy the context.xml file to your desktop, leaving a copy inside the META-INF folder (This is important. if there is no context.xml file in this location, Tomcat does not react well, and may require reinstallation). In the desktop copy of the context.xml, remove the port number from this line:
* Copy the context.xml file to your desktop, leaving a copy inside the META-INF folder (This is important. if there is no context.xml file in this location, Tomcat does not react well, and may require reinstallation)
+
 
+
 
+
* In the desktop copy of the context.xml, remove the port number from this line:
+
  
 
* Parameter name="jdbc.host" value="127.0.0.1:16020" overide="false"
 
* Parameter name="jdbc.host" value="127.0.0.1:16020" overide="false"
  
* So that it reads:
+
So that it reads:
  
 
* Parameter name="jdbc.host" value="127.0.0.1" overide="false"
 
* Parameter name="jdbc.host" value="127.0.0.1" overide="false"
  
 
+
Now, drop the context.xml file back into the META-INF directory, use the "Replace" option to replace the old context.xml then try and publish to confirm the issue is fixed.
* Now, drop the context.xml file back into the META-INF directory, use the "Replace" option to replace the old context.xml
+
 
+
* Try and publish to confirm the issue is fixed.
+
 
+
=====Using Filemaker Server 14?=====
+
 
+
When installing Zulu for FMS 14, there is one modification you have to make.
+
 
+
Navigate to:
+
 
+
* Windows: Program Files/360Works/Application/webapps/Zulu/META-INF/context.xml
+
 
+
* Mac: Library/360Works/Application/webapps/Zulu/META-INF/context.xml
+
 
+
 
+
* Copy the context.xml file to your desktop, leaving a copy inside the META-INF folder (This is important. if there is no context.xml file in this location, Tomcat does not react well, and may require reinstallation)
+
 
+
 
+
* In the desktop copy of the context.xml, remove the port number from this line:
+
 
+
* Parameter name="jdbc.host" value="127.0.0.1:16020" overide="false"
+
 
+
* So that it reads:
+
 
+
* Parameter name="jdbc.host" value="127.0.0.1" overide="false"
+
 
+
 
+
* Now, drop the context.xml file back into the META-INF directory, use the "Replace" option to replace the old context.xml
+
 
+
* This is necessary to compensate for a change in port number when communicating with the Filemaker Web Publishing Engine in Filemaker 14
+
 
+
====Alternative - Installing in a standalone Apache Tomcat Server====
+
=====Prerequisites=====
+
* Download and install Apache Tomcat 6.x or 7.x from http://tomcat.apache.org, for Windows make sure to download the installer
+
* Follow Tomcat documentation for running Tomcat as server, for Windows make to make the service selection during installation
+
* Start up Tomcat (this usually happens automatically when using the installer, otherwise you will need to run the Catalina shell script with a 'start' command).
+
 
+
=====Installing Zulu=====
+
* Copy the Zulu.war file from the Installer Data folder into the <code>$TOMCAT_HOME/webapps</code> folder in your Tomcat instance.
+
* (Tomcat 6) Modify the <code>zulu.xml</code> file located in the <code>$TOMCAT_HOME/conf/Catalina/localhost/</code> folder.
+
* (Tomcat 7) Modify the <code>context.xml</code> file located in the <code>$TOMCAT_HOME/webapps/zulu/META-INF/</code> folder.
+
** Specify your username and password on these two lines of the <code>zulu.xml</code> file:
+
*** <code><Parameter name="zulu.adminUsername" value="" override="false" /></code>
+
*** <code><Parameter name="zulu.adminPassword" value="" override="false" /></code>
+
* If necessary for your configuration, set up URL forwarding from IIS / Apache to your Tomcat connectors. See Tomcat documentation on how to do this.
+
  
 
==Next Steps==
 
==Next Steps==

Latest revision as of 22:59, 15 May 2018

Zulu  
Getting Setup with Zulu: InstallingInstalling as ServletInstalling the Plugin VersionZulu Google SetupIntegrating your file • ‎Zulu Sync • ‎Serving the Sample FileRegistrationInstalling Zulu Manually
About Zulu The big pictureLimitationsRequirementsDifferences between servlet and pluginHostingSecurity
Troubleshooting TroubleshootingTesting ConfigurationsUmlautsURLs Used By ZuluUpdatingLogs
Google Sync with Google • ‎Sharing a Google CalendarGoogle ContactsGoogle ResetAppointment Slots
Calendars Repeating EventsDate Ranges • ‎Read Only CalendarsDeleting EventsInvitationsSwitching CalendarsMultiple CalendarsPropertiesSee it in iCalMy site
Contacts Contact GroupsContacts IntegrationsRelated Contact FieldsAddress BookZulu Phone Fax Email
Does Zulu work with... AndroidBlackberryMultiple MachinesOutlookMobileMeiPhone
Extra Credit Adding FieldsTime ZonesDuplicating RecordsCalc FieldsAccess PrivledgesRefreshFilteringPost Editing ScriptsAlarms and notifications

Contents

[edit] Installing Zulu 2 on your server

[edit] Servlet rather than a "plugin"

Zulu 1 was introduced as both a traditional server-side plugin and as a standalone server running alongside FileMaker Server. Zulu 2 is only available as a standalone server because of the flexibility offered by separating from FileMaker Server. The Zulu plugin is deprecated and no longer supported. If you are currently running Zulu as a plugin, please uninstall the plugin and download the latest version of Zulu 2 from the 360Works store 360Works Zulu

To install the standalone server application, simply run the Windows Installer or Mac Installer that came packaged with your Zulu download and open the Zulu2SampleData example file.

For FileMaker Server 17 Refer to this page for how to enable your XML Web Publishing Engine Enable_XML_FileMaker_17

[edit] Standard Installation

[edit] Prerequisites
  • Check your Java version to make sure you are running at least Java 6
  • Be sure FileMaker Server is installed and running with XML Custom Web Publishing enabled. (FMS does not need to necessarily run on the same machine as Zulu, but is required for Zulu to function.)
[edit] Installation Steps
  • Unzip the package downloaded from the Zulu product page.
  • Run the installer provided in the package.
  • Follow the installer prompts, entering a username and password when prompted. (this is your sync admin password, write it down!)
[edit] Post Installation
  • Register Zulu when the Welcome Page launches. (if you're using other 360Works products, and would like to try the demo license, simply restart the Tomcat Application Server using the 360Works Admin tool.
[edit] Troubleshooting

Having trouble installing? For more detailed instructions, check out the Troubleshooting section.

[edit] Custom Installation

Users who need a more customized solution may choose to perform a manual installation of the Zulu 2 software. Zulu 2 runs on your server as an Apache Tomcat application, so you will need to download and install the Apache Tomcat server application for your operating system. (this may involve setting Tomcat up to start automatically with your system, as well as configuring your web server to forward traffic for Zulu to port 80). Installing Zulu inside the FileMaker Server Web Publishing Engine is no longer supported.

[edit] Prerequisites
  • Check your Java version to make sure you are running at least Java 6
  • Be sure FileMaker Server is installed and running with XML Custom Web Publishing enabled. (FMS does not need to necessarily run on the same machine as Zulu, but is required for Zulu to function.)
  • Download and install Apache Tomcat 6.x or 7.x from http://tomcat.apache.org, for Windows make sure to download the installer
  • Follow Tomcat documentation for running Tomcat as server, for Windows make to make the service selection during installation
  • Start up Tomcat (this usually happens automatically when using the installer, otherwise you will need to run the Catalina shell script with a 'start' command).
[edit] Installing Zulu 2
  • Copy the Zulu.war file from the Installer Data folder into the $TOMCAT_HOME/webapps folder in your Tomcat instance.
  • (Tomcat 6) Modify the zulu.xml file located in the $TOMCAT_HOME/conf/Catalina/localhost/ folder.
  • (Tomcat 7) Modify the context.xml file located in the $TOMCAT_HOME/webapps/zulu/META-INF/ folder.
    • Specify your username and password on these two lines of the zulu.xml file:
      • <Parameter name="zulu.adminUsername" value="" override="false" />
      • <Parameter name="zulu.adminPassword" value="" override="false" />
  • If necessary for your configuration, set up URL forwarding from IIS / Apache to your Tomcat connectors. See Tomcat documentation on how to do this.

[edit] Important notes about using Zulu 2 with FileMaker Server 11 or 14

Zulu 2 utilizes FileMaker Server's native AJP connector port for communication with FileMaker Server. This port is unavailable on FileMaker Server 11 and FileMaker Server 14. Please follow these instructions to correct the host port number in order to use Zulu 2.

Navigate to:

  • Windows: C:\Program Files\360Works\Application\webapps\Zulu\META-INF\context.xml
  • Mac: Library/360Works/Application/webapps/Zulu/META-INF/context.xml

Copy the context.xml file to your desktop, leaving a copy inside the META-INF folder (This is important. if there is no context.xml file in this location, Tomcat does not react well, and may require reinstallation). In the desktop copy of the context.xml, remove the port number from this line:

  • Parameter name="jdbc.host" value="127.0.0.1:16020" overide="false"

So that it reads:

  • Parameter name="jdbc.host" value="127.0.0.1" overide="false"

Now, drop the context.xml file back into the META-INF directory, use the "Replace" option to replace the old context.xml then try and publish to confirm the issue is fixed.

[edit] Next Steps

[edit] Serve the Sample File

Confirm your installation and see Zulu at work by serving the Zulu Sample File on your server. You'll want to do this before adding Zulu to your own file.

Zulu Serving The Sample File

Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox