Next round of TinyMCE Enterprise doc porting

2015-11-10 09:12:13 -08:00
parent 0fd6dd05ab
commit d7f3bd0748
11 changed files with 152 additions and 4 deletions
@@ -194,6 +194,7 @@
    - url: "server"
    - url: "troubleshoot"
  - url: "pro-translations"
+  - url: "support"

 - url: "advanced-development-topics"
  pages:
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Install Plugin
+title: Install Spelling Plugin
 description: Spell Checker Pro is a premium plugin and server to check spelling as-you-type.
 keywords: tinymcespellchecker
 ---
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Install Server
+title: Install Spelling Server
 description: Spell Checker Pro is a premium plugin and server to check spelling as-you-type.
 keywords: tinymcespellchecker
 ---
@@ -111,7 +111,7 @@ ephox{
 
 Ensure that you have the right protocol specified, and for more examples see the section below. If you experience issues, please use the Troubleshooting guide (in the Tip below) and you should be able to see if the browser sends a different origin to the one that you have specified. Both must match for the services to work.

-#### Troubleshooting
+##### Troubleshooting Origins

 Depending on your configuration and the browser you use, you may need to specify the port number as well when listing the origin. If you observe that requests are failing with services not being available, it may be because the port number is required. Refer to troubleshooting guide - section titled Investigating Using the Browser's Network Tools.

@@ -52,7 +52,125 @@ To test the services, we will start with the following:
 5. If the response for the version URL is still 404, it means the service has not been started or installed correctly.
 6. To check the "Origin" value that the browser uses, open the network tools (chrome in this screenshot) and refresh the page. Then enter a couple of words in the editor and select one of the requests on the bottom left ('correction' in the screen shot) and select the 'Headers' section. Look for the 'Origin' header value.

-![alt test](/images/spell-checking-browser-tools.png)
+![Using Browser Tools to Investigate Services Issues](/images/spell-checking-browser-tools.png)

 > The value of the origin header sent by the must match the origin specified in the application.conf server configuration. If it does not match, you must make the server configuration match the browser

+## Windows Server Specific Issues:
+
+Sometimes the 'Origin' header is never sent to the services, which results in the editor and services not working as intended. Follow step 6 from above and determine what the 'Origin' is - if you do not see an 'Origin' header at all, please do the following:
+
+1. Try accessing the editor web page using your machine's fully qualified domain name (FQDN) rather than 'localhost'; and keep the network tools open so you can see if the 'Origin' header is sent back to the services.
+	So open a browser window and try (replace the path to match your setup): `http://myhost:myport/tinymce/index.html`
+2. If you now see an 'Origin' header being sent across, please alter your application.conf and replace all instances of 'localhost' with the domain name of your machine 
+3. Restart the Tomcat / Jetty service 
+4. Reload the browser page and all should work well
+
+If you are still experiencing problems, please contact [Ephox Support](http://support.ephox.com).
+
+
+## General Troubleshooting Advice
+
+### Step 1
+
+Verify that the `spellchecker_rpc_url` value is correct in your TinyMCE client JavaScript configuration.
+
+### Step 2
+
+Ensure that your firewall has the appropriate ports and rules configured correctly. Be sure that the server the service is running on is accessible from the browser via the port specified in the server configuration
+
+### Step 3
+
+Check the logs of the appropriate Java server for information. When making changes to the configuration you will need to restart the application server each time a change is made for that change to take effect. Refresh your browser window and then try the service again.
+
+
+
+## Out of Memory Errors
+
+### The Java Application Server Throws "Out of Memory" Errors
+
+Even though you may have a large amount of RAM available, the Java Virtual Machine doesn't get to see all of that - by default it is limited to only 256Mb.
+
+For example, if you are using Tomcat, you can view how much memory is being consumed by apps. To do this you need to have the management console enabled.
+
+On a vanilla install this is done by editing the file /tomcat/install/directory/conf/tomcat-users.xml adding these lines in:
+
+```xml
+<role rolename="manager-gui" />
+<user username="tomcat" password="password" roles="manager-gui"/>
+```
+
+Then, restart the server and go to a browser and open the default tomcat page http://localhost:8080. On the top right hand side are three buttons, the first of which should be "Server Status". Click that link, login with the details you set above and you should be able to see the memory consumption (see the figure below for an example).
+
+![Spell Checking Server Status](/images/spell-checking-server_status.png)
+
+
+### To increase the amount of memory:
+
+#### Tomcat :
+
+Edit the setenv.sh (Unix) or setenv.bat (Windows) to read as follows:
+ 
+On Windows, please prefix each line with 'set' and remove the quotes . So the configuration would look like:
+ 
+```
+set CATALINA_OPTS= -Dconfig.file=/config/file/location/application.conf 
+set JAVA_OPTS= -Xms2048m -Xmx2048m -XX:PermSize=64m -XX:MaxPermSize=512m -Dfile.encoding=utf-8 -Djava.awt.headless-true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100
+  
+CATALINA_OPTS=" -Dconfig.file=/config/file/location/application.conf
+JAVA_OPTS=" -Xms2048m -Xmx2048m -XX:PermSize=64m -XX:MaxPermSize=512m -Dfile.encoding=utf-8 -Djava.awt.headless-true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100"
+
+
+#### Jetty :
+
+Edit the start.ini file to read as follows:
+
+```
+#===========================================================
+# Jetty start.jar arguments
+# Each line of this file is prepended to the command line
+# arguments # of a call to:
+# java -jar start.jar [arg...]
+#===========================================================
+-Xms2048m -Xmx2048m -XX:PermSize=64m -XX:MaxPermSize=512m -Dconfig.file=/config/file/location/application.conf
+```
+
+Restart the service and confirm the settings have been applied like so:
+
+![Spell Checking Server Settings on Jetty](/images/spell-checking-jetty-settings.png)
+
+
+## Troubleshooting Tools - curl
+
+### Installing curl on Mac
+
+curl is installed by default on all MacOS X installations. Open the "terminal" application to use it.
+
+### Installing curl on Linux
+
+Use your distribution package manager to install curl. See your distribution documentation for details.
+
+### Installing curl (or equivalent package) on Windows  
+
+Download and install the curl package based on your environment:
+
+  x64: http://curl.haxx.se/dlwiz/?type=bin&os=Win64&flav=MinGW64
+  x86: http://curl.haxx.se/dlwiz/?type=bin&os=Win32&flav=-&ver=2000%2FXP and select either of the curl version: 7.39.0 - SSL enabled SSH enabled packages
+
+Once downloaded: 
+
+1. Unzip the package like so:
+
+	![Curl on Windows step 1](/images/spell-checking-curl-windows-1.png)
+
+2. Copy the path of the folder to where the 'curl.exe' is in:
+
+	![Curl on Windows step 2](/images/spell-checking-curl-windows-2.png)
+
+3. Open a cmd prompt. Start -> Programs -> Accessories -> cmd (or command prompt). Then change to that directory to the fodler where the 'curl.exe' is found.Enter 'cd' (without quotes) and then paste in the path from step 2.
+
+	![Curl on Windows step 3](/images/spell-checking-curl-windows-3.png)
+
+4. Once in the folder enter 'curl --version' (without quotes) and ensure you get a valid version
+
+	![Curl on Windows step 4](/images/spell-checking-curl-windows-4.png)
@@ -0,0 +1,29 @@
+---
+layout: default
+title: Get Enterprise Support
+description: Find how to contact Ephox support.
+---
+
+## Overview
+
+Support for TinyMCE Enterprise, is provided online via the Ephox support site.  You can access the support site at: https://support.ephox.com.
+
+Prior to opening a support ticket, we require all users to register with a valid business email address.  You can register on the support site at: https://support.ephox.com/registration. Upon registration you will receive an email requesting that you validate your registration.  If you don't receive such a request within 5 minutes please check your spam folder to see if the email ended up there in error.  If you never receive the validation email please contact the [Ephox Client Services team via email](mailto:clientservices@ephox.com).
+
+### Creating a support ticket
+
+Once you are registered on the site you will be able to interact with the Ephox support team via our support site.  To create a new ticket simply go to the following URL: http://ephox.com/support/ticket. 
+
+Note that Ephox support requires that you provide the following information along with your ticket:
+
+#### TinyMCE Enterprise Editor Client Issues
+
+* Operating System and Browser version
+* JavaScript Console Log
+* View source of the editor page (or some other means of obtaining the JS used to instantiate the editor)
+
+#### TinyMCE Enterprise Server Components Issues
+
+* Server type and version (eg. Jetty, Tomcat)
+* Server log - This will be available either on the system.out log for the server or in a separate file if you've configured the optional logging parameters for TinyMCE Enterprise on you server(s).
+