Skip to content

DOC-3274: Fixed the docker guides for Hyperlinking, Image Proxy, and Spelling services for the TinyMCE 8 Docs. #3858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kemister85 merged 8 commits into from
Sep 23, 2025
Merged

DOC-3274: Fixed the docker guides for Hyperlinking, Image Proxy, and Spelling services for the TinyMCE 8 Docs. #3858

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1307719
DOC-3274: Fixed curl commands to use a single slash instead of double…
abhinavgandham Sep 10, 2025
bce7408
Update modules/ROOT/partials/docker/hyperlinking-service/hyperlinking…
abhinavgandham Sep 10, 2025
ec174e3
Update modules/ROOT/partials/docker/hyperlinking-service/hyperlinking…
abhinavgandham Sep 10, 2025
068faac
Update modules/ROOT/partials/docker/image-proxy-service/image-proxy-s…
abhinavgandham Sep 10, 2025
db5370f
Update modules/ROOT/partials/docker/spelling-service/spelling-service…
abhinavgandham Sep 10, 2025
2620b3a
DOC-3274: Removed <> from allowed origins.
abhinavgandham Sep 10, 2025
01fd5f7
Updated server logs.
abhinavgandham Sep 15, 2025
dfd549e
DOC-3274: : Fixed indentation in hyperlinking and image proxy yml cod…
abhinavgandham Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions ...OOT/partials/docker/hyperlinking-service/hyperlinking-service-installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include::partial$misc/admon-docker-access.adoc[]

=== Retrieve Docker Image

. Login into the {companyname} Cloud Docker Registry:
. Login into the {companyname} Cloud Docker Registry:
+
[source, sh, subs="attributes+"]
----
Expand All @@ -23,9 +23,9 @@ Replace `<VERSION>` with `latest` or the specific version number.

include::partial$misc/admon-available-docker-images.adoc[]

=== Specify Configurations
=== Specify Configurations

After completing the previous steps, run the Docker container from the pulled image:
After completing the previous steps, run the Docker container from the pulled image:

[source, sh, subs="attributes+"]
----
Expand All @@ -34,7 +34,7 @@ docker run -p 19100:19100 registry.containers.tiny.cloud/hyperlinking-tiny:<VERS

This triggers `-p 19100:19100`, exposing the service on `localhost:19100`. The service runs on port `19100` inside the Docker container, and this maps it to the same port on your localhost.

If set up correctly, the logs should display output similar to the following:
If set up correctly, the logs should display output similar to the following:

[source, log]
----
Expand All @@ -45,7 +45,7 @@ If set up correctly, the logs should display output similar to the following:
2025-01-02 11:06:46 [io-compute-blocker-8] WARN c.e.d.config.AllowedOriginsConfig$ - No allowed-origins specified in config!
2025-01-02 11:06:46 [io-compute-blocker-8] INFO navi - navi config loaded successfully: NaviConfig(LinkCheckerConfig(true,ReturnUnknown),true,CacheConfig(10000,86400 seconds,3600 seconds),SdkServiceWithClientConfig(HttpConfig(100,10,10,3,HttpConfigTimeouts(10,10,10),JvmTrustModel()),None,OriginWhitelist(List(),OriginPrecision(true))),SelfHostedMediaSourcesConfig(CustomEmbedPlugins(UrlTrie(Branch(None,TreeMap()),Branch(None,TreeMap()))),None),OriginWhitelist(List(),OriginPrecision(true)),Logger[navi])
2025-01-02 11:06:46 [io-compute-9] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /0:0:0:0:0:0:0:0:19100
2025-01-02 11:06:46 [io-compute-9] INFO o.h.blaze.server.BlazeServerBuilder -
2025-01-02 11:06:46 [io-compute-9] INFO o.h.blaze.server.BlazeServerBuilder -
_ _ _ _ _
| |_| |_| |_ _ __| | | ___
| ' \\ _| _| '_ \\_ _(_-<
Expand All @@ -56,7 +56,7 @@ If set up correctly, the logs should display output similar to the following:

Running this command will generate a log warning about `allowed-origins` not being configured. This is expected, as it will be set up in the next step.

The {productname} server-side components require a configuration file to function correctly. By convention, this file is named `application.conf`. For more information, refer to link:https://www.tiny.cloud/docs/tinymce/latest/configure-required-services/[Required configuration for the server-side components^].
The {productname} server-side components require a configuration file to function correctly. By convention, this file is named `application.conf`. For more information, refer to link:https://www.tiny.cloud/docs/tinymce/latest/configure-required-services/[Required configuration for the server-side components^].

This configuration file requires at least the following information:

Expand Down Expand Up @@ -96,7 +96,7 @@ The Docker container can also be run with `docker compose`. In this example, the
----
hyperlinking-service/
├── application.conf
└── docker-compose.yaml
└── docker-compose.yaml
----

Here is an example of the application.conf file with the basic configurations:
Expand Down Expand Up @@ -133,11 +133,17 @@ services:
init: true
volumes:
- type: bind
source: ./application.conf #change this to the path on your local machine
target: /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf
source: ./application.conf #change this to the path on your local machine
# Use the below target path if using any version below 2.109.6.
# target: /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf
target: /app/application.conf
read_only: true
----

+
[NOTE]
From version 2.130.0 onwards, the `target` path in the volums option must point to `/app/application.conf` .

. Run the service (within the same directory where `docker-compose.yaml` was placed):
+

Expand All @@ -151,7 +157,7 @@ If the setup is correct, the initiation logs should appear as follows:
+
[source, log]
----
✔ Container hyperlinking-tiny-hyperlinking-tiny-1 Recreated 0.1s
✔ Container hyperlinking-tiny-hyperlinking-tiny-1 Recreated 0.1s
Attaching to hyperlinking-tiny-1
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-1] INFO navi - navi

