diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index d6035355f5..f325610e07 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -126,19 +126,13 @@ *** xref:editor-plugin-version.adoc[Specify editor version & plugins] *** xref:plugin-editor-version-compatibility.adoc[Version compatibility reference] *** xref:cloud-troubleshooting.adoc[Cloud Troubleshooting] -** Premium server-side services guide -*** Server-side component installation with Docker -**** Premium self-hosted bundle users -***** xref:bundle-intro-setup.adoc[Introduction and initial setup] -***** xref:bundle-hyperlinking-container.adoc[Hyperlinking service] -***** xref:bundle-spelling-container.adoc[Spelling service] -***** xref:bundle-imageproxy-container.adoc[Image Proxy service] -**** Individually licensed plugin services -***** xref:individual-hyperlinking-container.adoc[Hyperlinking service] -***** xref:individual-image-proxy-container.adoc[Image Proxy service] -***** xref:individual-spelling-container.adoc[Spelling service] -***** xref:individual-export-to-pdf-on-premises.adoc[Export to PDF] -***** xref:individual-import-from-word-and-export-to-word-on-premises.adoc[Import from Word and Export to Word] +** Premium server-side services guides +*** xref:bundle-intro-setup.adoc[Introduction] +*** xref:individual-hyperlinking-container.adoc[Hyperlinking service] +*** xref:individual-image-proxy-container.adoc[Image Proxy service] +*** xref:individual-spelling-container.adoc[Spelling service] +*** xref:individual-export-to-pdf-on-premises.adoc[Export to PDF] +*** xref:individual-import-from-word-and-export-to-word-on-premises.adoc[Import from Word and Export to Word] *** Configure the server-side components **** xref:configure-required-services.adoc[Required configuration] **** xref:configure-common-settings-services.adoc[Optional common settings] diff --git a/modules/ROOT/pages/7.1-release-notes.adoc b/modules/ROOT/pages/7.1-release-notes.adoc index 8233fd6121..400118f39f 100644 --- a/modules/ROOT/pages/7.1-release-notes.adoc +++ b/modules/ROOT/pages/7.1-release-notes.adoc @@ -53,6 +53,8 @@ The Java server-side components have been updated to the following versions: The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components: +include::partial$misc/admon-docker-starter-kit-eos-message.adoc[] + . Update your Java Application Server to the minimum required version: include::partial$misc/supported-application-servers.adoc[] diff --git a/modules/ROOT/pages/7.2-release-notes.adoc b/modules/ROOT/pages/7.2-release-notes.adoc index 49e7b4eec5..15b02bd442 100644 --- a/modules/ROOT/pages/7.2-release-notes.adoc +++ b/modules/ROOT/pages/7.2-release-notes.adoc @@ -42,6 +42,8 @@ The Java server-side component has been updated to the following version: The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components: +include::partial$misc/admon-docker-starter-kit-eos-message.adoc[] + . Update your Java Application Server to the minimum required version: include::partial$misc/supported-application-servers.adoc[] diff --git a/modules/ROOT/pages/7.6.1-release-notes.adoc b/modules/ROOT/pages/7.6.1-release-notes.adoc index e8885e6bbf..ca0a3649b0 100644 --- a/modules/ROOT/pages/7.6.1-release-notes.adoc +++ b/modules/ROOT/pages/7.6.1-release-notes.adoc @@ -49,6 +49,8 @@ The Java server-side components have been updated to the following versions: The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components: +include::partial$misc/admon-docker-starter-kit-eos-message.adoc[] + . Update your Java Application Server to the minimum required version: include::partial$misc/supported-application-servers.adoc[] diff --git a/modules/ROOT/pages/7.7.0-release-notes.adoc b/modules/ROOT/pages/7.7.0-release-notes.adoc index 13b1a5dd27..2b6feb761b 100644 --- a/modules/ROOT/pages/7.7.0-release-notes.adoc +++ b/modules/ROOT/pages/7.7.0-release-notes.adoc @@ -40,6 +40,8 @@ The Java server-side component has been updated to the following version: The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components: +include::partial$misc/admon-docker-starter-kit-eos-message.adoc[] + . Update your Java Application Server to the minimum required version: include::partial$misc/supported-application-servers.adoc[] diff --git a/modules/ROOT/pages/7.7.1-release-notes.adoc b/modules/ROOT/pages/7.7.1-release-notes.adoc index 9b3f27859a..c47a7b1382 100644 --- a/modules/ROOT/pages/7.7.1-release-notes.adoc +++ b/modules/ROOT/pages/7.7.1-release-notes.adoc @@ -47,6 +47,8 @@ The Java server-side components have been updated to the following versions: The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components: +include::partial$misc/admon-docker-starter-kit-eos-message.adoc[] + . Update your Java Application Server to the minimum required version: include::partial$misc/supported-application-servers.adoc[] diff --git a/modules/ROOT/pages/bundle-hyperlinking-container.adoc b/modules/ROOT/pages/bundle-hyperlinking-container.adoc deleted file mode 100644 index 139e1fda3b..0000000000 --- a/modules/ROOT/pages/bundle-hyperlinking-container.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Premium self-hosted bundle - Hyperlinking service container -:navtitle: Hyperlinking service -:description: How-to deploy the Hyperlinking service from the self-hosted bundle as a docker image. -:shbundledockerfiles: true - -include::partial$docker/dockerized-hyperlinking-service.adoc[] diff --git a/modules/ROOT/pages/bundle-imageproxy-container.adoc b/modules/ROOT/pages/bundle-imageproxy-container.adoc deleted file mode 100644 index ac034da78e..0000000000 --- a/modules/ROOT/pages/bundle-imageproxy-container.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Premium self-hosted bundle - Image Proxy service container -:navtitle: Image Proxy service -:description: How-to deploy the Image Proxy service from the self-hosted bundle as a docker image. -:shbundledockerfiles: true - -include::partial$docker/dockerized-image-proxy.adoc[] diff --git a/modules/ROOT/pages/bundle-intro-setup.adoc b/modules/ROOT/pages/bundle-intro-setup.adoc index 09713dffda..645bad8fc5 100644 --- a/modules/ROOT/pages/bundle-intro-setup.adoc +++ b/modules/ROOT/pages/bundle-intro-setup.adoc @@ -1,8 +1,8 @@ -= Introduction and initial setup for containerized server-side services from the premium self-hosted bundle += Introduction and initial setup for containerized server-side services from the premium self-hosted bundles :navtitle: Introduction and initial setup :description: The containerized server-side components for premium plugins. -The {enterpriseversion} server-side components can be deployed on Docker orchestration applications such as https://kubernetes.io/[Kubernetes], https://docs.docker.com/engine/swarm/[Docker Swarm], or https://www.openshift.com/[OpenShift]. {companyname} provides packages containing pre-configured https://docs.docker.com/engine/reference/builder/[`+Dockerfiles+`] for building and deploying the {enterpriseversion} server-side components using Docker. +The {enterpriseversion} server-side components can be deployed on Docker orchestration applications such as link:https://kubernetes.io/[Kubernetes^], link:https://docs.docker.com/engine/swarm/[Docker Swarm^], or link:https://www.openshift.com/[OpenShift^]. {companyname} provides Docker images through the {companyname} Cloud Registry. An access token will be provided by {companyname} to log into the registry to retrieve the Docker image and run the container. == Containerized services for Self-hosted Enterprise deployments @@ -14,55 +14,21 @@ The following sections assist with containerizing the {productname} services for === Prerequisites -* The https://docs.docker.com/engine/docker-overview/[Docker Engine] is installed and running. -* The user has Administrative or Root user access. +* The link:https://docs.docker.com/engine/docker-overview/[Docker Engine^] is installed and running. +* The user has Administrative or Root user access to run the Docker commands. * The user is either: -** Using a Linux, Unix or macOS operating system. -** Using Windows and has access to unix command line tools using https://gitforwindows.org/[Git for Windows], https://www.cygwin.com/[Cygwin], or the https://docs.microsoft.com/en-us/windows/wsl/install-win10[Windows Subsystem for Linux]. +** Using a Unix-like operating system, such as Linux or macOS. +** Using Windows and has access to unix command line tools using link:https://gitforwindows.org/[Git for Windows^], link:https://www.cygwin.com/[Cygwin^], or the link:https://docs.microsoft.com/en-us/windows/wsl/install-win10[Windows Subsystem for Linux^]. -[[download-and-extract-the-tinymce-self-hosted-bundle]] -=== Download and extract the TinyMCE Self-hosted Bundle +=== Next steps -. Go to *link:{download-enterprise}[{accountpage} Downloads]* and download the {productname} self-hosted bundle `+.zip+` file. -. Open a command line and navigate to the directory containing the downloaded `+.zip+` file: -* `+TinyMCE-Essential_latest.zip+` for *Self-hosted Essential* users. -* `+TinyMCE-Professional_latest.zip+` for *Self-hosted Professional* users. -* `+TinyMCE-Premium_latest.zip+` for *Self-hosted Premium* users. -+ -Windows Users should open a Bash command line as the Administrator User. -. Extract the contents of the `+.zip+` file, such as: -+ -[source,sh] ----- -unzip TinyMCE-Premium_latest.zip -d tinymce-selfhosted ----- -+ -The structure of the extracted files will be: -+ -[source,sh] ----- -tinymce-selfhosted/ -├── tinymce/ -└── tinymce-services/ - ├── ephox-hyperlinking-docker-starter-kit.zip - ├── ephox-hyperlinking.war - ├── ephox-image-proxy-docker-starter-kit.zip - ├── ephox-image-proxy.war - ├── ephox-spelling-docker-starter-kit.zip - ├── ephox-spelling.war - └── version.txt ----- -. Navigate into the `+tinymce-services+` folder. -+ -[source,sh] ----- -cd tinymce-selfhosted/tinymce-services/ ----- +Proceed to setting up and deploying the containerized services for: -Proceed to setting up and deploying the containerized services: +* For the Enhanced Media Embed and Link Checker service, see: xref:individual-hyperlinking-container.adoc[Deploy the {productname} hyperlinking server-side component using Docker]. +* For the Image Editing and Export image proxy service, see: xref:individual-image-proxy-container.adoc[Deploy the {productname} image proxy server-side component using Docker]. +* For the Spell Checker service, see: xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker]. -* For the Enhanced Media Embed and Link Checker service, see: xref:bundle-hyperlinking-container.adoc[Deploy the TinyMCE hyperlinking server-side component using Docker (self-hosted enterprise bundles)]. -* For the Image Editing and Export image proxy service, see: xref:bundle-imageproxy-container.adoc[Deploy the TinyMCE image proxy server-side component using Docker (self-hosted enterprise bundles)]. -* For the Spell Checker service, see: xref:bundle-spelling-container.adoc[Deploy the TinyMCE spelling service server-side component using Docker (self-hosted enterprise bundles)]. -* For the Image Editing proxy service, see: xref:bundle-imageproxy-container.adoc[Deploy the TinyMCE image proxy server-side component using Docker (self-hosted enterprise bundles)]. -* For the Spell Checker service, see: xref:bundle-spelling-container.adoc[Deploy the TinyMCE spelling service server-side component using Docker (self-hosted enterprise bundles)]. +=== Additional services + +* For the Export to PDF service, see: xref:individual-export-to-pdf-on-premises.adoc[Deploy the {productname} Export to PDF service server-side component using Docker]. +* For the Import from Word and Export to Word services, see: xref:individual-import-from-word-and-export-to-word-on-premises.adoc[Deploy the {productname} Import from Word and Export to Word service server-side component using Docker]. \ No newline at end of file diff --git a/modules/ROOT/pages/bundle-spelling-container.adoc b/modules/ROOT/pages/bundle-spelling-container.adoc deleted file mode 100644 index 03252272ee..0000000000 --- a/modules/ROOT/pages/bundle-spelling-container.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Premium self-hosted bundle - Spelling service container -:navtitle: Spelling service -:description: How-to deploy the Spelling service from the self-hosted bundle as a docker image. -:shbundledockerfiles: true - -include::partial$docker/dockerized-spelling-service.adoc[] diff --git a/modules/ROOT/pages/how-to-guides.adoc b/modules/ROOT/pages/how-to-guides.adoc index 33498730e1..dc0e56b8d3 100644 --- a/modules/ROOT/pages/how-to-guides.adoc +++ b/modules/ROOT/pages/how-to-guides.adoc @@ -110,5 +110,5 @@ xref:generate-rsa-key-pairs.adoc[Generate public key pairs] Instructions on how to generate private/public key pairs for the Tiny Cloud // Empty cell to even out rows -|a +a| |=== \ No newline at end of file diff --git a/modules/ROOT/pages/introduction-to-premium-selfhosted-services.adoc b/modules/ROOT/pages/introduction-to-premium-selfhosted-services.adoc index 1370adbccd..7d02b98d05 100644 --- a/modules/ROOT/pages/introduction-to-premium-selfhosted-services.adoc +++ b/modules/ROOT/pages/introduction-to-premium-selfhosted-services.adoc @@ -36,11 +36,11 @@ Please ensure that you configure your Java Server (Tomcat/Jetty etc) with a mini [[deploy-server-side-components]] == Step 2. Deploy server-side components -Deploy all the WAR files that came packaged with the {productname} Enterprise Self-hosted package to your newly installed Java application server: +Deploy all the WAR files that came packaged with the {productname} Enterprise Self-hosted package to your newly installed application server: -* ephox-spelling.war -* ephox-image-proxy.war -* ephox-hyperlinking.war +* `ephox-spelling.war` +* `ephox-image-proxy.war` +* `ephox-hyperlinking.war` The easiest way to deploy these files is to copy them into the _webapps_ directory of your Tomcat/Jetty installation and then restart the application server. diff --git a/modules/ROOT/partials/docker/dockerized-hyperlinking-service.adoc b/modules/ROOT/partials/docker/dockerized-hyperlinking-service.adoc deleted file mode 100644 index a0ca952246..0000000000 --- a/modules/ROOT/partials/docker/dockerized-hyperlinking-service.adoc +++ /dev/null @@ -1,184 +0,0 @@ -ifeval::[{shbundledockerfiles} != true] -== Deploy the TinyMCE hyperlinking server-side component using Docker (individually licensed) -endif::[] -ifeval::[{shbundledockerfiles} == true] -== Deploy the TinyMCE hyperlinking server-side component using Docker (self-hosted enterprise bundles) -endif::[] - -The TinyMCE hyperlinking server-side component can be deployed using Docker or a container orchestration application such as Kubernetes. {companyname} provides a pre-configured package for creating a Hyperlinking Docker image. - -include::partial$misc/admon-dont-push-docker-images.adoc[] - -ifeval::[{shbundledockerfiles} == false] - -=== Prerequisites - -* The https://docs.docker.com/engine/docker-overview/[Docker Engine] is installed and running. -* The user has Administrative or Root user access. -* The user is either: -** Using a Linux, Unix or macOS operating system. -** Using Windows and has access to unix command line tools using https://gitforwindows.org/[Git for Windows], https://www.cygwin.com/[Cygwin], or the https://docs.microsoft.com/en-us/windows/wsl/install-win10[Windows Subsystem for Linux]. -endif::[] - -=== Procedure - -The following procedure covers downloading, configuring, building and testing the {productname} Hyperlinking Docker image. -ifeval::[{shbundledockerfiles} == true] - -NOTE: This procedure assumes that a {productname} self-hosted enterprise bundle has been extracted as described in xref:bundle-intro-setup.adoc#download-and-extract-the-tinymce-self-hosted-bundle[Download and extract the {productname} Self-hosted Bundle]. - -. Navigate into the `+tinymce-services+` folder. -+ -[source,sh] ----- -cd tinymce-selfhosted/tinymce-services/ ----- -. Extract the contents of `+ephox-hyperlinking-docker-starter-kit.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-hyperlinking-docker-starter-kit.zip -d hyperlinking-service-dockerfile ----- -+ -The structure of the extracted files will be: -+ -[source,sh] ----- -hyperlinking-service-dockerfile/ -├── config -│   └── ephox-hyperlinking-docker-env.conf -├── docker-entrypoint.sh -├── Dockerfile -└── generate-jetty-start.sh ----- -. Copy `+ephox-hyperlinking.war+` into the directory containing the extracted files, such as: -+ -[source,sh] ----- -cp ephox-hyperlinking.war hyperlinking-service-dockerfile/ ----- -. Navigate into the `+hyperlinking-service-dockerfile+` folder. -+ -[source,sh] ----- -cd hyperlinking-service-dockerfile ----- - -endif::[] -ifeval::[{shbundledockerfiles} != true] - -. Go to link:{accountpageurl}/[{accountpage}] > My Downloads and download either: - -* _Tiny Enhanced Media Embed_, or -* _Tiny Link Checker_. - -. Open a command line and navigate to the directory containing `+ephox-hyperlinking_.zip+`. Windows Users should open a Bash command line as the Administrator User. -. Extract the contents of `+ephox-hyperlinking_.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-hyperlinking_.zip -d tinymce-hyperlinking-service ----- -. Navigate into the extracted folder. -+ -[source,sh] ----- -cd tinymce-hyperlinking-service ----- -. Extract the contents of `+ephox-hyperlinking-docker-starter-kit.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-hyperlinking-docker-starter-kit.zip ----- -+ -The structure of the current directory (`+tinymce-hyperlinking-service/+`) will be: -+ -[source,sh] ----- -tinymce-hyperlinking-service/ -├── config -│   └── ephox-hyperlinking-docker-env.conf -├── docker-entrypoint.sh -├── Dockerfile -├── ephox-hyperlinking-docker-starter-kit.zip -├── ephox-hyperlinking.war -├── generate-jetty-start.sh -├── license.txt -├── readme.txt -└── version.txt ----- - -endif::[] - -. Set the permissions on the extracted files to executable. -+ -[source,sh] ----- -chmod +x *.sh ----- -. _Optional_: Edit the `+http+` configuration settings in `+config/ephox-hyperlinking-docker-env.conf+`. The configurable settings are in the `+http+` section of the file. For example: -+ -[source,properties] ----- -http { - max-connections = 100 - max-connections-per-host = 10 - max-redirects = 10 - max-retries = 3 - request-timeout-seconds = 10 - trust-all-cert = false - websphere = { - use-ssl-config = true - } -} ----- -+ -For information on the `+http+` configuration setting, see: xref:configure-common-settings-services.adoc#http[Configure server-side components - `+http+`]. -. _Optional_: Update the link-checking cache configuration, as described in xref:configure-hyperlink-service.adoc[Link Checker self-hosted quick setup]. -. _Optional_: Configure the Enhanced Media Embed Service, as described in xref:mediaembed-server-config.adoc[Configure Enhanced Media Embed Server]. -. _Optional_: Configure the service to use a HTTP proxy by updating `+config/ephox-hyperlinking-docker-env.conf+`. See: xref:configure-common-settings-services.adoc#proxy[Configure server-side components - proxy]. -. Create an `+origins.env+` file in the same directory as the `+Dockerfile+`, and specify the Hypertext Transfer Protocol (HTTP) and domain name of sites hosting the TinyMCE editor (`+allowed-origins+`). Up to 99 origins can be added without editing `+config/ephox-hyperlinking-docker-env.conf+`. -+ -For example: -+ -[source,properties] ----- -ORIGIN0=example.net -ORIGIN1=example -ORIGIN2=http://example.org ----- -+ -For information on `+allowed-origins+`, see: xref:configure-required-services.adoc#allowed-origins[Configure server-side components - allowed-origins]. -. As the root user or Administrator, build the {productname} Hyperlinking Docker image using the following command: -+ -[source,sh] ----- -docker build -t tinymce-hyperlinking-service . ----- -. As the root user or Administrator, deploy the service using the following command: -+ -[source,sh] ----- -docker run -d -p 8083:8080 --env-file origins.env tinymce-hyperlinking-service ----- -+ -Where: - -* `+-p 8083:8080+` maps the container port `+8080+` to local port `+8083+`. -* `+--env-file origins.env+` adds the allowed origins to the container. -. To verify that the Docker container is deployed and the hyperlinking service is running, execute: -+ -[source,sh] ----- -curl http://localhost:8083/ephox-hyperlinking/ ----- -+ -The response from the `+curl+` command should be: -+ -[source,sh] ----- -Link checking and media embedding service is running. ----- - -The {productname} Hyperlinking Docker image can now be pushed to a private container registry for deployment on https://kubernetes.io/[Kubernetes], https://docs.docker.com/engine/swarm/[Docker Swarm] or https://www.openshift.com/[OpenShift]. diff --git a/modules/ROOT/partials/docker/dockerized-image-proxy.adoc b/modules/ROOT/partials/docker/dockerized-image-proxy.adoc deleted file mode 100644 index f365236595..0000000000 --- a/modules/ROOT/partials/docker/dockerized-image-proxy.adoc +++ /dev/null @@ -1,115 +0,0 @@ -== Deploy the TinyMCE image proxy server-side component using Docker (self-hosted enterprise bundles) - -The TinyMCE image proxy server-side component can be deployed using Docker or a container orchestration application such as Kubernetes. {companyname} provides a pre-configured package for creating a Image Proxy Docker image. - -include::partial$misc/admon-dont-push-docker-images.adoc[] - -=== Procedure - -The following procedure covers downloading, configuring, building and testing the {productname} Image Proxy Docker image. - -NOTE: This procedure assumes that a {productname} self-hosted enterprise bundle has been extracted as described in xref:bundle-intro-setup.adoc#download-and-extract-the-tinymce-self-hosted-bundle[Download and extract the {productname} Self-hosted Bundle]. - -. Navigate into the `+tinymce-services+` folder. -+ -[source,sh] ----- -cd tinymce-selfhosted/tinymce-services/ ----- -. Extract the contents of `+ephox-image-proxy-docker-starter-kit.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-image-proxy-docker-starter-kit.zip -d image-proxy-service-dockerfile ----- -. Copy `+ephox-image-proxy.war+` into the directory containing the extracted files, such as: -+ -[source,sh] ----- -cp ephox-image-proxy.war image-proxy-service-dockerfile/ ----- -. Navigate into the `+image-proxy-service-dockerfile+` folder. -+ -[source,sh] ----- -cd image-proxy-service-dockerfile ----- -. Set the permissions on the extracted files to executable. -+ -[source,sh] ----- -chmod +x *.sh ----- -. _Optional_: Edit the `+image-proxy+` configuration setting in `+config/ephox-image-proxy-docker-env.conf+`. The configurable setting is in the `+image-proxy+` section of the file. For example: -+ -[source,properties] ----- -image-proxy { - image-size = 10000000 // 10MB in bytes -} ----- -+ -For information on the `+image-proxy+` configuration setting, see: xref:configure-imageproxy-service.adoc#image-proxy[Configure server-side components - `+image-proxy+`]. -. _Optional_: Edit the `+http+` configuration settings in `+config/ephox-image-proxy-docker-env.conf+`. The configurable settings are in the `+http+` section of the file. For example: -+ -[source,properties] ----- -http { - max-connections = 100 - max-connections-per-host = 10 - max-redirects = 10 - max-retries = 3 - request-timeout-seconds = 10 - trust-all-cert = false - websphere = { - use-ssl-config = true - } -} ----- -+ -For information on the `+http+` configuration setting, see: xref:configure-common-settings-services.adoc#http[Configure server-side components - `+http+`]. -. _Optional_: Configure the service to use a HTTP proxy by updating `+config/ephox-image-proxy-docker-env.conf+`. See: xref:configure-required-services.adoc[Configure server-side components]. -. Create an `+origins.env+` file in the same directory as the `+Dockerfile+`, and specify the Hypertext Transfer Protocol (HTTP) and domain name of sites hosting the TinyMCE editor (`+allowed-origins+`). Up to 99 origins can be added without editing `+config/ephox-image-proxy-docker-env.conf+`. -+ -For example: -+ -[source,properties] ----- -ORIGIN0=example.net -ORIGIN1=example -ORIGIN2=http://example.org ----- -+ -For information on `+allowed-origins+`, see: xref:configure-required-services.adoc#allowed-origins[Configure server-side components - allowed-origins]. -. As the root user or Administrator, build the {productname} Image Proxy Docker image using the following command: -+ -[source,sh] ----- -docker build -t tinymce-image-proxy-service . ----- -. As the root user or Administrator, deploy the service using the following command: -+ -[source,sh] ----- -docker run -d -p 8081:8080 --env-file origins.env tinymce-image-proxy-service ----- -+ -Where: - -* `+-p 8081:8080+` maps the container port `+8080+` to local port `+8081+`. -* `+--env-file origins.env+` adds the allowed origins to the container. -. To verify that the Docker container is deployed and the image proxy is running, execute: -+ -[source,sh] ----- -curl http://localhost:8081/ephox-image-proxy/ ----- -+ -The response from the `+curl+` command should be: -+ -[source,sh] ----- -Image proxy service is running. ----- - -The {productname} Image Proxy Docker image can now be pushed to a private container registry for deployment on https://kubernetes.io/[Kubernetes], https://docs.docker.com/engine/swarm/[Docker Swarm] or https://www.openshift.com/[OpenShift]. diff --git a/modules/ROOT/partials/docker/dockerized-spelling-service.adoc b/modules/ROOT/partials/docker/dockerized-spelling-service.adoc deleted file mode 100644 index 2ed7bdeb3c..0000000000 --- a/modules/ROOT/partials/docker/dockerized-spelling-service.adoc +++ /dev/null @@ -1,178 +0,0 @@ -ifeval::[{shbundledockerfiles} != true] -== Deploy the TinyMCE spelling service server-side component using Docker (individually licensed) -endif::[] -ifeval::[{shbundledockerfiles} == true] -== Deploy the TinyMCE spelling service server-side component using Docker (self-hosted enterprise bundles) -endif::[] - -The TinyMCE spelling service server-side component can be deployed using Docker or a container orchestration application such as Kubernetes. {companyname} provides a pre-configured package for creating a Spelling Service Docker image. - -include::partial$misc/admon-dont-push-docker-images.adoc[] - -ifeval::[{shbundledockerfiles} != true] - -=== Prerequisites - -* The https://docs.docker.com/engine/docker-overview/[Docker Engine] is installed and running. -* The user has Administrative or Root user access. -* The user is either: -** Using a Linux, Unix or macOS operating system. -** Using Windows and has access to unix command line tools using https://gitforwindows.org/[Git for Windows], https://www.cygwin.com/[Cygwin], or the https://docs.microsoft.com/en-us/windows/wsl/install-win10[Windows Subsystem for Linux]. - -endif::[] - -=== Procedure - -The following procedure covers downloading, configuring, building and testing the {productname} Spelling Service Docker image. -ifeval::[{shbundledockerfiles} == true] - -NOTE: This procedure assumes that a {productname} self-hosted enterprise bundle has been extracted as described in xref:bundle-intro-setup.adoc#download-and-extract-the-tinymce-self-hosted-bundle[Download and extract the {productname} Self-hosted Bundle]. - -. Navigate into the `+tinymce-services+` folder. -+ -[source,sh] ----- -cd tinymce-selfhosted/tinymce-services/ ----- -. Extract the contents of `+ephox-spelling-docker-starter-kit.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-spelling-docker-starter-kit.zip -d spelling-service-dockerfile ----- -+ -The structure of the extracted files will be: -+ -[source,sh] ----- -spelling-service-dockerfile/ -├── config -│   └── ephox-spelling-docker-env.conf -├── docker-entrypoint.sh -├── Dockerfile -└── generate-jetty-start.sh ----- -. Copy `+ephox-spelling.war+` into the directory containing the extracted files, such as: -+ -[source,sh] ----- -cp ephox-spelling.war spelling-service-dockerfile/ ----- -. Navigate into the `+spelling-service-dockerfile+` folder. -+ -[source,sh] ----- -cd spelling-service-dockerfile ----- -+ -endif::[] -ifeval::[{shbundledockerfiles} != true] -. Go to *link:{accountpageurl}/[{accountpage}] > My Downloads* and download _Tiny Spell Checker_. -. Open a command line and navigate to the directory containing `+ephox-spelling_.zip+`. Windows Users should open a Bash command line as the Administrator User. -. Extract the contents of `+ephox-spelling_.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-spelling_.zip -d tinymce-spelling-service ----- -. Navigate into the extracted folder. -+ -[source,sh] ----- -cd tinymce-spelling-service ----- -. Extract the contents of `+ephox-spelling-docker-starter-kit.zip+`, such as: -+ -[source,sh] ----- -unzip ephox-spelling-docker-starter-kit.zip ----- -+ -The structure of the current directory (`+tinymce-spelling-service/+`) will be: -+ -[source,sh] ----- -tinymce-spelling-service/ -├── config -│   └── ephox-spelling-docker-env.conf -├── docker-entrypoint.sh -├── Dockerfile -├── ephox-spelling-docker-starter-kit.zip -├── ephox-spelling.war -├── generate-jetty-start.sh -├── license.txt -├── readme.txt -└── version.txt ----- -+ -endif::[] -. Set the permissions on the extracted files to executable. -+ -[source,sh] ----- -chmod +x *.sh ----- -. _Optional_: Edit the `+http+` configuration settings in `+config/ephox-spelling-docker-env.conf+`. The configurable settings are in the `+http+` section of the file. For example: -+ -[source,properties] ----- -http { - max-connections = 100 - max-connections-per-host = 10 - max-redirects = 10 - max-retries = 3 - request-timeout-seconds = 10 - trust-all-cert = false - websphere = { - use-ssl-config = true - } -} ----- -+ -For information on the `+http+` configuration setting, see: xref:configure-common-settings-services.adoc#http[Configure server-side components - `+http+`]. -. _Optional_: Configure the service to use a HTTP proxy by updating `+config/ephox-spelling-docker-env.conf+`. See: xref:configure-required-services.adoc[Configure server-side components]. -. _Optional_: Add a custom dictionary, as described in xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. -. Create an `+origins.env+` file in the same directory as the `+Dockerfile+`, and specify the Hypertext Transfer Protocol (HTTP) and domain name of sites hosting the TinyMCE editor (`+allowed-origins+`). Up to 99 origins can be added without editing `+config/ephox-spelling-docker-env.conf+`. -+ -For example: -+ -[source,properties] ----- -ORIGIN0=example.net -ORIGIN1=example -ORIGIN2=http://example.org ----- -+ -For information on `+allowed-origins+`, see: xref:configure-required-services.adoc#allowed-origins[Configure server-side components - allowed-origins]. -. As the root user or Administrator, build the {productname} Spelling Service Docker image using the following command: -+ -[source,sh] ----- -docker build -t tinymce-spelling-service . ----- -. As the root user or Administrator, deploy the service using the following command: -+ -[source,sh] ----- -docker run -d -p 8082:8080 --env-file origins.env tinymce-spelling-service ----- -+ -Where: - -* `+-p 8082:8080+` maps the container port `+8080+` to local port `+8082+`. -* `+--env-file origins.env+` adds the allowed origins to the container. -. To verify that the Docker container is deployed and the spelling service is running, execute: -+ -[source,sh] ----- -curl http://localhost:8082/ephox-spelling/ ----- -+ -The response from the `+curl+` command should be: -+ -[source,sh] ----- -Spelling service is running. ----- - -The {productname} Spelling Service Docker image can now be pushed to a private container registry for deployment on https://kubernetes.io/[Kubernetes], https://docs.docker.com/engine/swarm/[Docker Swarm] or https://www.openshift.com/[OpenShift]. diff --git a/modules/ROOT/partials/misc/admon-docker-starter-kit-eos-message.adoc b/modules/ROOT/partials/misc/admon-docker-starter-kit-eos-message.adoc new file mode 100644 index 0000000000..9a1d1babb3 --- /dev/null +++ b/modules/ROOT/partials/misc/admon-docker-starter-kit-eos-message.adoc @@ -0,0 +1,2 @@ +[NOTE] +The `+ephox--docker-starter-kit.zip+` is no longer supported as of {productname} 7.7.2. However, until further notice, WAR files will continue to be included in the ZIP distribution of {productname}. These files require manual updates when deploying self-hosted services. To update: \ No newline at end of file