ThingWorx Foundation Docker Installation Guide

ThingWorx Foundation
Docker Installation Guide
1.2
ThingWorx Foundation Docker Installer
September 2017
Copyright © 2016 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved.
User and training guides and related documentation from PTC Inc. and its subsidiary companies (collectively
“PTC”) are subject to the copyright laws of the United States and other countries and are provided under a
license agreement that restricts copying, disclosure, and use of such documentation. PTC hereby grants to the
licensed software user the right to make copies in printed form of this documentation if provided on software
media, but only for internal/personal use and in accordance with the license agreement under which the
applicable software is licensed. Any copy made shall include the PTC copyright notice and any other
proprietary notice provided by PTC. Training materials may not be copied without the express written consent
of PTC. This documentation may not be disclosed, transferred, modified, or reduced to any form, including
electronic media, or transmitted or made publicly available by any means without the prior written consent of
PTC and no authorization is granted to make copies for such purposes.
Information described herein is furnished for general information only, is subject to change without notice,
and should not be construed as a warranty or commitment by PTC. PTC assumes no responsibility or liability
for any errors or inaccuracies that may appear in this document.
The software described in this document is provided under written license agreement, contains valuable trade
secrets and proprietary information, and is protected by the copyright laws of the United States and other
countries. It may not be copied or distributed in any form or medium, disclosed to third parties, or used in any
manner not provided for in the software licenses agreement except with written prior approval from PTC.
UNAUTHORIZED USE OF SOFTWARE OR ITS DOCUMENTATION CAN RESULT IN CIVIL
DAMAGES AND CRIMINAL PROSECUTION. PTC regards software piracy as the crime it is, and we view
offenders accordingly. We do not tolerate the piracy of PTC software products, and we pursue (both civilly
and criminally) those who do so using all legal means available, including public and private surveillance
resources. As part of these efforts, PTC uses data monitoring and scouring technologies to obtain and transmit
data on users of illegal copies of our software. This data collection is not performed on users of legally
licensed software from PTC and its authorized distributors. If you are using an illegal copy of our software
and do not consent to the collection and transmission of such data (including to the United States), cease
using the illegal version, and contact PTC to obtain a legally licensed copy.
Important Copyright, Trademark, Patent, and Licensing Information: See the About Box, or copyright
notice, of your PTC software.
UNITED STATES GOVERNMENT RESTRICTED RIGHTS LEGEND
This document and the software described herein are Commercial Computer Documentation and Software,
pursuant to FAR 12.212(a)-(b) (OCT’95) or DFARS 227.7202-1(a) and 227.7202-3(a) (JUN’95), and are
provided to the US Government under a limited commercial license only. For procurements predating the
above clauses, use, duplication, or disclosure by the Government is subject to the restrictions set forth in
subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software Clause at DFARS 252.2277013 (OCT’88) or Commercial Computer Software-Restricted Rights at FAR 52.227-19(c)(1)-(2) (JUN’87),
as applicable. 01012015
PTC Inc., 140 Kendrick Street, Needham, MA 02494 USA
Contents
Overview ....................................................................................................................7
Overview..............................................................................................................8
Security Considerations ........................................................................................9
Prerequisites ......................................................................................................10
Downloading the Installer Files ............................................................................12
Installation Procedure................................................................................................15
Installing ThingWorx Foundation H2.....................................................................16
Text Mode Installation .........................................................................................21
Silent Mode Installation .......................................................................................22
Installing ThingWorx Foundation PostgreSQL .............................................................25
Text Mode Installation PostgreSQL ......................................................................36
Silent Mode Installation PostgreSQL ....................................................................36
Troubleshooting ........................................................................................................41
The Installation Log ............................................................................................42
Handling a Failed Installation ...............................................................................42
Specific Errors ....................................................................................................44
Uninstalling...............................................................................................................45
5
Document Revision History
Revision Date
Version
September 2017
1.2
July 2017
1.1
June 2017
1.0
6
Description of
Change
Updates to license
installation steps
Added additional steps
for PostgreSQL.
Initial version
1
Overview
Overview ....................................................................................................................8
Security Considerations ...............................................................................................9
Prerequisites.............................................................................................................10
Downloading the Installer Files ...................................................................................12
7
Overview
This guide provides the prerequisites and instructions for installing ThingWorx
Foundation via a Docker installation process. The guide also provides
troubleshooting information about issues you might encounter during the
installation.
Note
The Docker installation process supports three install modes:
•
Graphical — Mostly for a Windows environment
•
Text — Mostly for a Linux environment
•
Silent — Applicable to either Windows or Linux environments
In most cases, this document describes the graphical process. For more
information about the other installation modes, see Text Mode Installation or
Silent Mode Installation.
The Docker installer for ThingWorx Foundation is available for the following
persistence providers:
•
•
H2
PostgreSQL
When you launch the installer file, everything is unpacked and installed for you.
•
•
8
For the H2 installer, you will be asked to provide minimal input, such as
server location, license file, instance name, port number, and minimum and
maximum heap size.
For the PostgreSQL installer, you will be asked to provide input, such as
server location, license file, instance name, port number, and minimum and
maximum heap size. You will also be asked whether you are connecting to an
RDS PostgreSQL instance, followed by the connection information to the
already set up database, including PostgreSQL database hostname/IP address,
PostgreSQL port, admin schema, admin username, and admin password.
Finally, you will be asked to input the ThingWorx Foundation database
information that you would like to create for the install, ThingWorx
ThingWorx Foundation Docker Installation Guide
Foundation database schema, ThingWorx Foundation database username,
ThingWorx Foundation database password and ThingWorx Foundation
tablespace location.
Note
The ThingWorx Foundation installer for PostgreSQL does not come bundled
with a database. You will need to obtain and install the PostgreSQL database
and configure it prior to installation. See the Software section for more
information on installing PostgreSQL.
Locating Log Files and Directories
When using Docker, ThingWorx contents such as file repositories, logs, and
directories reside inside the Docker container. You can connect to the running
container using standard Docker commands:
docker -exec -i -t ${container_name} /bin/bash
Tomcat logs are located in:
/opt/tomcat/logs
ThingWorx directories are located in the root directory:
•
•
•
/ThingworxStorage
/ThingworxBackupStorage
/ThingworxPlatform
Application logs are located in:
•
/ThingworxStorage/logs
Security Considerations
When deploying ThingWorx Foundation, especially in a production environment,
be sure to observe all best practice security measures. Before making the server or
its components accessible to other users, consider the following security
measures:
•
•
•
Change default passwords
Disable root login for SSH access
Install an IP address-filtering firewall
Overview
9
Prerequisites
ThingWorx Foundation requires the following hardware and software. For the
most current prerequisites, refer to the ThingWorx Core 8.0 System Requirements
on the PTC Reference Documents site.
Note
If you have any version of the ThingWorx Trial Edition installed, remove it
before installing the ThingWorx Foundation. The two cannot run on the same
server.
Operating System
The ThingWorx Foundation is supported on the following operating systems:
Windows
Windows Server 2008
Windows Server 2012
Linux
CentOS 7
Ubuntu 14.04
Amazon Linux
Software: Docker
Install the appropriate version of Docker for your operating system before
installing ThingWorx. On the Install Docker Engine site, find the installation
instructions for your host operating system and follow them to install Docker
version 17.03.0-ce or later.
Note
If you are running an older Windows operating system (version 7 or 8) that
cannot run Docker natively, download the Docker Toolbox, version 17.03.0-ce
or later, instead. You can download the Docker Toolbox at https://www.
docker.com/ products/docker-toolbox.
Software: PostgreSQL
For ThingWorx Foundation installer for PostgreSQL, PostgreSQL is required. You
can find the download for PostgreSQL at their website: https://www.postgresql.
org/. ThingWorx Foundation 8.0 supports PostgreSQL 9.4, for more information,
see the ThingWorx Foundation Install Guide.
In order for ThingWorx to connect to PostgreSQL, you must allow connections
from Docker to PostgreSQL. After downloading and installing PostgreSQL, you
must edit the following files per your OS.
10
ThingWorx Foundation Docker Installation Guide
Linux: Ubuntu, RHEL, and Amazon Linux
Locate and edit the following files:
postgresql.conf: This allows database connections from the Docker container.
1.
2.
3.
4.
Open postgresql.conf.
Find #listen_addresses = ‘localhost’.
Replace with: listen_addresses = ‘*’.
Save the file.
pg_hba.conf: This allows passwords authentication to be used instead of
defaulting to user.
1. Open pg_hba.conf.
2. Locate the following section and update it to look like the section below.
Ubuntu
#TYPE DATABASE USER ADDRESS METHOD
# Database administrative login by Unix domain socket
local all postgres md5
Ubuntu, RHEL, Amazon Linux:
# TYPE DATABASE USER ADDRESS METHOD
# "local" is for Unix domain socket connections only
local all all md5
# IPv4 connections:
host all all 0.0.0.0/0 md5
# IPv6 connections:
host all all ::1/128 md5
3. Save the file.
4. After the files have been updated, restart PostgreSQL.
Windows
1. Locate and update the pg_hba.conf file:
•
Open pg_hba.conf.
•
Locate the following section: host all 127.0.0.1/32
Overview
11
•
Replace with: host all all 0.0.0.0/0
•
After the file has been updated, restart PostgreSQL.
Hardware
For sizing and hardware recommendations, refer to the ThingWorx Core 8.0
System Requirements guide.
Downloading the Installer Files
1. Log into the PTC ThingWorx eSupport page.
2. On the ThingWorx & Axeda tab, find the Software Downloads section, and
click PTC Software Downloads. The Order or Download Software Updates page
opens.
3. Enter your Customer Name and Customer Number and click Next. The PTC
Software Download page opens.
4. Scroll to ThingWorx Platform and select it.
5. Under Step 2: Choose Release & Download, navigate to the download links by
expanding each of the following successive options:
• Release <n.n>
• ThingWorx H2 or ThingWorx PostgreSQL
• Most Recent Datecode
6. Depending on whether you are downloading H2 or PostgreSQL, you will
select ThingWorx-Platform-DockerInstaller-H2-8-0-0 or ThingWorx-PlatformDockerInstaller-Postgres-8-0-0 to download the zip file and extract its contents.
The zip file includes the following installer files:
H2
File/Folder Name
installer-twxfoundationH2-enterprisewindows.exe
installer-twxfoundationH2-enterpriselinux-x64.run
installer-twxfoundationH2-enterpriseosx.app
12
Description
Installer for Windows operating
systems.
Installer for Linux operating systems.
Installer for Mac OSX operating
system.
ThingWorx Foundation Docker Installation Guide
PostgreSQL
File/Folder Name
ThingWorxAnalyticsServer- 8.0.0windows-installer.exe
ThingWorxAnalyticsServer- 8.0.0linux-x64-installer.run
ThingWorxAnalyticsServer- 8.0.0linux-x64-installer.run
Description
Installer for Windows operating
systems.
Installer for Linux operating systems.
Installer for Mac OSX operating
system.
Note
The Mac OSX installer is for developer use only and should not be run as an
enterprise environment. Specifics for installing on Mac OSX are not included
in this guide.
Overview
13
2
Installation Procedure
Installing ThingWorx Foundation H2 ...........................................................................16
Text Mode Installation ................................................................................................21
Silent Mode Installation..............................................................................................22
To install the ThingWorx Foundation with Docker, you must have administrator
privileges on the system where you are installing.
Note
This procedure represents the graphical installation mode, typically used in a
Windows environment. For launch information using Text or Silent
installation modes, see Text Mode Installation or Silent Mode Installation.
15
Installing ThingWorx Foundation H2
Installation requires the following steps:
•
•
•
•
Verify all prerequisites are met.
Download the appropriate Docker installer files for your operating system.
Extract the downloaded files to a location on your host system.
Launch one of the following installer tools (depending on which file you
downloaded for your operating system):
○
○
○
○
installer-twxfoundationH2-enterprise-windows.exe
installer-twxfoundationH2-enterprise-linux-x64.run
installer-twxfoundationH2-enterprise-osx.app
Follow the on-screen installation instructions. After each step, click Next
to advance to the next step.
1. Accept the license agreement:
16
ThingWorx Foundation Docker Installation Guide
2. Specify an installation directory. Click Next to accept the default or
click the Browse icon to navigate to a different location.
3. Select Yes or No to the question Do you have a license file? and click
Next.
Installation Procedure
17
◆ If you selected Yes, continue on the License File screen by
choosing the Browse icon to navigate to the license file.
If you need to obtain a license file, select the PTC Support Website
link to visit support.ptc.com.
18
ThingWorx Foundation Docker Installation Guide
◆ Or, if you selected No, enter the connection information for the
PTC License Server.
a. Username
Enter your username for the PTC License Server.
b. Password
Enter your password for the PTC License Server.
c. Activation ID
Enter the Activation ID you received from PTC.
4. Specify the ThingWorx Foundation instance information:
◆ ThingWorx Instance Name: This is what you would like to call the
instance, the default is twxfoundation.
◆ Local port for ThingWorx Foundation: Depending on the operating
system, Docker will attempt to forward this port back to the
localhost so that you can connect directly to the instance on this
port, the default is 8080.
◆ Java Initial Heap setting for ThingWorx Foundation: This is the
initial memory consumption in MB used by ThingWorx
Foundation on launch, the default is 1024.
Installation Procedure
19
◆ Java Max Heap setting for ThingWorx Foundation: This is the
maximum memory consumption in MB used by ThingWorx
Foundation, the default is 2048.
You will click next through a few summary pages. When you click
Next on the last step, the Docker install begins. Depending on your
operating system, several windows may open and then close while
the Docker process unpacks and installs the necessary libraries and
settings. When the installation process is complete, a final page is
displayed with a check box to View Installation Summary.
20
ThingWorx Foundation Docker Installation Guide
5. Click Finish. If the View Installation Summary check box was enabled,
an Installation Summary page displays.
6. To test the ThingWorx Foundation installation:
◆ Copy the URL from the summary page.
◆ Open a browser.
◆ Use the URL in a browser to access the platform at
http://<server>:<port>/Thingworx
If the installation has been successful, you will be prompted with
the login page. Login with the ThingWorx Foundation default
username and password.
Text Mode Installation
Text mode installation for ThingWorx is supported for a non-windows Linux
environment. The text-based installation process follows the same sequence of
steps as the graphic installation documented in Installation Procedure. You can
open a terminal window and follow the same steps, except your interactions and
responses will all be text-based. You will be prompted for the same information
and can opt to view the same type of installation summary at the end of the
process.
Installation Procedure
21
To test the ThingWorx Foundation installation:
•
Copy the URL from the installation summary.
•
Use the URL to access the platform as follows:
http://<server>:<port>/Thingworx
○ If the installation has been successful, you will be prompted with the login
page. Login with the ThingWorx Foundation default username and
password.
Silent Mode Installation
Silent mode installation is supported for both Windows and Linux environment. In
contrast to the graphical and text modes, where the installation proceeds through a
series of interactive steps, the silent installation requires that all of the necessary
input be included in the launch command. The installation then takes place with
no further interaction required.
Silent Mode for Windows
To launch the silent installation in a Windows environment:
1. Follow Steps 1 - 3 in the Installation Procedure.
2. Open a command line window and navigate to the directory where you saved
the extracted launch files.
22
ThingWorx Foundation Docker Installation Guide
Note
For a full list of commands, run installer-twxfoundationH2enterprise-windows.exe --help.
3. Run the following command, substituting specific information in the angled
brackets:
installer-twxfoundationH2-enterprise-windows.exe
<Installation Options>
License File Install Example
installer-twxfoundationH2-enterprise-windows.exe
--installdir "C:\twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal --modeunattended
--accept_eula YES --LICENSE_BIN 1
--twxlicense “C:\license.bin"
--TWX_INSTANCE_NAME twxfoundation --TWX_PORT 8080
--INITIAL_HEAP 1024 --MAX_HEAP 2048
License Server Install Example
./installer-twxfoundationH2-enterprise-windows.exe
--installdir “C:\twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal –mode unattended --accept_eula YES
--LICENSE_BIN 0 --LICENSE_SERVER_USERNAME "username"
--LICENSE_SERVER_PASSWORD "< password >"
--LICENSE_SERVER_ACTIVATION_ID "< activation id >
--TWX_INSTANCE_NAME twxfoundation --TWX_PORT 8080
--INITIAL_HEAP 1024 --MAX_HEAP 2048
When the installation is complete, the command line prompt will be returned.
•
To test the ThingWorx Foundation installation:
○
○
○
○
Navigate to the ThingWorx Foundation install directory specified above.
Open the twxfoundation.json file.
Get the URL from the "url": line.
In a browser access the URL from above.
If the installation has been successful, you will be prompted with the login page.
Login with the ThingWorx Foundation default username and password.
Silent Mode for Linux
To launch the silent installation in a Linux environment:
1. Follow Steps 1 - 3 in the Installation Procedure.
2. Open a terminal window and navigate to the directory where you saved the
extracted launch files.
Installation Procedure
23
Note
For a full list of commands, run ./installer-twxfoundationH2enterprise--linux-x64.run --help.
3. Run the following command, substituting specific information in the angled
brackets:
installer-twxfoundationH2-enterprise-linux-x64.run
<Installation Options>
License File Install Example
./installer-twxfoundationH2-enterprise-linux-x64.run
--installdir "/opt/twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal --modeunattended
--accept_eula YES --LICENSE_BIN 1
--twxlicense "/opt/license.bin"
--TWX_INSTANCE_NAME twxfoundation --TWX_PORT 8080
--INITIAL_HEAP 1024 --MAX_HEAP 2048
License Server Install Example
./installer-twxfoundationH2-enterprise- linux-x64.run
--installdir "/opt/twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal –mode unattended --accept_eula YES
--LICENSE_BIN 0 --LICENSE_SERVER_USERNAME "username"
--LICENSE_SERVER_PASSWORD "< password >"
--LICENSE_SERVER_ACTIVATION_ID "< activation id >"
--TWX_INSTANCE_NAME twxfoundation --TWX_PORT 8080
--INITIAL_HEAP 1024 --MAX_HEAP 2048
When the installation is complete, the command line prompt will be returned.
•
To test the ThingWorx Foundation installation:
○
○
○
○
Navigate to the ThingWorx Foundation install directory specified above.
Open the twxfoundation.json file.
Get the URL from the "url": line.
In a browser access the URL from above.
If the installation has been successful, you will be prompted with the login
page. Login with the ThingWorx Foundation default username and password.
24
ThingWorx Foundation Docker Installation Guide
3
Installing ThingWorx Foundation
PostgreSQL
Text Mode Installation PostgreSQL .............................................................................36
Silent Mode Installation PostgreSQL...........................................................................36
Installation requires the following steps:
Note
PostgreSQL is not bundled with the installer. In order to use the installer, you
will either need to have an RDS PostgreSQL instance to connect to or a
standalone PostgreSQL instance to connect to.
•
Make sure all of the prerequisites have been met.
•
Download the appropriate Docker installer files for your operating system.
•
Extract the downloaded files to a location on your host system.
•
Launch one of the following installer tools (depending on which file you
downloaded for your operating system):
○ installer-twxfoundationPostgres-enterprise-windows.exe
○ installer-twxfoundationPostgres-enterprise-linux-x64.run
○ installer-twxfoundationPostgres-enterprise-osx.app
1. Follow the on-screen installation instructions. After each step, click Next
to advance to the next step. You’ll be asked to accept the license
agreement:
25
2. Specify an installation directory. You can click Next to accept the default
or click the Browse icon to navigate to a different location.
26
ThingWorx Foundation Docker Installation Guide
3. Select Yes or No to the question Do you have a license file? and click Next.
○ If you selected Yes, continue on the License File screen by choosing the
Browse icon to navigate to the license file.
If you need to obtain a license file, select the PTC Support Website link
to visit support.ptc.com.
Installing ThingWorx Foundation PostgreSQL
27
○ Or, if you selected No, enter the connection information for the PTC
License Server.
a. Username
Enter your username for the PTC License Server.
b. Password
Enter your password for the PTC License Server.
c. Activation ID
Enter the Activation ID you received from PTC.
28
ThingWorx Foundation Docker Installation Guide
4. Specify the ThingWorx Foundation instance information:
○ ThingWorx Instance Name: This is what you would like to call the
instance, the default is twxfoundation.
○ Local port for ThingWorx Foundation: Depending on the operating
system, Docker will attempt to forward this port back to the localhost
so that you can connect directly to the instance on this port, the default
is 8080.
○ Java Initial Heap setting for ThingWorx Foundation: This is the initial
memory consumption in MB used by ThingWorx Foundation on
launch, the default is 1024.
○ Java Max Heap setting for ThingWorx Foundation: This is the maximum
memory consumption in MB used by ThingWorx Foundation, the
default is 2048.
Installing ThingWorx Foundation PostgreSQL
29
○ Specify whether the PostgreSQL instance you are connecting to is an
RDS instance.
30
ThingWorx Foundation Docker Installation Guide
○ Specify the PostgreSQL Database Connection Info:
◆ PostgreSQL Database Host: This is the hostname or IP address for
the PostgreSQL database.
Note
Since this is using Docker, this should not be set to localhost.
Set it to the IP address of the local machine if connecting to the
same machine or the IP address or DNS hostname of the
remote machine.
◆ PostgreSQL Database Port: This is the port number to use when
connecting to the Database host.
◆ PostgreSQL Admin Database Schema: This is the admin schema
that you created when you set up the PostgreSQL database.
◆ PostgreSQL Admin Database Username: This is the admin
username that you created when you set up the PostgreSQL
database.
◆ PostgreSQL Admin Database Password: This is the admin
password that you specified for the Admin user when you set up
the PostgreSQL database. (You are asked to type the password
twice, if both passwords do not match an error will be thrown).
Installing ThingWorx Foundation PostgreSQL
31
5. Specify the PostgreSQL database information from ThingWorx
Foundation:
○ PostgreSQL ThingWorx Foundation Database Schema: This is the
database schema that you would like to create for the ThingWorx
Foundation instance.
○ PostgreSQL ThingWorx Foundation Database Username: This is the
database username that you would like to create for the ThingWorx
Foundation instance.
○ PostgreSQL ThingWorx Foundation Database Password: This is the
database password that you would like to use for the ThingWorx
Foundation instance (You are asked to type the password twice, if both
passwords do not match an error will be thrown).
32
ThingWorx Foundation Docker Installation Guide
○ PostgreSQL Database Tablespace Location: This is the exact location
for the Tablespace Location for the ThingWorx Foundation Instance.
Note
The tablespace location must be the full path: Windows Example:
C:\postgres\tablespaces\thingworx
Linux Example: /opt/postgres/tablespaces/thingworx
RDS does not use tablespaces, you only have to place a “/” for the
installer to continue (see screenshot below).
Installing ThingWorx Foundation PostgreSQL
33
6.
a. Click through a few summary pages. When you click Next on the last
step, the Docker install begins. Depending on your operating system,
several windows may open and then close while the Docker process
34
ThingWorx Foundation Docker Installation Guide
unpacks and installs the necessary libraries and settings. When the
installation process is complete, a final page is displayed with a check
box to View Installation Summary.
b. Click Finish. If the View Installation Summary check box was enabled,
an Installation Summary page is displayed.
7. To test the ThingWorx Foundation installation:
○ Copy the URL from the summary page.
○ Open a browser and go to:
http://<server>:<port>/Thingworx
If the installation has been successful, you will be prompted with the
login page. Login with the ThingWorx Foundation default username
and password.
Installing ThingWorx Foundation PostgreSQL
35
Text Mode Installation PostgreSQL
Text mode installation of ThingWorx is supported for a non-Windows Linux
environment. The text-based installation process follows the same sequence of
steps as the graphic installation documented in Installation Procedure. You can
open a terminal window and follow the same steps, except your interactions and
responses will all be text-based. You will be prompted for the same information
and can opt to view the same type of installation summary at the end of the
process.
To test the ThingWorx Foundation installation:
•
Copy the URL from the installation summary.
•
Open a browser and use the URL to go to:
http://<server>:<port>/Thingworx
If the installation has been successful, you will be prompted with the login
page. Login with the ThingWorx Foundation default username and password.
Silent Mode Installation PostgreSQL
Silent mode installation of ThingWorx is supported for both Windows and Linux
environment. In contrast to the graphical and text modes, where the installation
proceeds through a series of interactive steps, the silent installation requires that
all of the necessary input be included in the launch command. The installation
then takes place with no further interaction required.
36
ThingWorx Foundation Docker Installation Guide
Silent Mode for Windows
To launch the silent installation in a Windows environment:
1. Follow Steps 1 - 3 in the Installation Procedure.
2. Open a command line window and navigate to the directory where you saved
the extracted launch files.
Note
For a full list of commands, run installer-twxfoundationH2enterprise-windows.exe --help.
3. Run the following command, substituting specific information in the angled
brackets.
installer-twxfoundationH2-enterprise-windows.exe
<Installation Options>
License File Install Example:
installer-twxfoundationH2-enterprise-windows.exe
--installdir "/opt/twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal --modeunattended
--accept_eula YES --LICENSE_BIN 1
--twxlicense "C:\license.bin" --TWX_INSTANCE_NAME "twxfoundation"
--TWX_PORT "8080" --INITIAL_HEAP "1024" --MAX_HEAP "2048"
--POSTGRES_HOST "127.0.0.1" --POSTGRES_PORT "5432"
--POSTGRES_ADMIN_SCHEMA "postgres"
--POSTGRES_ADMIN_USERNAME "postgres"
--POSTGRES_ADMIN_PASSWORD "< password >"
--POSTGRES_TWXFOUNDATION_SCHEMA "thingworx"
--POSTGRES_ TWXFOUNDATION_USERNAME "thingworx"
--POSTGRES_TWXFOUNDATION_PASSWORD "< password >"
--TABLESPACE_LOCATION " C:\postgres\tablespace\thingworx "
--IS_RDS_INSTANCE 0
License Server Install Example:
installer-twxfoundationH2-enterprise- windows.exe
--installdir "C:\twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal –mode unattended --accept_eula YES
--LICENSE_BIN 0 --LICENSE_SERVER_USERNAME "username"
--LICENSE_SERVER_PASSWORD "< password >"
--LICENSE_SERVER_ACTIVATION_ID "< activation id >"
--TWX_INSTANCE_NAME "twxfoundation"
--TWX_PORT "8080" --INITIAL_HEAP "1024" --MAX_HEAP "2048"
--POSTGRES_HOST "127.0.0.1" --POSTGRES_PORT "5432"
--POSTGRES_ADMIN_SCHEMA "postgres"
--POSTGRES_ADMIN_USERNAME "postgres"
Installing ThingWorx Foundation PostgreSQL
37
--POSTGRES_ADMIN_PASSWORD "< password >"
--POSTGRES_TWXFOUNDATION_SCHEMA "thingworx"
--POSTGRES_ TWXFOUNDATION_USERNAME "thingworx"
--POSTGRES_TWXFOUNDATION_PASSWORD "< password >"
--TABLESPACE_LOCATION "C:\postgres\tablespace\thingworx"
--IS_RDS_INSTANCE 0
When the installation is complete, the command line prompt will be returned.
1. To test the ThingWorx Foundation installation:
•
•
•
•
Navigate to the ThingWorx Foundation install directory specified above.
Open the twxfoundation.json file.
Get the URL from the "url": line.
In a browser, access the URL above.
If the installation has been successful, you will be prompted with the login
page. Login with the ThingWorx Foundation default username and password.
Silent Mode for Linux
To launch the silent installation in a Linux environment:
1. Follow Steps 1 - 3 in the Installation Procedure.
2. Open a terminal window and navigate to the directory where you saved the
extracted launch files.
Note
For a full list of commands, run ./installer-twxfoundationH2enterprise-linux-x64.run --help.
3. Run the following command, substituting specific information in the angled
brackets:
installer-twxfoundationH2-enterprise-linux-x64.run
<Installation Options>
License File Install Example:
./installer-twxfoundationH2-enterprise-linux-x64.run
--installdir "/opt/twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal --modeunattended
--accept_eula YES --LICENSE_BIN 1
--twxlicense "/opt/license.bin" --TWX_INSTANCE_NAME "twxfoundation"
--TWX_PORT "8080" --INITIAL_HEAP "1024" --MAX_HEAP "2048"
--POSTGRES_HOST "127.0.0.1" --POSTGRES_PORT "5432"
--POSTGRES_ADMIN_SCHEMA "postgres"
--POSTGRES_ADMIN_USERNAME "postgres"
38
ThingWorx Foundation Docker Installation Guide
--POSTGRES_ADMIN_PASSWORD "< password >"
--POSTGRES_TWXFOUNDATION_SCHEMA "thingworx"
--POSTGRES_ TWXFOUNDATION_USERNAME "thingworx"
--POSTGRES_TWXFOUNDATION_PASSWORD "< password >"
--TABLESPACE_LOCATION "/opt/postgres/tablespace/thingworx"
--IS_RDS_INSTANCE 0
License Server Install Example:
./installer-twxfoundationH2-enterprise-linux-x64.run
--installdir "/opt/twxEnterpriseFoundationH2Docker"
--unattendedmodeuiminimal –mode unattended --accept_eula YES
--LICENSE_BIN 0 --LICENSE_SERVER_USERNAME "username"
--LICENSE_SERVER_PASSWORD "< password >"
--LICENSE_SERVER_ACTIVATION_ID "< activation id >"
--TWX_INSTANCE_NAME "twxfoundation"
--TWX_PORT "8080" --INITIAL_HEAP "1024" --MAX_HEAP "2048"
--POSTGRES_HOST "127.0.0.1" --POSTGRES_PORT "5432"
--POSTGRES_ADMIN_SCHEMA "postgres"
--POSTGRES_ADMIN_USERNAME "postgres"
--POSTGRES_ADMIN_PASSWORD "< password >"
--POSTGRES_TWXFOUNDATION_SCHEMA "thingworx"
--POSTGRES_ TWXFOUNDATION_USERNAME "thingworx"
--POSTGRES_TWXFOUNDATION_PASSWORD "< password >"
--TABLESPACE_LOCATION "/opt/postgres/tablespace/thingworx"
--IS_RDS_INSTANCE 0
When the installation is complete, the command line prompt will be returned.
1. To test the ThingWorx Foundation installation:
•
•
•
•
Navigate to the ThingWorx Foundation install directory specified above.
Open the twxfoundation.json file.
Get the URL from the "url": line.
In a browser, access the URL above.
If the installation has been successful, you will be prompted with the login
page. Login with the ThingWorx Foundation default username and
password.
Installing ThingWorx Foundation PostgreSQL
39
4
Troubleshooting
The Installation Log ...................................................................................................42
Handling a Failed Installation......................................................................................42
Specific Errors ..........................................................................................................44
This section describes some common problems and their resolutions.
41
The Installation Log
During the ThingWorx Foundation installation, the installer writes a log file to the
following locations:
•
•
Linux: /tmp/bitrock_installer.log
Windows: C:\Users\Username\Appdata\Local\Temp\bitrock_installer.log
The log file contains details about the installation process. If you have issues
during the installation, you can consult the log for any errors that might be
recorded there. The log file is called: bitrock_installer.log
Handling a Failed Installation
If you are using the Docker Toolbox on a Windows computer that does not run
Docker natively, and an error occurs that prevents the ThingWorx Foundation
installation from completing successfully, you will need to remove whatever has
already been installed before you can try again
Note
The procedures below assume that you have already consulted the install log
and fixed whatever problem caused the installation to end.
.
Follow these steps to remove components:
1. If you have any version of the ThingWorx Trial Edition installed, remove it
before trying to install ThingWorx Foundation. The two cannot run on the
same server.
2. Open a Command Line window and remove the DockerMachinePTC as
follows:
•
•
•
Navigate to your user directory, such as D:\Users\lsmith
Run the following list command: docker-machine ls
A list of installed Docker machines is returned, along with status
information.
If the DockerMachinePTC is in the list, remove it with the following
command:
docker-machine rm-f DockerMachinePTC
•
42
Run the list command again to ensure that DockerMachinePTC was
removed.
ThingWorx Foundation Docker Installation Guide
3. In your Window Explorer or terminal window, navigate to the installation
directory and look for twxEnterpriseFoundationPostgresDocker
folder for PostgreSQL or
twxEnterpriseFoundationPostgresDocker for H2. If it exists,
delete it.
4. You can now try to install again.
If you are using Docker on a Windows or Linux computer running Docker
natively, and an error occurs that prevents the ThingWorx Foundation installation
from completing successfully, you will need to remove whatever has already been
installed before you can try again.
1. Open a Command Line or Terminal window and remove any remnants of a
previous install as follows:
•
•
•
docker stop TWX_INSTANCE_NAME
docker rm -f TWX_INSTANCE_NAME
docker volume rm ThingworxFoundationPostgres
ThingworxFoundationPostgresStorage
ThingworxFoundationPostgresBackupStorage
2. In your Window Explorer or terminal window, navigate to the installation
directory and look for twxEnterpriseFoundationPostgresDocker
folder for PostgreSQL or
twxEnterpriseFoundationPostgresDocker for H2. If it exists,
delete it.
3. You can now try to install again.
Troubleshooting
43
Specific Errors
Error
The system cannot move the
file to a different disk
drive:
Problem running postinstall step. Installation
may not complete correctly.
Error running postgrestest.exe
Problem running postinstall step. Installation
may not complete correctly.
Error running postgresinstance-test.exe
44
Cause
This is caused by the limitations of the
GoLang scripts used to move files. In
order to avoid this error, move the
license.bin file from the same drive you
are trying to install it on.
This is caused by the Docker container
not being able to connect to the
database. Make sure that external
connections are available to the
database. See the Prerequisites on page
10 section of this guide
This is caused by the ThingWorx
database instance that you were trying
to create already existing in the
database. You must use a unique name.
ThingWorx Foundation Docker Installation Guide
5
Uninstalling
Follow the steps below to uninstall ThingWorx.
In a Windows Environment
1. In the File Explorer navigate to the install directory.
• For PostgreSQL double click: twxfoundationpostgres_uninstall
• For H2 double click: twxfoundationh2_uninstall
2. A Question window opens asking you to confirm that you want to uninstall
ThingWorx and all its modules. Click Yes.
3. You might be asked to confirm a second time. Then the Uninstalling
ThingWorx Foundation screen opens. When the process finishes, another
window opens to let you know the uninstall is complete. Click OK to close the
window.
The ThingWorx Foundation is now uninstalled from your system.
In a Linux Environment
1. In the terminal window navigate to the install directory
• For PostgreSQL run: ./twxfoundationpostgres_uninstall
• For H2 run: ./twxfoundationh2_uninstall
2. A Question window opens asking you to confirm that you want to uninstall
ThingWorx and all its modules. Click Yes.
3. You might be asked to confirm a second time. Then the Uninstalling
ThingWorx Foundation screen opens. When the process finishes, another
window opens to let you know the uninstall is complete. Click OK to close the
window.
The ThingWorx Foundation is now uninstalled from your system
45
Download PDF
Similar pages