If you do not want to use the new Online Editor installer, you can still deploy the services via Chef Solo. In this case, however, you will have to create the oe.properties file manually on the WorldServer host machine after deploying the Online Editor services.
Before you begin
Install the following applications before starting the
Online Editor installation process: the Chef client (
chef-client-13.2.20-1-x64.msi), .NET Runtime 6.0.10 (
dotnet-runtime-6.0.10-win-x64), and ASP.NET Core Runtime 6.0.10 (
aspnetcore-runtime-6.0.10-win-x64). These applications are provided in the
Installers folder of the
WorldServer distribution kit. Keep the default installation folder for each of these applications.
Make sure that the machine on which you are deploying the
Online Editor services meets all the hardware and software requirements. Also, to deploy the
Online Editor services, you need the
Online Editor deployment kit. You can find it in the
integrations\Online Editor folder of the
WorldServer distribution kit.
Note: The Online Editor services must run on different ports than the one on which WorldServer runs. This is particularly important if you want to deploy WorldServer and Online Editor on the same machine and if you want them both to use HTTPS.
Procedure
- If you want to deploy the Online Editor services on HTTPS, perform subtasks a and b. Otherwise, skip this step.
- Import your SSL certificate on the Online Editor machine.
- Bind the certificate to the port of each Online Editor service.
- Copy and extract the Online Editor deployment kit to the C drive of the machine where you want to deploy Online Editor.
For example, C:\chef_solo_ue.
- Go to C:\chef_solo_ue\environments and open the chef_solo_env.json file with a text editor.
- Configure the WorldServer global parameters:
| Parameter | Description |
|---|
ws_protocol | The protocol on which WorldServer is running. |
ws_hostname | The fully qualified domain name of the WorldServer machine (for example, ws.mydomain.com). |
ws_port | The port on which WorldServer is running. |
- Configure the Online Editor global parameters:
| Parameter | Description |
|---|
temp_folder | The folder where temporary files will be stored during the deployment. |
startup_type | The startup type of the Online Editor services. |
- Configure the BCM Service parameters:
| Parameter | Description |
|---|
bcm_protocol | The protocol on which you want the BCM Service to run. |
hostname | The fully qualified domain name of the Online Editor machine (for example, oe.mydomain.com). |
bcm_port | The port on which you want to install the BCM Service. |
install_path | The path where the BCM Service will be installed. |
log_folder | The folder where the BCM Service log files will be stored. |
raptor_db_location | The path where RaptorDB will be installed. Use four backslashes to delimit folders. |
certificate_path | The absolute path to the .pem or .pfx certificate in HTTPS setups. Use four backslashes to delimit folders. For HTTP setups, set the value as an empty string. |
certificate_password | The password that you used to generate the .pem or the .pfx certificate. For HTTP setups, set the value as an empty string. |
- Configure the Editor Service parameters:
| Parameter | Description |
|---|
es_protocol | The protocol on which you want the Editor Service to run. |
hostname | The fully qualified domain name of the Online Editor machine (for example, oe.mydomain.com). |
es_port | The port on which you want to install the Editor Service. |
oe_domain | The publicly exposed domain name of the Editor Service. If you are not deploying Online Editor on a public-facing environment, use the same value that you entered for hostname. |
oe_port | The publicly exposed port of the Editor Service. If you are not deploying Online Editor on a public-facing environment, use the same value that you entered for es_port. |
activity_timeout | The period that users can be inactive before their Online Editor session expires. This value should be lower than or equal to the WorldServer session timeout. The value is expressed as hh:mm:ss (hours, minutes, seconds). |
es_folder | The folder where the Editor Service will be installed. |
log_folder | The folder where the Editor Service log files will be stored. |
- Configure the Editor Service Router parameters:
| Parameter | Description |
|---|
esr_protocol | The protocol on which you want the Editor Service Router to run. |
hostname | The fully qualified domain name of the Online Editor machine (for example, oe.mydomain.com). |
esr_port | The port on which you want to install the Editor Service Router. |
esr_folder | The folder where the Editor Service Router will be installed. |
log_folder | The folder where the Editor Service Router log files will be stored. |
- Configure the Verification Service parameters:
| Parameter | Description |
|---|
vs_protocol | The protocol on which you want the Verification Service to run. |
hostname | The fully qualified domain name of the Online Editor machine (for example, oe.mydomain.com). |
vs_port | The port on which you want to install the Verification Service. |
vs_folder | The folder where the Verification Service will be installed. |
log_folder | The folder where the Verification Service log files will be stored. |
Important: Do not modify the value of the description and name properties.
- Save and close the chef_solo_env.json file.
- Start a Windows PowerShell session as an administrator.
- Execute the following commands:
cd C:\chef_solo_ue\utils
.\script.ps1
- On the WorldServer host machine, go to the folder where the WorldServer configuration files are stored and create a file called oe.properties.
- Open the oe.properties file with a text editor and add the following properties:
- sdl_online_editor_enabled=true
- bcm_service.url=<protocol>://<oe_host>:<bcm_port>
- sdl_online_editor.url=<protocol>://<oe_host>:<oe_port>
- bcm_service.use_compression=true
- es.language_host=<oe_host>:<oe_port>
- es.router.url=<oe_host>:<oe_router_port>
In this case,
<oe_host> is the fully qualified domain name of the machine on which you installed
Online Editor (for example,
oe.mydomain.com),
<oe_port> is the port used by
Online Editor,
<bcm_port> is the port on which the BCM Service is running, and
<oe_router_port> is the port on which the Editor Service Router is running.
- Save and close the oe.properties file.
What to do next
Configure WorldServer to connect to Online Editor.
Note: If you encounter errors or other issues during the deployment, delete the contents of the C:\Deployment, C:\Program Files\SDL, and C:\chef\local-mode-cache folders and start over from the beginning.