Skip to main content

Server

Install Java​

The server should run on every target platform where Java 21 is available. First install Java JRE 21 from oracle or Eclipse Temurin Latest Release.

if the command java --version returns something like java 21.0.2 2024-01-16 LTS it looks good for now. Be sure the java home variable JAVA_HOME is set to the correct path. $JAVA_HOME/bin/java --version should result the same output then before.

Download the server​

Download the latest Server Bundled ZIP-File from the website TK2L Website.

Unzip the file​

Use the unzip command to unzip unzip kt2l-server-...zip.

Control the server​

Navigate to the unzipped folder and start the server with the command ./bin/service.sh start.

The script service.sh is a wrapper script for the server. It is possible to:

  • start the server with ./bin/service.sh start
  • stop the server with ./bin/service.sh stop
  • restart the server with ./bin/service.sh restart
  • show the server status with ./bin/service.sh status
  • kill the server with ./bin/service.sh kill
  • cleanup the server pid with ./bin/service.sh zap
  • show the server log with ./bin/service.sh log (the logfiles could rotate, the command is not following the log rotate)
  • show the server stdout with ./bin/service.sh stdout

Configure the server startup​

The server can be configured with the file env.sh. The file is located in the root folder of the server. You can set environment variables for the server in this file.

  • JAVA_HOME - the path to the java home folder (not the binary folder)
  • PID_FILE - the path to the pid file (default is var/run/kt2l-server.pid)
  • LOG_FILE - the path to the stdout log file (default is logs/stdout.log)
  • SERVER_PORT - the port the server is listening on (default 9080)
  • KT2L_ROTATE_STDOUT - set to true to rotate the stdout at startup, otherwise false or leave empty.
  • KT2L_LOG_DIRECTORY - the path to the log directory (default is logs in the server directory)
  • KT2L_LOG_MAX_FILE_SIZE - the maximum size of a log file (default is 1GB)
  • KT2L_LOG_MAX_FILE_SIZE - the maximum number of log files (default is 10GB)
  • KT2L_LOG_LEVEL - the log level of the server (default is INFO, options are TRACE, DEBUG, INFO, WARN, ERROR)
  • CONFIGURATION_DIRECTORY - the path to the configuration directory (default is config in the server directory. It can't be overwritten directly use confic/local or config/users/<username>).
  • CONFIGURATION_LOCAL_DIRECTORY - the path to the local configuration directory (to overwrite the default configuration)
  • CONFIGURATION_USER_DIRECTORY - the path to the user configuration directory (to overwrite the default configuration for each user)
  • KT2L_TMP_DIRECTORY - the path to the temporary directory (default is the java system temporary directory)
  • KT2L_STORAGE_DIRECTORY - the path to the storage directory (default is var/storage in the server directory)
  • (KT2L_SPRING_PROFILE - additional spring profiles of the server (default is prod) - bin/run.sh only)

Update the server​

To update the server, download the latest Server Bundled ZIP-File from the website TK2L Website and unzip the file into a temporary folder. Copy the content of the bin and lib directory to your current server folder.