The following screenshot shows the list of files in the server directory (Windows or MacOS). Not all listed files are available in the free version. The zip files provided in the download area contain all necessary files. Therefore the list shown here may differ from the actually downloaded files.
The specified subdirectories are empty during a new installation and their use is configured in the file
backupdirectory is used to store the backup files.
datadirectory for the database files
wwwdirectory for storing your own developments and import files
data directory, the
ctxchh subdirectory is used for the so-called transaction log ("change history"). If the "change history" function is active, all changes within the database are logged here (one file per day). All log entries are "chained" using hash values.
change history can be deactivated in the file
ctxserver.ini. This reduces the storage requirement and the writing time for changes in the database. This can be useful in a developer environment, but should always remain active in a realtime environment.
In order to start a database server, it is necessary that the so-called "par file" is permanently available within the program directory (i.e. in the directory in which the
ctxserver64 program file is executed). Therefore this file has to be copied as "ctxserver.par" into the main directory of the server. Only then can the server be started (or newly set up).
!!! note "par-file for the free version". In the free version the license file is "hard coded". This means that the license has been compiled into the code and cannot be changed. It is therefore not necessary to store your own par file in the directory and this only makes sense in the full version.
Initial server start¶
As a rule, a database server is delivered with an empty database. This empty database is available as a backup file and can be imported via
Remote-Admin. Thus the basic configuration is available and you can work with it immediately.
If there is no empty backup file or if you want to start with a completely empty database, the database server can create a new, empty database file.
!!! warning " Creating an empty database". The creation of an empty database is executed without confirmation and can lead to immediate data loss if the corresponding parameter is set and a database already exists.
The program file of the database server (
ctxserver64) has several call parameters. To create a new, empty database it is therefore necessary to use the console (start via
cmd.exe in Windows and
Terminal in Mac OS).
The following call leads to the creation of an empty database or overwrites the existing installation in the called directory without further inquiry. The parameter "-n" stands for "new"; the call is executed in the server directory:
Mac OS und Linux: ./ctxserver64 –n Windows: .\ctxserver64 –n
After the creation of a new database the administration can be done with the help of the program
Remote-Admin. This includes among other things the import of the second license file for a licensed version (the so-called lic file is omitted in the free version), the setup of user accounts and the import of extensions (PHP projects).
After all basic settings have been made, the server can be started with the input of "x" and the confirmation by Enter.
Each further call must only be made without the above parameter. The regular start of the database server then takes place manually or via system services.
Regular Server start¶
The regular start of the database server can be executed within the server directory. To do this, execute the following command within the console:
Mac OS und Linux: ./ctxserver64 Windows: .\ctxserver64
In Windows and Mac OS it is also possible to execute the program file
ctxserver64) with a double click. A corresponding program icon is displayed while the server is running ( in Windows as tray icon, in Mac OS as program icon).
Please note that the database monitor can be called in Windows via the tray icon. Basic functions are available via this icon, which are usually executed via the Remote-Admin (
Basic database setup¶
Recommendation for the basic configuration
Basically, only one user account is required to use the database server if the server is used for your own development. However, it is recommended to make the following configurations and to follow further specifications so that all tools of the CortexPlatform can be used.
Remote-Admin is used to define the basic configurations within the database. The same applies to the users for login and the plugins for use ( shown on the screenshot above).
For the basic use at least one user account is necessary. This is usually the
admin. This account can be created and administered via the button
user within the Remote-Admin.
User in free version
The free version has two permanently integrated user accounts that cannot be changed. User administration is therefore not required.
The admin usually gets all rights shown here and also the function
To be able to use all applications of the CortexPlatform (e.g. also as control and test tools for own developments), you have to create the account
php. This account will only contain the application
ctxphp. Everything else remains empty; only a password is set.
With these two user accounts the basic use of CortexDB is possible.
If the web applications of the CortexPlatform shall be used (delivered as xjz-files), they have to be imported in the Remote-Admin via the button
PHP-Projects ( resp.
Plugins). The import takes place one after the other via
!!! note "Import of Plugins
The import of individual xjz files always takes place one after the other. The function
Import Dir refers to the import of a complete directory structure for own plugins for the individual extension of the CortexUniplex.
Current versions of the standard plugins are available in the Download area of Cortex AG. Please note that some versions require a certain server version and should be tested in your own environment. As a rule, the plugins provided are executable on the current, free version. In the licensed version this depends on the own administration.