Expand All @@ -177,7 +183,7 @@ hyperlinking-tiny-1 | - localhost:8000
hyperlinking-tiny-1 | - ephox.com
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - navi config loaded successfully: NaviConfig(LinkCheckerConfig(true,ReturnUnknown),true,CacheConfig(10000,86400 seconds,3600 seconds),SdkServiceWithClientConfig(HttpConfig(100,10,10,3,HttpConfigTimeouts(15,15,15),JvmTrustModel()),None,OriginWhitelist(List(localhost, localhost:8000, ephox.com),OriginPrecision(true))),SelfHostedMediaSourcesConfig(CustomEmbedPlugins(UrlTrie(Branch(None,TreeMap()),Branch(None,TreeMap(org -> Branch(None,TreeMap(wikipedia -> Branch(None,TreeMap(en -> Branch(Some(PathMatcher(List((wiki/.*,WikipediaEmbedPlugin(https://en.wikipedia.org/w/api.php,10))))),TreeMap()))))))))),None),OriginWhitelist(List(localhost, localhost:8000, ephox.com),OriginPrecision(true)),Logger[navi])
hyperlinking-tiny-1 | 2025-01-02 16:17:29 [io-compute-6] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /0:0:0:0:0:0:0:0:19100
hyperlinking-tiny-1 | 2025-01-02 16:17:29 [io-compute-6] INFO o.h.blaze.server.BlazeServerBuilder -
hyperlinking-tiny-1 | 2025-01-02 16:17:29 [io-compute-6] INFO o.h.blaze.server.BlazeServerBuilder -
hyperlinking-tiny-1 | _ _ _ _ _
hyperlinking-tiny-1 | | |_| |_| |_ _ __| | | ___
hyperlinking-tiny-1 | | ' \\ _| _| '_ \\_ _(_-<
Expand Down Expand Up @@ -211,9 +217,9 @@ To confirm that a request is being sent to the {linkcheckerplugin} service, use:
+
[source, sh]
----
curl --location 'http://localhost:19100/1/check' \\
--header 'Origin: http://good.com' \\
--header 'Content-Type: application/json' \\
curl --location 'http://localhost:19100/1/check' \
--header 'Origin: http://good.com' \
--header 'Content-Type: application/json' \
--data '{ "urls": [{"url":"http://google.com"}, {"url": "http://youtube.com"}, {"url":"http://google.com/404"}, {"url":"https://ephox.."}]}'
----

Expand All @@ -223,9 +229,9 @@ Finally, to verify if a request is unauthorized and originates from an incorrect
+
[source, sh]
----
curl --location 'http://localhost:19100/1/check' \\
--header 'Origin: http://bad.com' \\
--header 'Content-Type: application/json' \\
curl --location 'http://localhost:19100/1/check' \
--header 'Origin: http://bad.com' \
--header 'Content-Type: application/json' \
--data '{ "urls": [{"url":"http://google.com"}, {"url": "http://youtube.com"}, {"url":"http://google.com/404"}, {"url":"https://ephox.."}]}'
----

Expand Down
35 changes: 20 additions & 15 deletions .../ROOT/partials/docker/image-proxy-service/image-proxy-service-installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ link:https://www.tiny.cloud/contact/[Contact {companyname} Support^] to request

=== Retrieve Docker Image

. Login into the {companyname} Cloud Docker Registry:
. Login into the {companyname} Cloud Docker Registry:
+
[source, sh, subs="attributes+"]
----
Expand All @@ -25,9 +25,9 @@ Replace `<VERSION>` with `latest` or the specific version number.

[NOTE]
Currently, the Docker images are only supported on x86-64 (also known as AMD64) architecture processors.
=== Specify Configurations
=== Specify Configurations

After completing the previous steps, run the Docker container from the pulled image:
After completing the previous steps, run the Docker container from the pulled image:

[source, sh, subs="attributes+"]
----
Expand All @@ -36,7 +36,7 @@ docker run -p 19040:19040 registry.containers.tiny.cloud/image-proxy-tiny:<VERSI

This triggers `-p 19040:19040`, exposing the service on `localhost:19040`. The service runs on port `19040` inside the Docker container, and this maps it to the same port on your localhost.

If set up correctly, the logs should display output similar to the following:
If set up correctly, the logs should display output similar to the following:

[source, log]
----
Expand All @@ -46,7 +46,7 @@ If set up correctly, the logs should display output similar to the following:
2025-01-08 12:03:16 [io-compute-blocker-3] WARN c.e.d.config.AllowedOriginsConfig$ - No allowed-origins specified in config!
2025-01-08 12:03:16 [io-compute-blocker-3] INFO emissary - emissary config loaded successfully: EmissaryConfig(SdkHttpConfig(HttpConfig(100,10,10,3,HttpConfigTimeouts(10,10,10),JvmTrustModel()),None),OriginWhitelist(List(),OriginPrecision(true)),Some(10000000))
2025-01-08 12:03:17 [io-compute-1] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /0:0:0:0:0:0:0:0:19040
2025-01-08 12:03:17 [io-compute-1] INFO o.h.blaze.server.BlazeServerBuilder -
2025-01-08 12:03:17 [io-compute-1] INFO o.h.blaze.server.BlazeServerBuilder -
_ _ _ _ _
| |_| |_| |_ _ __| | | ___
| ' \\ _| _| '_ \\_ _(_-<
Expand All @@ -57,7 +57,7 @@ If set up correctly, the logs should display output similar to the following:

Running this command will generate a log warning about `allowed-origins` not being configured. This is expected, as it will be set up in the next step.

The {productname} server-side components require a configuration file to function correctly. By convention, this file is named `application.conf`. For more information, refer to link:https://www.tiny.cloud/docs/tinymce/latest/configure-required-services/[Required configuration for the server-side components].
The {productname} server-side components require a configuration file to function correctly. By convention, this file is named `application.conf`. For more information, refer to link:https://www.tiny.cloud/docs/tinymce/latest/configure-required-services/[Required configuration for the server-side components].

This configuration file requires at least the following information:

Expand All @@ -72,9 +72,9 @@ The following settings for the Image Proxy service premium server-side component

* link:https://www.tiny.cloud/docs/tinymce/latest/configure-imageproxy-service/#image-proxy[image-proxy configuration]

=== Run the Docker Container
=== Run the Docker Container

The Docker container can also be run with `docker compose`. In this example, the following directory structure is assumed:
The Docker container can also be run with `docker compose`. In this example, the following directory structure is assumed:

[source,sh]
----
Expand All @@ -83,7 +83,7 @@ tiny-image-proxy/
└── application.conf # Configuration file for allowed origins and other settings
----

Here is an example of the `application.conf` file with the basic configurations:
Here is an example of the `application.conf` file with the basic configurations:

[source, conf]
----
Expand Down Expand Up @@ -115,9 +115,14 @@ services:
volumes:
- type: bind
source: ./application.conf #change this to the path on your local machine
target: /ephox-image-proxy/ephox-image-proxy-docker-env.conf
# Use the below target path if using any version below 2.111.7.
# target: /ephox-image-proxy/ephox-image-proxy-docker-env.conf
target: /app/application.conf
read_only: true
----
+
[NOTE]
From version 2.111.7 onwards, the `target` path in the volumes option must point to `/app/application.conf` .

. Run the service (within the same directory where `docker-compose.yaml` was placed):

Expand All @@ -133,7 +138,7 @@ If the setup is correct, the initiation logs should appear as follows:
+
[source, log]
----
✔ Container image-proxy-tiny-image-proxy-tiny-1 Created 0.0s
✔ Container image-proxy-tiny-image-proxy-tiny-1 Created 0.0s
Attaching to image-proxy-tiny-1
image-proxy-tiny-1 | 2025-01-08 15:02:36 [io-compute-8] INFO emissary - emissary
image-proxy-tiny-1 | 2025-01-08 15:02:36 [io-compute-8] INFO emissary - * External Configuration
Expand All @@ -160,7 +165,7 @@ image-proxy-tiny-1 | - good.com
image-proxy-tiny-1 | - example.com
image-proxy-tiny-1 | 2025-01-08 15:02:36 [io-compute-blocker-8] INFO emissary - emissary config loaded successfully: EmissaryConfig(SdkHttpConfig(HttpConfig(100,10,10,3,HttpConfigTimeouts(10,10,10),JvmTrustModel()),None),OriginWhitelist(List(good.com, example.com),OriginPrecision(true)),Some(10000000))
image-proxy-tiny-1 | 2025-01-08 15:02:37 [io-compute-1] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /0:0:0:0:0:0:0:0:19040
image-proxy-tiny-1 | 2025-01-08 15:02:37 [io-compute-1] INFO o.h.blaze.server.BlazeServerBuilder -
image-proxy-tiny-1 | 2025-01-08 15:02:37 [io-compute-1] INFO o.h.blaze.server.BlazeServerBuilder -
image-proxy-tiny-1 | _ _ _ _ _
image-proxy-tiny-1 | | |_| |_| |_ _ __| | | ___
image-proxy-tiny-1 | | ' \\ _| _| '_ \\_ _(_-<
Expand All @@ -169,7 +174,7 @@ image-proxy-tiny-1 | |_|
image-proxy-tiny-1 | 2025-01-08 15:02:37 [io-compute-1] INFO o.h.blaze.server.BlazeServerBuilder - http4s v0.23.27 on blaze v0.23.16 started at http://[::]:19040/
----

=== Next Steps
=== Next Steps

. Test the service via cURL command

Expand All @@ -194,7 +199,7 @@ To confirm that a request is being sent to the Image Proxy service, use:
+
[source, sh]
----
curl --location 'http://localhost:19040/2/image?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsrikomm%2FBMP-EDITING%2Frefs%2Fheads%2Fmaster%2Fsrc%2FInputs%2Ffish.bmp' \\
curl --location 'http://localhost:19040/2/image?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsrikomm%2FBMP-EDITING%2Frefs%2Fheads%2Fmaster%2Fsrc%2FInputs%2Ffish.bmp' \
--header 'Origin: http://good.com'
----

Expand All @@ -204,7 +209,7 @@ Finally, to verify if a request is unauthorized and originates from an incorrect
+
[source, sh]
----
curl --location 'http://localhost:19040/2/image?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsrikomm%2FBMP-EDITING%2Frefs%2Fheads%2Fmaster%2Fsrc%2FInputs%2Ffish.bmp' \\
curl --location 'http://localhost:19040/2/image?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsrikomm%2FBMP-EDITING%2Frefs%2Fheads%2Fmaster%2Fsrc%2FInputs%2Ffish.bmp' \
--header 'Origin: http://bad.com'
----

Expand Down
Loading