Configuration

From BaseX Documentation

This article is part of the Advanced User's Guide. It gives some more insight into the configuration of BaseX.

Contents 1 Configuration Files 2 Home Directory 3 Database Directory 4 User and Log Files

[edit] Configuration Files

BaseX maintains some configuration files, which are stored in the project’s Home Directory:

• .basex contains all options that are relevant for running the server or standalone versions of BaseX.
• .basexgui defines all options relevant to the BaseX GUI.
• .basexperm contains user name, passwords, and permissions (see last paragraph).
• .basexevents contains all existing events (see Events).
• .basexhistory contains commands that have been typed in most recently.

Note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden.

[edit] Home Directory

As BaseX is distributed in different flavors, and may be started from different locations, it dynamically determines its home directory:

• First, the system property "org.basex.path" is checked. If it contains a value, it is chosen as directory path.
• If not, the current user directory (defined by the system property "user.dir") is chosen if the .basex configuration file is found in this directory.
• Otherwise, the configuration file is searched in the application directory (the folder in which the project is located).
• In all other cases, the user's home directory (defined in "user.home") is chosen.

[edit] Database Directory

A database in BaseX consists of several files, which are all bundled in a folder with the database name. If the user’s home directory has been chosen as base directory, the database folders will be stored in a BaseXData directory. Otherwise, the directory will be named datda.

The database path can be changed as follows:

• GUI: Choose Options → Preferences and choose a new database path.
• Server/Standalone: SET DBPATH [path]

Note: Existing databases will not be automatically moved to the new destination.

[edit] User and Log Files

Global users, along with their passwords and permissions, are stored in the .basexperm file in the home directory. Local users and permissions are stored inside the database files. Log files are stored in text format in the home directory BaseXData/.logs (see Logging for more information).