Install and Configure PostgreSQL (Ubuntu)
The instructions provided below are intended for the PostgreSQL administrator (not the DB host servers). If you are including the HA layer to your implementation, refer to the ThingWorx High Availability section of this Help Center .
Install PostgreSQL and Create a New User Role
1. Refer to the ThingWorx System Requirements for information on supported PostgreSQL versions.
 |
The steps in this procedure use PostgreSQL version x.x, where x.x is the supported version.
|
2. Download and install the appropriate version of PostgreSQL.
◦ The PostgreSQL repository can be added allowing the application to be installed directly from the package manager.
|
|
To get the Ubuntu version name use the following command:
$ lsb_release -sc
|
$ sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ <YOUR_UBUNTU_VERSION_HERE>-pgdg main" '> /etc/apt/sources.list.d/pgdg.list
$ sudo wget -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
$ sudo apt-get update
$ sudo apt-get install postgresql-x.x -y
3. Install PgAdmin, the PostgreSQL admin tool:
$ sudo apt-get install pgadmin4 -y
|
|
To install PgAdmin via the command line, reference https://wiki.postgresql.org/wiki/Manual_Setup_at_the_Command_Line.
|
4. Set up the password for the PostgreSQL user:
$ sudo service postgresql restart
$ sudo -u postgres psql -c "ALTER ROLE postgres WITH password '<unique PostgreSQL password>'"
$ sudo -u postgres psql -c "ALTER ROLE postgres WITH password '<unique PostgreSQL password>'"
5. Enter the password for the PostgreSQL user. You will use this password in later steps.
|
|
The password, which should not be easily guessed or a known, common password, should be at least 14 characters in length and include a mix of uppercase and lowercase letters, numbers, and special characters.
|
6. Configure PgAdmin:
$ sudo pgadmin4
◦ In the PgAdmin GUI, click on file->Open postgresql.conf
◦ Open /etc/postgresql/x.x/main/postgresql.conf
◦ Put a check next to listen addresses and port. The default settings of localhost and 5432 are usually sufficient.
◦ Save and close.
◦ Click on file->Open pg_hba.conf
◦ Open /etc/postgresql/x.x/main/pg_hba.conf
◦ Double-click on the database ‘all’ line with address 127.0.0.1/32
◦ Set Method to md5
◦ Click OK
◦ Save and exit
◦ Close PgAdmin.
7. Restart the PostgreSQL service:
$ sudo service postgresql restart
8. Set up PgAdmin to connect to the database:
$ sudo pgadmin4
9. Click the plug icon to add a connection to a server in the top left corner and fill out the following:
Name: PostgreSQL x.x
Host: localhost
Port: 5432
Service: <blank>
Maintenance DB: postgres
Username: postgres
Password: <unique PostgreSQL password as set previously>
Store password: Checked
Group: Servers
Host: localhost
Port: 5432
Service: <blank>
Maintenance DB: postgres
Username: postgres
Password: <unique PostgreSQL password as set previously>
Store password: Checked
Group: Servers
10. Click OK.
11. Create a new user role:
|
|
The following command can be used if you are not using PgAdmin:
sudo -u postgres psql -c "CREATE USER twadmin WITH PASSWORD '<unique postgres password>';"
|
b. Right click PostgreSQLx.x (<IP or host name of the database>:<Port number of PostgreSQL>). Example: PostgreSQLx.x (localhost:5432).
c. Select NewObject>NewLogin Role. On the Properties tab, enter a name in the Role name field.
d. On the Definition tab, in the Password field, enter a unique password (you will be prompted to enter it twice). You will need to re-enter this password in later steps.
|
|
The password, which should not be easily guessed or a known, common password, should be at least 14 characters in length and include a mix of uppercase and lowercase letters, numbers, and special characters.
|
e. Click OK.
Configure PostgreSQL Database Located on a Separate Server than ThingWorx
|
|
This section is optional for development environments, but should be implemented in all production environments.
|
By default, the PostgreSQL server is installed in a locked-down state. The server will only listen for connections from the local machine In order to get ThingWorx to communicate to the PostgreSQL server, some configuration changes need to be made so that PostgreSQL knows to listen for connections from other users (thingworx user, default is twadmin) and/or other machines (ThingWorx installed on a separate server).
You will need to know where your PostgreSQL data directory resides for these steps. On Linux, the location of the data folder, or even the configuration files can change based on distribution and installation method (download or package manager install). This location will be referred to as <PGDATA> in these instructions.
|
|
On Ubuntu, when installed via apt-get, the configuration files are located at /etc/postgresql/x.x/main/
|
Modify the pg_hba.conf file and add the following lines based on your desired configuration:
|
If you want to allow all IPv4 addresses to connect:
|
host all all 0.0.0.0/0 md5
|
|
If you want to allow only a specific IPv4 address to connect (Replace <ipAddress> with the IP address of the machine making the connection):
|
host all all <ipAddress>/32 md5
|
|
If you want to allow all IPv6 addresses to connect:
|
host all all ::0/0 md5
|
|
If you want to allow only a specific IPv6 address to connect (Replace <ipv6Address> with the appropriate address):
|
host all all <ipv6Address>/128 md5
|
Any other combination is possible by using additional allowance lines (individual IPs or ranges) or subnet masks appropriate to the machines that require access to the PostgreSQL database.
Any change to this file requires a restart of the database service.
|
|
For additional information about configuring the pg_hba.conf file, see the PostgreSQL documentation.
|
Enabling PostgreSQL to listen for all Connections
On Linux installations of PostgreSQL, there is an additional configuration step required to configure the PostgreSQL server to listen for connections.
1. In the postgresql.conf file, uncomment and update the listen_addresses line:
Uncomment the listen_addresses line and change localhost to '*'
# Listen on all addresses. Requires restart.
listen_addresses = '*'
# Listen on all addresses. Requires restart.
listen_addresses = '*'
2. Restart the PostgreSQL server.
Configure and Execute the PostgreSQL Database Script
To set up the PostgreSQL database and tablespace, the thingworxPostgresDBSetup script must be configured and executed.
1. Create the ThingworxPostgresqlStorage folder on the drive that the ThingworxStorage folder is located (in the root directory by default). Note the following:
◦ If you create the folder using the -d<databasename> command, you do not have to use the PostgreSQL user.
◦ You must specify the -l option to a path that exists. For example, -l D:\ThingworxPostgresqlStorage. The script does not create the folder for you.
◦ The folder must have appropriate ownership and access rights. It should be owned by the same user who runs the PostgreSQL service, and have Full Control assigned to that user - this user is generally NETWORK_SERVICE, but may differ in your environment.
$ sudo mkdir /ThingworxPostgresqlStorage
$ sudo chown postgres:postgres /ThingworxPostgresqlStorage
$ sudo chmod 755 /ThingworxPostgresqlStorage
2. Obtain the thingworxPostgresDBSetup script from the ThingWorx software download package. The script is located in the install folder. ThingWorx downloads are available inPTC Software Downloads.
3. If necessary, configure the script. Reference the options in the table below.
|
|
This example uses the 8.x.x download from the PTC site. If necessary, change the file name to the version you are using.
|
$ sudo unzip MED-61111-CD-084_ThingWorx-Platform-Postgres-8-x-x.zip
$ cd install
4. To set up the database and tablespace with a default PostgreSQL installation that has a PostgreSQL database and a PostgreSQL user name, enter:
$ sudo sh thingworxPostgresDBSetup.sh -a postgres -u <user role name> -l /ThingworxPostgresqlStorage
|
Option
|
Parameter
|
Default
|
Description
|
Example
|
|---|---|---|---|---|
|
t or -T
|
tablespace
|
thingworx
|
Tablespace name
|
-t thingworx
|
|
-p or -P
|
port
|
5432
|
Port number of PostgreSQL
|
-p 5432
|
|
-d or -D
|
database
|
thingworx
|
PostgreSQL Database name to create
|
-d thingworx
|
|
-h or -H
|
host
|
localhost
|
Name of the host
|
-h localhost
|
|
-l or -L
|
tablespace_location
|
/ThingworxPostgresqlStorage
|
Required. Location in the file system where the files representing database objects are stored.
|
-l or -L
|
|
-a or -A
|
adminusername
|
postgres
|
Administrator Name
|
-a postgres
|
|
-u or -U
|
thingworxusername
|
twadmin
|
User name that has permissions to write to the database.
|
-u twadmin
|
5. Execute the script.
Configure and Execute the Model/Data Provider Schema Script
To set up the PostgreSQL model/data provider schema, the thingworxPostgresSchemaSetup script must be configured and executed. This will set up the public schema under your database on the PostgreSQL instance installed on the localhost.
1. Obtain and open the thingworxPostgresSchemaSetup file from the ThingWorx software download package. The script is located in the install folder.
2. If necessary, configure the script. Reference the options in the table below.
|
Option
|
Parameter
|
Default
|
Description
|
Example
|
||
|---|---|---|---|---|---|---|
|
-h or -H
|
host
|
localhost
|
IP or host name of the database.
|
-h localhost
|
||
|
-p or -P
|
port
|
5432
|
Port number of PostgreSQL.
|
-p 5432
|
||
|
-d or -D
|
database
|
thingworx
|
Database name to use.
|
-d thingworx
|
||
|
-s or -S
|
schema
|
public
|
Schema name to use.
|
-s myschema
|
||
|
-u or -U
|
username
|
twadmin
|
Username to update the database schema
|
-u twadmin
|
||
|
-o or -O
|
option
|
all
|
There are three options:
• all: Sets up the model and data provider schemas into the specified database.
• model: Sets up the model provider schema into the specified database.
• data: Sets up the data provider schema into the specified database.
|
-o data
|
3. Execute the script. The script can be run with the default parameters as:
$ sudo sh thingworxPostgresSchemaSetup.sh
The username should match the PostgreSQL username that was previously created.
Configure platform-settings.json
1. Create the folder ThingworxPlatform at the root of the drive where Tomcat was installed or as a system variable. Note the following:
◦ To specify the location where ThingWorx stores its settings, you can set the THINGWORX_PLATFORM_SETTINGS environment variable to the desired location. Ensure that the folder referenced by THINGWORX_PLATFORM_SETTINGS exists and is writable by the Tomcat user. This environment variable should be configured as part of the system environment variables. Ubuntu example: THINGWORX_PLATFORM_SETTINGS=/data/ThingworxPlatform.
◦ The ThingWorx server will fail to start if it does not have read and write access to this folder.
$ sudo mkdir /ThingworxPlatform
2. Place the platform-settings.json file into the ThingworxPlatform folder. This file is available in the ThingWorx software download.
$ sudo cp platform-settings.json /ThingworxPlatform/
3. Open platform-settings.json and configure as necessary. Refer to the configuration options in platform-settings.json Configuration Details.
|
|
If your PostgreSQL server is not the same as your ThingWorx server, and you are having issues with your ThingWorx installation, review your Tomcat logs and platform-settings.json file. The default installation assumes both servers are on the same machine. While it is optional to have the PostgreSQL database on the same server as ThingWorx in a development environment, it should be separate in all production environments.
|
Encrypt the PostgreSQL Password
• Encrypt the password by following the steps in Encrypting Passwords
(Optional) Installing the PostgreSQL Client Package and PostgreSQL User
In order to issue PostgreSQL commands from the client machine to the PostgreSQL server, do so from a PostgreSQL user. The postgresql-client-x.x package can be installed on the client machine, refer to your distributions documentation on how to install it. This package provides some administration tools such as psql.
Install ThingWorx
Go to Install ThingWorx.