Skip to content

Commit 5763928

Browse files
author
Sorita Heng
committed
Update Docker access info and installation instructions
1 parent 11962e9 commit 5763928

File tree

5 files changed

+62
-24
lines changed

5 files changed

+62
-24
lines changed

modules/ROOT/partials/docker/hyperlinking-service/hyperlinking-service-installation.adoc

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
[[installation]]
22
== Installation
33

4-
[NOTE]
5-
Valid credentials (username and password) are **required** in order to retrieve On-Premises services images from our Docker Registry.
6-
link:https://www.tiny.cloud/contact/[Contact {companyname} Support] to request credentials.
4+
include::partial$misc/admon-docker-access.adoc[]
75

86
=== Retrieve Docker Image
97

108
. Login into the {companyname} Cloud Docker Registry:
119
+
1210
[source, sh, subs="attributes+"]
1311
----
14-
docker login -u [username] -p [password] registry.containers.tiny.cloud
12+
docker login -u tiny -p [access-token] registry.containers.tiny.cloud
1513
----
1614

1715
. Pull the Docker Image from the Docker registry:
@@ -23,6 +21,9 @@ docker pull registry.containers.tiny.cloud/hyperlinking-tiny:<VERSION>
2321
+
2422
Replace `<VERSION>` with `latest` or the specific version number.
2523

24+
+
25+
include::partial$misc/admon-available-docker-images.adoc[]
26+
2627
=== Specify Configurations
2728

2829
After completing the previous steps, run the Docker container from the pulled image:
@@ -56,39 +57,65 @@ If set up correctly, the logs should display output similar to the following:
5657

5758
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.
5859

59-
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].
60+
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^].
6061

6162
This configuration file requires at least the following information:
6263

6364
* allowed-origins - Specifies the domains allowed to communicate with server-side editor features. This is **mandatory** for all server-side components.
6465

65-
The following settings for the premium server-side components are optional and will apply to all services that make outgoing HTTP/HTTPS requests using the configuration file.
66+
The following settings for the premium server-side components are _optional_ and will apply to all services that make outgoing HTTP/HTTPS requests using the configuration file.
6667

67-
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-common-settings-services/#proxy[proxy configuration]
68-
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-common-settings-services/#http[http configuration]
68+
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-common-settings-services/#proxy[proxy configuration^]
69+
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-common-settings-services/#http[http configuration^]
6970

7071
The following settings for the Hyperlinking premium server-side component are _optional_:
7172

72-
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-hyperlink-service/#link-checking[link-checking configuration]
73-
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-hyperlink-service/#cache[cache configuration]
73+
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-hyperlink-service/#link-checking[link-checking configuration^]
74+
* link:https://www.tiny.cloud/docs/tinymce/latest/configure-hyperlink-service/#cache[cache configuration^]
7475

75-
The {mediaembedplugin} service allows the use of a custom link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely] account, configured link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed] endpoints, or a combination of both. If a URL lacks an Iframely or oEmbed configuration, the service generates a summary card.
76+
The {mediaembedplugin} service allows the use of a custom link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely^] account, configured link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed^] endpoints, or a combination of both. If a URL lacks an Iframely or oEmbed configuration, the service generates a summary card.
7677

7778
[TIP]
7879
A summary card is an embeddable snippet of code created based on the available metadata and content detected at the URL. This ensures that even if no predefined embedding method is configured, the service can still provide a structured and visually consistent media representation.
7980

8081
When media is inserted into content, the service follows this sequence:
8182

82-
. Check if the URL matches any custom link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed] configuration. If that fails,
83-
. If link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely] is configured, query the Iframely API. If Iframely is not configured,
83+
. Check if the URL matches any custom link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed^] configuration. If that fails,
84+
. If link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely^] is configured, query the Iframely API. If Iframely is not configured,
8485
. Create a summary card.
8586

86-
The following settings for the Enhanced Media Embed service are optional:
87+
The following settings for the Enhanced Media Embed service are _optional_:
88+
89+
* link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely account configuration^]
90+
* link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed customs configuration^]
91+
92+
=== Run the Docker Container
93+
94+
The Docker container can also be run with `docker compose`. In this example, the following directory structure is assumed:
95+
96+
[source,sh]
97+
----
98+
image-proxy-service/
99+
├── application.conf
100+
└── docker-compose.yaml
101+
----
102+
103+
Here is an example of the application.conf file with the basic configurations:
87104

