Difference between revisions of "Zulu - Installation"

From 360Works Product Documentation Wiki
Jump to navigation Jump to search
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
=Standard Installation=
 
=Standard Installation=
 
=====Prerequisites=====
 
=====Prerequisites=====
* Check your Java version to make sure you are running at least Java 6
+
* Zulu requires FileMaker Server, be sure this is installed.
* Be sure FileMaker Server is installed and running with XML Custom Web Publishing enabled.
+
* Zulu uses the XML Web Publishing engine.  See more about enabling that, and allowing accounts to use XML here: [[Enable XML FileMaker 17]]
 +
* FileMaker Server 18.03 no longer automatically installs Java, and the XML Web Publishing Engine needs to be manually configured.  See more about enabling that here: [https://support.claris.com/s/article/Changes-to-Java-in-FileMaker-Server-18-0-3-and-Later?language=en_US Changes to Java in FileMaker Server 18.03]
 +
* FileMaker Pro 16 or later
 +
* '''Note:''' If you are upgrading from Zulu 2, you will need to re-publish your calendars and re-create your sync configurations
 +
*<b>Note</b>: FileMaker Cloud does not have a web publishing engine which is a requirement for Zulu and thus is not a supported environment.
  
 
=====Installation Steps=====
 
=====Installation Steps=====
* Unzip the package downloaded from the [http://360works.com/zulu/ Zulu product page].
+
=====Mac and Windows=====
 +
* Unzip the package downloaded from the [http://360works.com/zulu/ Zulu product page].  
 
* Run the installer provided in the package.
 
* 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!)
 
* Follow the installer prompts, entering a username and password when prompted. (this is your sync admin password, write it down!)
 +
 +
=====Linux=====
 +
*Please see the instructions [[Linux_Web_Application_Installation | here]]
  
 
=====Post Installation=====
 
=====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.  To see more about Registration and Licensing, see here: [[Zulu - Licensing And Registration]]
+
* 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.  To see more about registration, see here: [[Zulu - The Admin Console#Registration | Registration]]
* Zulu uses the XML Web Publishing engine.  See more about enabling that, and allowing accounts to use XML here: [[Enable XML FileMaker 17]]
 
 
* Zulu expects to be installed on the same machine as FileMaker Server.  If you are running Zulu on a different machine, see [[Zulu - Advanced Settings]]
 
* Zulu expects to be installed on the same machine as FileMaker Server.  If you are running Zulu on a different machine, see [[Zulu - Advanced Settings]]
* We recommend that you configure the settings for receiving emails if there are sync errors.  These will alert you if there are any connection issues and your events are not syncing properly.  See how to do this here: [[Zulu - Advanced Settings]]
+
* If you are syncing with Google calendars, we recommend setting up your own Google Api Key so you are not using the 360Works shared key included by default.  See this video for instructions: [https://youtu.be/5WVp5UGD9Yw Google Generate API Key]
* We also recommend setting up your own Google Api Key so you are not using the 360Works shared key included by default.  Also outlined here: [[Zulu - Advanced Settings]]
 
  
 
=====Troubleshooting=====
 
=====Troubleshooting=====
 
Having trouble installing? For more detailed instructions, check out the [[Installing Zulu 3#Troubleshooting Installation|Troubleshooting Installation]] section.
 
Having trouble installing? For more detailed instructions, check out the [[Installing Zulu 3#Troubleshooting Installation|Troubleshooting Installation]] section.
 +
 +
 +
 +
  
 
=Custom Installation=
 
=Custom Installation=
Users who need a more customized solution may choose to perform a manual installation of the Zulu 3 software. Zulu 3 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 choose to perform a manual installation of the Zulu software. Zulu 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.'''
  
 
=====Prerequisites=====
 
=====Prerequisites=====
 
* Check your Java version to make sure you are running at least Java 6
 
* 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.)
 
* 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
+
* Download and install Apache Tomcat 9.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
 
* 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).
 
* 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).
Line 37: Line 47:
 
*** <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.
 
* 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=====
 +
=====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:8080/zulu{R:1}</code>
 +
* 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 http://127.0.0.1:8080/zulu retry=1 timeout=7200</code>
 +
* Save the file back to its original location.
 +
 +
=====Restart Web Server=====
 +
After setting up a url rewrite rule, you will need to restart the web server for the change to take effect.  Restart with web server with the following command:
 +
<pre>fmsadmin restart httpserver -y</pre>
  
 
=Troubleshooting Installation=
 
=Troubleshooting Installation=
  
 
===Can not access the Zulu admin page===
 
===Can not access the Zulu admin page===
The Zulu admin page should be accessible using the url
+
The Zulu admin page should be accessible using the url.
 
First, check whether Zulu is running.  On the machine where Zulu is installed, go to the below url.  This will bypass the any firewalls or web servers in the way:
 
First, check whether Zulu is running.  On the machine where Zulu is installed, go to the below url.  This will bypass the any firewalls or web servers in the way:
 
<pre>http://localhost:42424/zulu</pre>
 
<pre>http://localhost:42424/zulu</pre>

Latest revision as of 20:01, 9 June 2023

Standard Installation

Prerequisites
  • Zulu requires FileMaker Server, be sure this is installed.
  • Zulu uses the XML Web Publishing engine. See more about enabling that, and allowing accounts to use XML here: Enable XML FileMaker 17
  • FileMaker Server 18.03 no longer automatically installs Java, and the XML Web Publishing Engine needs to be manually configured. See more about enabling that here: Changes to Java in FileMaker Server 18.03
  • FileMaker Pro 16 or later
  • Note: If you are upgrading from Zulu 2, you will need to re-publish your calendars and re-create your sync configurations
  • Note: FileMaker Cloud does not have a web publishing engine which is a requirement for Zulu and thus is not a supported environment.
Installation Steps
Mac and Windows
  • 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!)
Linux
  • Please see the instructions here
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. To see more about registration, see here: Registration
  • Zulu expects to be installed on the same machine as FileMaker Server. If you are running Zulu on a different machine, see Zulu - Advanced Settings
  • If you are syncing with Google calendars, we recommend setting up your own Google Api Key so you are not using the 360Works shared key included by default. See this video for instructions: Google Generate API Key
Troubleshooting

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



Custom Installation

Users who need a more customized solution may choose to perform a manual installation of the Zulu software. Zulu 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.

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 9.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 3
  • 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.
URL Redirection
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 URL Rewrite.
  • In the right hand pane, click Add Rule(s) at the very top of the list of actions.
  • From here, choose Blank rule and press OK
  • Set up the rule to match the pattern for the requested URL using regular expressions.
  • Set the pattern as ^zulu(.*)
  • Scroll down to the action section and be sure the action type is set to Rewrite
  • Set the Rewrite URL as http://localhost:8080/zulu{R:1}
  • Be sure Append query string and Stop processing of subsequent rules 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 FileMaker Server/HTTPServer/conf/ and open the httpd.conf file with a text editor. You will need elevated permissions to modify this file.
  • Add these lines to the end of the httpd.conf file:
  • Save the file back to its original location.
Restart Web Server

After setting up a url rewrite rule, you will need to restart the web server for the change to take effect. Restart with web server with the following command:

fmsadmin restart httpserver -y

Troubleshooting Installation

Can not access the Zulu admin page

The Zulu admin page should be accessible using the url. First, check whether Zulu is running. On the machine where Zulu is installed, go to the below url. This will bypass the any firewalls or web servers in the way:

http://localhost:42424/zulu

If you can see the admin page, Zulu is running, web server configuration may have been removed, or a firewall is blocking the port. Common If you have installed or updated FileMaker Server after installing Zulu, the FileMaker Installer will clear out the web server configurations that Zulu sets up. To get these back, just re-run the Zulu installer.

If you can't see the admin page, Zulu is down. Try running the installer again to bring it back up. If that still does not work, contact 360Works support - support@360works.com

Shell execution failed. Verify that Java is installed and run setup again.

This error means that the installer did not find a suitable Java installation. Download and install Java 8 from here: Java 8 Downloads. After that is installed, run the installer again and see if the issue persists.

Could not configure web server forwarding because of an error

This error occurs when the installer could not communicate with the web server. Usually when you see this error message, Zulu has been successfully installed, but was unable to set up a rewrite with the web server. To see if Zulu was successfully installed, open this url in a browser and see if the admin console comes up:

http://localhost:42424/zulu

If you do not see the admin page, another issue has occurred, and you should contact 360Works support at support@360Works.com.

If the admin page loads correctly, then your web server is the problem. This means that Zulu is up and running, but you will need to access it over port 42424. If you require that Zulu be accessed over the standard ports, you will need to get your web server to cooperate. Here are some things you can try:

  • If FileMaker server is also installed on this machine, you can restart the webserver with this command line command:
fmsadmin restart httpserver -y
  • If FileMaker Server is not installed on this machine, you will need to configure your own web server