Watermark Server Installation

Watermark Server Installation Guide

Overview

The watermarking service can be accessed from servers that are available on the cloud or an on-premise service.

Look at this overview for more information on watermarking

file

The following guide show how to install one or more watermarking servers.

Please note the servers are delivered as a docker image.

file

Preparation

Please note the server that you install this on must be visible from the Windchill server with no firewall or restrictions

On Windchill this installation will restart the server.

Obtain the latest server release using this link

Information on Docker

Docker is an open source product platform we need to run our servers. In most cases it is free and can be installed from here, we require only the community edition (CE).

We run the CE community version in the Wincom cloud and have full confidence in it and do not require a paid for version to be installed, we fully support the use of Wincom software in CE docker. We suggest our clients do the same. CE can run on Windows 10 and Mac, on Azure and AWS, as well as CentOS, Debian, Fedora, and Ubuntu.

Docker EE, on the other hand, is a premium version of CE. Docker EE is an integrated, fully supported, and certified container platform that runs on Red Hat Enterprise Linux (RHEL), SUSE Linux Enterprise Server (SLES), Oracle Linux, Windows Server 2016

In the case the client wants to run on these O/S they will need to buy an enterprise version from Mirantis.

Install Docker

Refer to : https://docs.docker.com/install/

Obtain a license key

You should have been sent a license file from Wincom, otherwise, contact support@wincom-plm.com

The license file has a .wlc extension.

Importing the Watermarking Slave Image

  1. Decompress the serve release file, It contains a file named watermarking-slave-server.tar
  2. On a shell, type docker image load -i watermarking-slave-server.tar
  3. After the loading is done, type docker image ls and make sure that the watermarking-slave-server image exists

Running in HTTP mode

Parameter Description
${PORT} The port on which the server will listen (Typically 80)
${LICENSE_PATH} The license file path
${LICENSE_FILE} The license filename
${HOSTNAME} The server hostname
${CONTAINER_NAME} The container name, typically SlaveServerContainer

On a shell, type :

docker run -ti -d --restart unless-stopped -v ${LICENSE_PATH}:/license:ro --name=${CONTAINER_NAME} --hostname=${HOSTNAME} -p ${PORT}:${PORT} -e LISTEN_PORT=${PORT} -e LICENSE=/license/${LICENSE_FILE} watermarking-slave-server:latest`

Note : The docker container IP is the same as the host

Example

docker run -ti -d --restart unless-stopped -v C:\data\code\wex\services\watermark\security:/license:ro --name=SlaveServerContainer --hostname=beauty.ptc.com -p 8199:8199 -e LISTEN_PORT=8199 -e LICENSE=/license/wincom.wlc watermarking-slave-server:latest

Running in HTTPS mode

Parameter Description
${PORT} The port on which the server will listen (Typically 443)
${LICENSE_PATH} The license file path
${LICENSE_FILE} The license file name
${HOSTNAME} The server hostname
${CONTAINER_NAME} The container name, typically SlaveServerContainer
${CERTIFICATES_PATH} The certificates path
${SSL_KEY_FILE} The private key filename (Not encrypted)
${SSL_CER_FILE} The certificate filename

On a shell, type :

docker run -ti -d --restart unless-stopped -v ${LICENSE_PATH}:/license:ro -v ${CERTIFICATES_PATH}:/certificates:ro --name=${CONTAINER_NAME} --hostname=${HOSTNAME} -p ${PORT}:${PORT} -e LISTEN_PORT=${PORT} -e MODE=HTTPS -e SSL_KEY=/certificates/${SSL_KEY_FILE} -e SSL_CER=/certificates/${SSL_CER_FILE} -e LICENSE=/license/${LICENSE_FILE} watermarking-slave-server:latest`

Note : The docker container IP is the same as the host

Useful commands

Stopping the container

docker stop ${CONTAINER_NAME}

Starting the container

docker start ${CONTAINER_NAME}

Restarting the container

docker restart ${CONTAINER_NAME}

Removing the container

docker rm ${CONTAINER_NAME} -f

Display the server output

docker logs ${CONTAINER_NAME}

Follow the server output

docker logs -f ${CONTAINER_NAME}

Was this article helpful? Votes: 0
Article details:
Published date: 16/11/2019 2:15PM
Last updated: 26/02/2020 11:01AM (Simon Heath - simonh@wincom-consulting.com)
Share article: 
Author: simonh@wincom-plm.com (simonh@wincom-plm.com)
Permalink: https://windchill-extensions.ptc.com/kb/articles/watermark-server-install