Skip to main content

The txture_home Directory

The txture_home Directory is the location on the server where Txture stores all of its data. Additionally, before starting Txture for the first time, also some configuration and the license files have to place in this directory. Each Txture instance requires a unique txture_home Directory (sharing the same txture_home Directory among multiple Txture instances is not supported). The path to the txture_home Directory must be passed to the Txture Server at startup.

Txture needs Write Access here

As Txture stores all of its data in the txture_home Directory, it requires full read/write access to it.

Preparing the contents of a txture_home directory​

To initially prepare a txture_home directory, you need:

  • Licenses placed in a folder called certs
  • modelDefinition.json placed top-level
  • txture.properties placed top-level

All of these files will be provided by your Txture consultant. See the directory structure listing for information on the contents of these files.

Passing the txture_home Path to the Server​

There are several ways to pass the txture_home Directory path to the Txture server.

  • Via JVM Parameters: Pass the parameter -DtxtureHome="path/to/my/txture/home/folder" to the JVM. This might not be possible in all deployment scenarios.
  • Via a Volume (Docker only): Please see the Installation Instructions

txture_home Directory Structure​

This section provides an overview over the internal structure of the txture_home Directory.

txture.properties The txture.properties file contains the configuration for your Txture server. Please refer to its dedicated page for more information. This file will be provided by your Txture consultant.

certs This folder contains the required license files for the Txture instance:

  • the public key (*.crt) of your Txture instance
  • the private key (*.pem) of your txture instance
  • the public key of the Txture root certificate (txture.crt)

These files will be provided by your Txture consultant. If your license expired and you need to replace it, simply remove the public and private key and replace them by the new files.

ca-certs [Optional]

Not to be confused with the above certs directory for Txture's license certificate, this directory can hold certificate authority (CA) certificates of your organization. This allows for proper connections to servers using self-signed (by your orgs CA) TLS certificates. Adding the CA certificate to Txture's root certificate store prevents error messages similar to the following:

PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

Place any CA certificates in x509 or DER format (file endings *.pem or *.der) in the ca-certs directory and make sure that Txture can write to this directory. Note that Txture tries to set the permissions 0400 on the certificate files and therefore must have the CHOWN capability at runtime.

modelDefinition.json

This file contains the Structure data. This is a JSON file and typically provided by your Txture consultant. Alternatively, you can start with an empty metamodel by using a file only containing the following content:

[]

graph

This folder contains all asset data managed by Txture. We strongly recommend not to modify the contents of this folder, otherwise data inconsistencies may occur. This folder is generated automatically by Txture on startup if it is not present.

logs

This folder contains a variety of plain text logs produced by Txture. Administrators will mostly be interested in the application sub-folder, as Txture stores its application logs in there. This folder will be created automatically by Txture on startup if it is not present.

txture.db

A database file containing the non-asset data (such as User Accounts, User Roles and Permissions). Txture will automatically create this file on startup if it is not present.

Only present until Txture 33

This file is not needed any more starting from Txture version 34 and newer. This database file has been replaced by PostgreSQL.

temp

A temporary work directory used by Tomcat. This might not be present, depending on your setup. Txture will automatically create this folder on startup, if required.