Difference between revisions of "Configuration"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
 
==Home Directory==
 
==Home Directory==
  
As BaseX is a portable application it searches for the location of the home directory by itself.<br />
+
As BaseX is a portable application, it dynamically determines its home directory. Three potential choices for the home directory exist:
There are three opportunities for the home directory:
+
 
*Users home directory: In standard case the users home directory is chosen to store the BaseX configuration and database files in it. So if you didn't change anything, all the BaseX files can be found in this location.
+
* By default, the '''user's home directory''' is chosen to store the BaseX configuration and database files.
*Working directory: This directory is chosen if configuration files of BaseX are found in it. So move the configuration files to the working directory if you want to have it as home directory.
+
* The '''current working directory''' is chosed if the configuration files are found in this directory. This way, you can define local settings, which will be ignored if you run BaseX from another directory.
*Application directory:  This directory is chosen if configuration files of BaseX are found in the application directory. This is especially for people using the windows installer of BaseX.
+
* Second, the '''application directory''' is checked for configuration files. This directory will be chosen, e.g., if the Windows installer has been used to get BaseX running.
  
 
==Database Directory==
 
==Database Directory==

Revision as of 01:18, 24 January 2011

Home Directory

As BaseX is a portable application, it dynamically determines its home directory. Three potential choices for the home directory exist:

  • By default, the user's home directory is chosen to store the BaseX configuration and database files.
  • The current working directory is chosed if the configuration files are found in this directory. This way, you can define local settings, which will be ignored if you run BaseX from another directory.
  • Second, the application directory is checked for configuration files. This directory will be chosen, e.g., if the Windows installer has been used to get BaseX running.

Database Directory

A database in BaseX consists of several files, which are all bundled in a folder with the database name.
All of these files are stored in a BaseXData directory in the home directory.
The path can be changed in the following ways:

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

Note: After having changed the database path, all existing databases have to be manually moved to the new location.

Configuration Files

BaseX uses three configuration files, which are stored in the Home Directory (note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden):

  • .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.

User and Log Files

The global users are stored in the .basexperm file in the home directory as the configuration files. Local users and permissions are stored in the meta data of the database, so they don't need an extra file.
All log files are stored in text format in the home directory BaseXData/.logs.