Caution
IT IS NOT ADVISED TO USE THIS THINGWORX DEPLOYMENT IN PRODUCTION ENVIRONMENTS. THE INTENDED USE IS IN DEVELOPMENT OF THINGWORX APPLICATIONS. BECAUSE IT'S NOT AN OFFICIAL THINGWORX DEPLOYMENT, PTC SUPPORT MAY REJECT TICKETS.
This is portable version of Thingworx. It's tested on Windows, Linux and macOS. When using ThingWorx with H2 (versions lower than 9.5), it means that a single folder contains the entire ThingWorx server, that can be archived and moved around.
When using ThingWorx 9.5 or greater, which no longer has H2 database support, configuration for the target database is needed. Please see the official docs for more information.
This repository only contains scripts and configuration files, and does not redistribute any of the required software packages required to run the Portable ThingWorx.
The following steps must be done to add these software packages on top of this codebase:
- Unzip the entire package downloaded from git.
- Download Apache Tomcat 9, the
zipbinary distribution. - Unzip it into the
apache-tomcatfolder, ensuring that the files that already exist in it are not overwritten (/confand/webapps/ROOTfolders). - Download the ThingWorx version of your choosing from the PTC Support portal.
- Place the
Thingworx.warfile inapache-tomcat/webapps.
The folder will now contain both the scripts and configuration, and the actual software packages. This folder can be used as the "seed" for multiple other environments, by just duplicating it, or zipping it up and sharing it.
Open the config.properties file in order to configure ports/other settings.
Once configured, run startThingworx script, selecting the bat or the sh version depending on your operating systems. For Windows, run startThingworx.bat.
If the port is currently occupied the startup script will begin searching for an available one (windows only). Please note that you must manually update the config.properties file with the found port if you want to persist it.
The startup script will also automatically open a web browser to the HTTP version of thingworx. A launchThingworx shortcut is also created allowing you to easily launch the Thingworx Composer.
Here are the links to the default ports:
By default, this package uses Thingworx with PostgreSQL. To change the TWX version just replace the Thingworx.war file in apache-tomcat/webapps with your war file. Please refer to the migration guide for information on how to move across persistance provider packages. If you want to change the platform-settings.json file, you can find it in the root directory of the archive.
If you ever want to create a service for a particular instance, in order to add in to startup, you have some scripts in the utils folder.
On Windows, the windows_service.bat script will automatically create a service based on the configuration in your config.properties. You can then user the native Windows UI to control the startup options.
On Linux system with systemd the systemd_unit.sh script can automatically generate a unit for a Thingworx instance. Just make sure to edit it by adding the service name.
- Ensure that Java is installed on the machine. You can set the JRE_HOME variable inside the config.properties file, but it's not required.
- On linux/macOS make sure that the sh files are marked as executable (
find . -iname \*.sh | xargs chmod +x) - Create an issue on github, or contact me placatus@iqnox.com
By downloading this software, the user acknowledges that it is unsupported, not reviewed for security purposes, and that the user assumes all risk for running it.
Users accept all risk whatsoever regarding the security of the code they download.
This software is not an official PTC product and is not officially supported by PTC.
PTC is not responsible for any maintenance for this software.
PTC will not accept technical support cases logged related to this Software.
This source code is offered freely and AS IS without any warranty.
The author of this code cannot be held accountable for the well-functioning of it.
The author shared the code that worked at a specific moment in time using specific versions of PTC products at that time, without the intention to make the code compliant with past, current or future versions of those PTC products.
The author has not committed to maintain this code and he may not be bound to maintain or fix it.
I accept the MIT License (https://opensource.org/licenses/MIT) and agree that any software downloaded/utilized will be in compliance with that Agreement. However, despite anything to the contrary in the License Agreement, I agree as follows:
I acknowledge that I am not entitled to support assistance with respect to the software, and PTC will have no obligation to maintain the software or provide bug fixes or security patches or new releases.
The software is provided “As Is” and with no warranty, indemnitees or guarantees whatsoever, and PTC will have no liability whatsoever with respect to the software, including with respect to any intellectual property infringement claims or security incidents or data loss.