Difference between revisions of "Configuration"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "ub-director" to "ubdirector")
 
(72 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
This page is part of the [[Getting Started]] Section. It gives some insight into the configuration of BaseX.
 +
 +
==Configuration Files==
 +
 +
BaseX maintains some configuration files, which are stored in the project’s [[#Home Directory|Home Directory]]:
 +
 +
* <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>.basexhistory</code> contains commands that have been typed in most recently.
 +
* An empty <code>.basexhome</code> file can be added to a directory to mark it as [[#Home Directory|home directory]].
 +
 +
Note that:
 +
 +
* Depending on your OS and configuration, files and folders with a '.' prefix may be hidden.
 +
* In the [[Web Application]] context, options can be defined in the <code>web.xml</code> file.
 +
 
==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 distributed in different flavors, and as it may be started from different locations, it dynamically determines its home directory:
−
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.
+
* First, the '''Java system property''' {{Code|org.basex.path}} is checked. If it contains a value, it is chosen as directory path.
−
*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.
+
* If not, the '''current user directory''' (defined by the system property {{Code|user.dir}}) is selected if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this 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.
+
* If not, the '''application directory''' (the folder in which BaseX is located) is chosen if one of these two files is found in that directory.
 +
* In all other cases, a {{Code|basex}} subdirectory in the '''user home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned) the Java system property {{Code|user.home}}.
 +
 
 +
If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear which directory was picked. You can run the XQuery expression <code>Q{java:org.basex.util.Prop}HOMEDIR()</code> to find out.
  
 
==Database Directory==
 
==Database Directory==
  
−
A database in BaseX consists of several files, which are all bundled in a folder with the database name.<br />
+
[[Databases]] consists of several binary files. These are located in a directory named by the name of the database. The database root directory is named {{Code|data}}.
−
All of these files are stored in a <code>BaseXData</code> directory in the home directory. <br />
 
−
The path can be changed in the following ways:
 
−
*[[GUI Tutorial|GUI]]: Choose ''Options'' → ''Preferences'' and choose a new database path.
 
−
*[[Server Tutorial|Server]]/[[Standalone Tutorial|Standalone]]: <code>SET DBPATH [path]</code>
 
  
−
Note: After having changed the database path, all existing databases have to be manually moved to the new location.
+
The database path can be changed as follows:
 +
* GUI: Choose ''Options'' → ''Preferences'' and choose a new database path.
 +
* General: edit the {{Option|DBPATH}} option in the {{Code|.basex}} configuration file
  
−
==Configuration Files==
+
'''Note:''' Existing databases will not automatically be moved to the new destination.
 +
 
 +
==Log Files==
 +
 
 +
Log files are stored in text format in a <code>.logs</code> subdirectory of the database folder (see [[Logging]] for more information).
 +
 
 +
=Changelog=
 +
 
 +
;Version 9.0
 +
 
 +
* Updated: Detection and configuration of home directory and subdirectories.
  
−
BaseX uses three configuration files, which are stored in the [[Configuration Files#Home directory|Home Directory]]
+
;Version 8.0
−
(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.
+
* Updated: {{Code|.basexperm}} is obsolete. Users are now stored in {{Code|users.xml}} in the database directory (see [[User Management]] for more information).
−
* <code>.basexgui</code> defines all options relevant to the BaseX GUI.
 
−
* <code>.basexperm</code> contains user name, passwords, and permissions.
 
  
−
==User and Log Files==
+
;Version 7.7
−
The global users are stored in the <code>.basexperm</code> 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. <br />
 
−
All log files are stored in text format in the home directory <code>BaseXData/.logs</code>.
 
  
−
[[Category: Internal]]
+
* Updated: The {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]].

Latest revision as of 15:59, 25 July 2022

This page is part of the Getting Started Section. It gives some insight into the configuration of BaseX.

Configuration Files[edit]

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.
  • .basexhistory contains commands that have been typed in most recently.
  • An empty .basexhome file can be added to a directory to mark it as home directory.

Note that:

  • Depending on your OS and configuration, files and folders with a '.' prefix may be hidden.
  • In the Web Application context, options can be defined in the web.xml file.

Home Directory[edit]

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

  • First, the Java 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 selected if the .basex or .basexhome file is found in this directory.
  • If not, the application directory (the folder in which BaseX is located) is chosen if one of these two files is found in that directory.
  • In all other cases, a basex subdirectory in the user home directory will be returned. The user home directory is retrieved via the HOME environment variable, or (if unassigned) the Java system property user.home.

If BaseX is used in an embedded environment (such as a servlet in a Web Application), it may not immediately be clear which directory was picked. You can run the XQuery expression Q{java:org.basex.util.Prop}HOMEDIR() to find out.

Database Directory[edit]

Databases consists of several binary files. These are located in a directory named by the name of the database. The database root directory is named data.

The database path can be changed as follows:

  • GUI: Choose Options → Preferences and choose a new database path.
  • General: edit the DBPATH option in the .basex configuration file

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

Log Files[edit]

Log files are stored in text format in a .logs subdirectory of the database folder (see Logging for more information).

Changelog[edit]

Version 9.0
  • Updated: Detection and configuration of home directory and subdirectories.
Version 8.0
  • Updated: .basexperm is obsolete. Users are now stored in users.xml in the database directory (see User Management for more information).
Version 7.7
Retrieved from "http://docs.basex.org/index.php?title=Configuration&oldid=16164"