Skip to content

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

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 7 Docs. #3859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d878b15
DOC-3274: Fixed the docker guides for Hyperlinking, Image Proxy, and …
abhinavgandham Sep 10, 2025
ec90c0e
Update modules/ROOT/partials/docker/hyperlinking-service/hyperlinking…
abhinavgandham Sep 10, 2025
bd93e4b
Update modules/ROOT/partials/docker/image-proxy-service/image-proxy-s…
abhinavgandham Sep 10, 2025
93e06c9
Update modules/ROOT/partials/docker/spelling-service/spelling-service…
abhinavgandham Sep 10, 2025
9e69196
DOC-3274: Removed <> from allowed origins.
abhinavgandham Sep 10, 2025
e8ee376
Did the same as previous commit for hyperlinking and image-proxy.
abhinavgandham Sep 10, 2025
1eac51c
Updated server logs.
abhinavgandham Sep 15, 2025
17e025b
DOC-3274: Fixed indentation in hyperlinking and image proxy yml code …
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
112 changes: 59 additions & 53 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,29 +34,29 @@ 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]
----
2025-01-02 11:06:45 [io-compute-8] INFO navi - navi
2025-09-15 04:46:17 [io-compute-3] INFO navi - navi
...
2025-01-02 11:06:45 [io-compute-blocker-8] INFO navi - -> Raw Config assembled from various sources: ConfigOrigin(merge of /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf: 1,system properties,reference.conf @ jar:file:/ephox-hyperlinking/ephox-hyperlinking.jar!/reference.conf: 1)
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] 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-09-15 04:46:17 [io-compute-blocker-3] INFO navi - -> Raw Config assembled from various sources: ConfigOrigin(merge of /app/application.conf: 1,system properties,reference.conf @ jar:file:/app/navi.jar!/reference.conf: 1)
2025-09-15 04:46:17 [io-compute-blocker-3] WARN c.e.d.config.AllowedOriginsConfig$ - No allowed-origins specified in config!
2025-09-15 04:46:17 [io-compute-blocker-3] WARN c.e.d.config.AllowedOriginsConfig$ - No allowed-origins specified in config!
2025-09-15 04:46:17 [io-compute-blocker-3] 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-09-15 04:46:18 [io-compute-blocker-3] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /[0:0:0:0:0:0:0:0]:19100
2025-09-15 04:46:18 [io-compute-blocker-3] INFO o.h.blaze.server.BlazeServerBuilder -
_ _ _ _ _
| |_| |_| |_ _ __| | | ___
| ' \\ _| _| '_ \\_ _(_-<
|_||_\\__|\\__| .__/ |_|/__/
| ' \ _| _| '_ \_ _(_-<
|_||_\__|\__| .__/ |_|/__/
|_|
2025-01-02 11:06:46 [io-compute-9] INFO o.h.blaze.server.BlazeServerBuilder - http4s v0.23.27 on blaze v0.23.16 started at http://[::]:19100/
2025-09-15 04:46:18 [io-compute-blocker-3] INFO o.h.blaze.server.BlazeServerBuilder - http4s v0.23.27 on blaze v0.23.16 started at http://[::]:19100/
----

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 All @@ -107,8 +107,8 @@ ephox {

allowed-origins {
origins = [
"<http://example.com>",
"<http://good.com> ",
"http://example.com",
"http://good.com",
"*.my.company.org"
]
}
Expand All @@ -126,18 +126,24 @@ Once the application configuration file is ready, proceed with the Docker Compos
----
services:
hyperlinking-tiny:
image: registry.containers.tiny.cloud/hyperlinking-tiny:<VERSION>
image: registry.containers.tiny.cloud/hyperlinking-tiny:<VERSION>
ports:
- "19100:19100"
restart: always
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.109.6 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 @@ -151,39 +157,39 @@ 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 Created 0.1s
Attaching to hyperlinking-tiny-1
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-1] INFO navi - navi

hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-7] INFO navi - navi
...

-> Found value for property: /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * Parsing config defined by /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf from property: ephox.config.file
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - -> Processing file: /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * External application.conf => /opt/ephox/application.conf
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * Optional File (/opt/ephox/application.conf). Defaults to empty if file not found
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * Internal Configuration
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - -> No extra internal configuration specified - skipping
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * Default (Reference) Configuration
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - * Loading configuration files from classpath (reference.conf and integration.conf). Neither is required.
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO navi - -> Raw Config assembled from various sources: ConfigOrigin(merge of /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf: 1,system properties,reference.conf @ jar:file:/ephox-hyperlinking/ephox-hyperlinking.jar!/reference.conf: 1)
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO c.e.d.config.AllowedOriginsConfig$ - Read allowed-origins config (ignoring ports = true) as:
hyperlinking-tiny-1 | - localhost
-> Found value for property: /app/application.conf
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * Parsing config defined by /app/application.conf from property: ephox.config.file
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - -> Processing file: /app/application.conf
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * External application.conf => /opt/ephox/application.conf
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * Optional File (/opt/ephox/application.conf). Defaults to empty if file not found
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * Internal Configuration
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - -> No extra internal configuration specified - skipping
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * Default (Reference) Configuration
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - * Loading configuration files from classpath (reference.conf and integration.conf). Neither is required.
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO navi - -> Raw Config assembled from various sources: ConfigOrigin(merge of /app/application.conf: 1,system properties,reference.conf @ jar:file:/app/navi.jar!/reference.conf: 1)
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO c.e.d.config.AllowedOriginsConfig$ - Read allowed-origins config (ignoring ports = true) as:
hyperlinking-tiny-1 | - localhost:8000
hyperlinking-tiny-1 | - ephox.com
hyperlinking-tiny-1 | 2025-01-02 16:17:28 [io-compute-blocker-1] INFO c.e.d.config.AllowedOriginsConfig$ - Read allowed-origins config (ignoring ports = true) as:
hyperlinking-tiny-1 | - localhost
hyperlinking-tiny-1 | - example.com
hyperlinking-tiny-1 | - good.com
hyperlinking-tiny-1 | - my.company.org
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] INFO c.e.d.config.AllowedOriginsConfig$ - Read allowed-origins config (ignoring ports = true) as:
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 | - example.com
hyperlinking-tiny-1 | - good.com
hyperlinking-tiny-1 | - my.company.org
hyperlinking-tiny-1 | 2025-09-15 04:57:29 [io-compute-blocker-7] 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:8000, example.com, good.com, my.company.org),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:8000, example.com, good.com, my.company.org),OriginPrecision(true)),Logger[navi])
hyperlinking-tiny-1 | 2025-09-15 04:57:30 [io-compute-blocker-7] INFO o.h.b.c.nio1.NIO1SocketServerGroup - Service bound to address /[0:0:0:0:0:0:0:0]:19100
hyperlinking-tiny-1 | 2025-09-15 04:57:30 [io-compute-blocker-7] INFO o.h.blaze.server.BlazeServerBuilder -
hyperlinking-tiny-1 | _ _ _ _ _
hyperlinking-tiny-1 | | |_| |_| |_ _ __| | | ___
hyperlinking-tiny-1 | | ' \\ _| _| '_ \\_ _(_-<
hyperlinking-tiny-1 | |_||_\\__|\\__| .__/ |_|/__/
hyperlinking-tiny-1 | | ' \ _| _| '_ \_ _(_-<
hyperlinking-tiny-1 | |_||_\__|\__| .__/ |_|/__/
hyperlinking-tiny-1 | |_|
hyperlinking-tiny-1 | 2025-01-02 16:17:29 [io-compute-6] INFO o.h.blaze.server.BlazeServerBuilder - http4s v0.23.27 on blaze v0.23.16 started at http://[::]:19100/
hyperlinking-tiny-1 | 2025-09-15 04:57:30 [io-compute-blocker-7] INFO o.h.blaze.server.BlazeServerBuilder - http4s v0.23.27 on blaze v0.23.16 started at http://[::]:19100/
----

=== Next Steps
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
Loading