diff --git a/enterprise/check-spelling/troubleshoot.md b/enterprise/check-spelling/troubleshoot.md index f217af4..38cd003 100644 --- a/enterprise/check-spelling/troubleshoot.md +++ b/enterprise/check-spelling/troubleshoot.md @@ -6,27 +6,27 @@ keywords: enterprise tinymcespellchecker spell check checker pro pricing --- -## Browser-Specific Issues +## Browser-specific issues -### Internet Explorer Specific Troubleshooting Tips +### Internet Explorer specific troubleshooting tips If the editor is reporting that the service cannot be found and tracing the network traffic reveals that no request is made at all, check that the server is **not** listed in the "Trusted Sites" section of Internet Explorer's security options. If it is, remove it and try again. -### Chrome Specific Tips +### Chrome specific tips If the server is not running on a standard HTTP or HTTPS port (80 or 443) then Chrome will include the port in the origin header that is sent to the server. Other browsers do not do this. This is why when specifying the "allowed-origins" config, you should use both the hostname by itself and the hostname and port in the configuration. See Entering Origins for more details -## Debug Server Configuration +## Debug server configuration If spell checking does not appear to be working, this is generally caused by the following reasons. This guide will walk you through the debugging process to identify the specific problem and how to remedy the issue. -1. The application.conf file is incorrect. Please go back and follow the steps listed in the installation guide. This is the most common problem - often the origins are specified without the port numbers and this can cause things to fail, eg: use 'http://localhost:8080' instead of 'http://localhost'. After making changes to the application.conf file, please restart your Java web server (e.g. Jetty or Tomcat). +1. The application.conf file is incorrect. Please go back and follow the steps listed in the installation guide. This is the most common problem - often the origins are specified without the port numbers and this can cause things to fail, eg: use `http://localhost:8080` instead of `http://localhost`. After making changes to the application.conf file, please restart your Java web server (e.g. Jetty or Tomcat). 2. The application.conf file is correct, but something is wrong with one of the services. See the section below to debug the services. 3. The application.conf file is correct, and the services are working, but the URL's that editor uses are not quite right. Refer to the Spell checking Client-Side TinyMCE Plugin page for help. 4. All of the above are correct, but the browser sends back a different origin. See step 6. of Using Browser Tooling to Investigate Services Issues and add the origin value to the list of origins. Restart Tomcat and then refresh the editor page in a browser and things should work. -### Check/Debug the Server Configuration +### Check/debug the server configuration To test the services, we will start with the following: @@ -35,7 +35,7 @@ To test the services, we will start with the following: 3. If you are on a Windows environment follow the page Installing curl in Windows and then open a 'cmd' prompt and run the commands from there. -## Using Browser Tooling to Investigate Services Issues +## Using browser tooling to investigate services issues 1. Open your browser's Console/Network tools: * Chrome: View menu -> Developer -> JavaScript Console. Click the Network tab (located between Elements and Sources). @@ -44,19 +44,19 @@ To test the services, we will start with the following: * Internet Explorer: Click the cog icon on the top-right side of the browser. Select F12 Developer Tools. Click the Network link (next to the ‘Profiler’ link). 2. Refresh the webpage featuring an TinyMCE configured with the spelling service. Enter a misspelled word into the editor. 3. Locate the network results that match the following URLs: - * http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/autocorrect - * http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/correction + * `http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/autocorrect` + * `http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/correction` 4. If the network response for these services is 404, try the following: - * Take the service URL displayed as erroneous (example: http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/autocorrect). - * Remove everything from the ‘1’ onwards (including the ‘1’) and replace it with /version. (example: Change http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/correction to http://YOUR_SERVER:YOUT_PORT/ephox-spelling/version). The response code should be 200 and the body should display the version number. + * Take the service URL displayed as erroneous (example: `http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/autocorrect`). + * Remove everything from the ‘1’ onwards (including the ‘1’) and replace it with /version. (example: Change `http://YOUR_SERVER:YOUR_PORT/ephox-spelling/1/correction` to `http://YOUR_SERVER:YOUT_PORT/ephox-spelling/version`). The response code should be 200 and the body should display the version number. 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. -![Using Browser Tools to Investigate Services Issues](/images/spell-checking-browser-tools.png) +![Using browser tools to investigate services issues]({{ site.baseurl }}/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: +## 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: @@ -69,7 +69,7 @@ Sometimes the 'Origin' header is never sent to the services, which results in th If you are still experiencing problems, please contact [Ephox Support](http://support.ephox.com). -## General Troubleshooting Advice +## General troubleshooting advice ### Step 1 @@ -85,9 +85,9 @@ Check the logs of the appropriate Java server for information. When making chang -## Out of Memory Errors +## Out of memory errors -### The Java Application Server Throws "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. @@ -100,14 +100,14 @@ On a vanilla install this is done by editing the file /tomcat/install/directory/ ``` -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). +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) +![Spell Checking Server Status]({{ site.baseurl }}/images/spell-checking-server_status.png) -### To increase the amount of memory: +### To increase the amount of memory -#### Tomcat : +#### Tomcat Edit the setenv.sh (Unix) or setenv.bat (Windows) to read as follows: @@ -119,9 +119,9 @@ set JAVA_OPTS= -Xms2048m -Xmx2048m -XX:PermSize=64m -XX:MaxPermSize=512m -Dfile. 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 : +#### Jetty Edit the start.ini file to read as follows: @@ -137,10 +137,10 @@ Edit the start.ini file to read as follows: Restart the service and confirm the settings have been applied like so: -![Spell Checking Server Settings on Jetty](/images/spell-checking-jetty-settings.png) +![Spell Checking Server Settings on Jetty]({{ site.baseurl }}/images/spell-checking-jetty-settings.png) -## Troubleshooting Tools - curl +## Troubleshooting tools: curl ### Installing curl on Mac @@ -155,22 +155,23 @@ Use your distribution package manager to install curl. See your distribution doc 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) + ![Curl on Windows step 1]({{ site.baseurl }}/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) + ![Curl on Windows step 2]({{ site.baseurl }}/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) + ![Curl on Windows step 3]({{ site.baseurl }}/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) + ![Curl on Windows step 4]({{ site.baseurl }}/images/spell-checking-curl-windows-4.png) diff --git a/images/spell-checking-browser-tools.png b/images/spell-checking-browser-tools.png index c2acb80..9ad5276 100644 Binary files a/images/spell-checking-browser-tools.png and b/images/spell-checking-browser-tools.png differ diff --git a/images/spell-checking-curl-windows-1.png b/images/spell-checking-curl-windows-1.png index 726087b..a8962ad 100644 Binary files a/images/spell-checking-curl-windows-1.png and b/images/spell-checking-curl-windows-1.png differ diff --git a/images/spell-checking-curl-windows-2.png b/images/spell-checking-curl-windows-2.png index 8daddb9..365fe82 100644 Binary files a/images/spell-checking-curl-windows-2.png and b/images/spell-checking-curl-windows-2.png differ diff --git a/images/spell-checking-curl-windows-3.png b/images/spell-checking-curl-windows-3.png index bebbd94..2d44ae3 100644 Binary files a/images/spell-checking-curl-windows-3.png and b/images/spell-checking-curl-windows-3.png differ diff --git a/images/spell-checking-server_status.png b/images/spell-checking-server_status.png index 5a89aae..284aec6 100644 Binary files a/images/spell-checking-server_status.png and b/images/spell-checking-server_status.png differ