Language: Deutsch · English

The nuclos.xml configuration file

Structure of the central configuration file – server, client and database settings incl. connection-url examples.

REFERENZ ADMINISTRATOR UPDATED: JUL 2026 APPLIES TO NUCLOS 4.2026.X

On this page

The file nuclos.xml is generated during installation and stores all settings – making updates easier. The generated (or a manually created) file can also be used for an automated installation.

Structure

<server>                Server settings
  <home>              Installation target directory
  <name>              Name of the Nuclos instance (for the service)
  <http>              <enabled> [true|false], <port>
  <https>             <enabled>, <port>,
                      <keystore> (<file>, <password>)
  <shutdown-port>     Port for the shutdown command
  <heap-size>         max. memory of the server process
  <java-home>         Java installation to use
  <production>        <enabled> [true|false]
  <development>       <enabled>, <debugport>, <jmxport>
  <launch-on-startup> run on system startup [true|false]
<client>                <singleinstance> [true|false]
<database>              Database settings
  <adapter>           [postgresql|oracle|mssql|sybase]
  <driver>            JDBC driver class
  <driverjar>         *.jar with JDBC driver
  <connection-url>    JDBC URL (see examples)
  <username> <password> <schema>
  <tablespace> <tablespace-index> (optional)
  <setup>setup</setup>  automatic DB setup (optional)
  <postgres>          <superuser> <superpw> (for auto setup)

connection-url per database

The <instance-name> must match the database instance name assigned during DB installation (for MS SQL Server the database name). The examples assume the Nuclos and DB server are identical (localhost):

Database	connection-url (example)
PostgreSQL	`jdbc:postgresql://localhost:5432/<instance-name>`
Oracle	`jdbc:oracle:thin:@localhost:1521:<instance-name>`
MS SQL Server	`jdbc:sqlserver://localhost:1433;DatabaseName=<instance-name>`
Sybase	`jdbc:sybase:Tds:localhost:2638/<instance-name>`

Automatic DB setup

With <setup>setup</setup> enabled Nuclos creates the database user, password, schema and tablespace automatically – superuser credentials must be provided under <postgres>.