88-
* link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#use-your-own-iframely-account[Iframely account configuration]
89-
* link:https://www.tiny.cloud/docs/tinymce/latest/mediaembed-server-config/#configure-a-custom-endpoint[oEmbed customs configuration]
105+
[source,conf]
106+
----
107+
ephox {
108+
109+
allowed-origins {
110+
origins = [
111+
"<http://example.com>",
112+
"<http://good.com> ",
113+
"*.my.company.org"
114+
]
115+
}
90116
91-
=== Launch the Docker Container
117+
}
118+
----
92119

93120
Once the application configuration file is ready, proceed with the Docker Compose setup to configure and run the service.
94121

@@ -107,7 +134,7 @@ services:
107134
init: true
108135
volumes:
109136
- type: bind
110-
source: <PATH_TO_APPLICATION_CONF_FILE_IN_HOST_MACHINE>
137+
source: ./application.conf #change this to the path on your local machine
111138
target: /ephox-hyperlinking/ephox-hyperlinking-docker-env.conf
112139
read_only: true
113140
----
@@ -212,13 +239,15 @@ If an error occurs, the expected message is: `{ "message": "The supplied authen
212239
Before deploying, it is recommended to test this service within the {productname} editor itself.
213240

214241
+
215-
To do this, configure the link:https://www.tiny.cloud/docs/tinymce/latest/linkchecker/[{linkcheckerplugin}] and link:https://www.tiny.cloud/docs/tinymce/latest/introduction-to-mediaembed/[{mediaembedplugin}] features in the editor and call them via `tinymce.init`. If running locally on the default port `19100`, use the following settings:
242+
To do this, configure the link:https://www.tiny.cloud/docs/tinymce/latest/linkchecker/[{linkcheckerplugin}^] and link:https://www.tiny.cloud/docs/tinymce/latest/introduction-to-mediaembed/[{mediaembedplugin}^] features in the editor and call them via `tinymce.init`. If running locally on the default port `19100`, use the following settings:
216243

217244
+
218245
[source, js]
219246
----
220247
tinymce.init({
221-
…,
248+
selector: 'textarea', // change this value according to your HTML
249+
plugins: 'code image link linkchecker autolink code',
250+
toolbar: 'image link code',
222251
linkchecker_service_url: "http://localhost:19100",
223252
mediaembed_service_url: "http://localhost:19100"
224253
});
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[overview]]
22
== Overview
33

4-
The On-Premises version of the link:https://www.tiny.cloud/tinymce/features/link-checker/[{linkcheckerplugin}] and link:https://www.tiny.cloud/tinymce/features/enhanced-media-embed/[{mediaembedplugin}] is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud.
4+
The On-Premises version of the link:https://www.tiny.cloud/tinymce/features/link-checker/[{linkcheckerplugin}^] and link:https://www.tiny.cloud/tinymce/features/enhanced-media-embed/[{mediaembedplugin}^] is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud.
55

66
The only requirement to run these services On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman.
77

8-
To get started, contact link:https://www.tiny.cloud/contact/[{companyname} Support] to enable the service. A username and a password will be provided to access the {companyname} Cloud Docker registry and pull the Docker image.
8+
A valid access token is required to access the Tiny Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token.
99

1010
include::partial$misc/admon-dont-push-docker-images.adoc[]
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[[requirements]]
22
== Requirements
33

4-
* The link:https://docs.docker.com/engine/docker-overview/[Docker Engine] is installed and running.
4+
* The link:https://docs.docker.com/engine/docker-overview/[Docker Engine^] is installed and running.
55
* The user has Administrative or Root user access to run the Docker commands.
66
* The user is either:
7-
** Using a Linux, Unix or macOS operating system.
7+
** Using a Unix-like operating system, such as Linux or macOS.
88
** 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].
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[NOTE]
2+
====
3+
Currently, the Docker images are only supported on x86-64 (also known as AMD64) architecture processors.
4+
====
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[IMPORTANT]
2+
====
3+
A valid access token is **required** in order to retrieve On-Premises services images from {companyname} Cloud Docker Registry.
4+
link:https://www.tiny.cloud/contact/[Contact {companyname} Support^] to request the access token.
5+
====

0 commit comments

Comments
 (0)