Difference between revisions of "Configuration"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
 +
==Configuration Files==
 +
BaseX uses three configuration files, which are stored in the [[Configuration Files#Home directory|Home Directory]]
 +
(note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden):
 +
 +
* <code>.basex</code> contains all options that are relevant for running the server or standalone versions of BaseX.
 +
* <code>.basexgui</code> defines all options relevant to the BaseX GUI.
 +
* <code>.basexperm</code> contains user name, passwords, and permissions.
 +
 
==Home Directory==
 
==Home Directory==
  
Line 16: Line 24:
  
 
Note: After having changed the database path, all existing databases have to be manually moved to the new location.
 
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 [[Configuration Files#Home directory|Home Directory]]
 
(note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden):
 
 
* <code>.basex</code> contains all options that are relevant for running the server or standalone versions of BaseX.
 
* <code>.basexgui</code> defines all options relevant to the BaseX GUI.
 
* <code>.basexperm</code> contains user name, passwords, and permissions.
 
  
 
==User and Log Files==
 
==User and Log Files==

Revision as of 01:19, 24 January 2011

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.

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

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.