Difference between revisions of "Configuration"
Line 8: | Line 8: | ||
* <code>.basex</code> contains all options that are relevant for running the server or standalone versions of BaseX. | * <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>.basexgui</code> defines all options relevant to the BaseX GUI. | ||
− | |||
* <code>.basexevents</code> contains all existing events (see [[Events]]). | * <code>.basexevents</code> contains all existing events (see [[Events]]). | ||
* <code>.basexhistory</code> contains commands that have been typed in most recently. | * <code>.basexhistory</code> contains commands that have been typed in most recently. | ||
* <code>.basexhome</code> can be created by a user to mark a folder as [[#Home Directory|home directory]]. Its contents do not matter, so it is usually empty. | * <code>.basexhome</code> can be created by a user to mark a folder as [[#Home Directory|home directory]]. Its contents do not matter, so it is usually empty. | ||
+ | * Since {{Version|8.0}}, the <code>.basexperm</code> file is obsolete. Users are now stored in {{Code|users.xml}} in the database directory (see [[User Management]] for more information). | ||
Note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden. | Note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden. | ||
Line 36: | Line 36: | ||
'''Note:''' Existing databases will not be automatically moved to the new destination. | '''Note:''' Existing databases will not be automatically moved to the new destination. | ||
− | == | + | ==Log Files== |
− | + | ||
− | Log files are stored in text format in a | + | Log files are stored in text format in a <code>.logs</code> sub-directory of the database folder (see [[Logging]] for more information). |
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.0 | ||
+ | |||
+ | * Updated: {{Code|.basexperm}} is obsolete. | ||
;Version 7.7 | ;Version 7.7 | ||
− | Updated: the {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]] | + | * Updated: the {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]]. |
[[Category: Internals]] | [[Category: Internals]] |
Revision as of 01:18, 11 December 2014
This article is part of the Advanced User's Guide. It gives some more insight into the configuration of BaseX.
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..basexevents
contains all existing events (see Events)..basexhistory
contains commands that have been typed in most recently..basexhome
can be created by a user to mark a folder as home directory. Its contents do not matter, so it is usually empty.- Since Version 8.0, the
.basexperm
file is obsolete. Users are now stored inusers.xml
in the database directory (see User Management for more information).
Note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden.
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
or.basexhome
file is found in this directory. - Otherwise, the files are searched in the application directory (the folder in which the BaseX code is located).
- In all other cases, the user's home directory (defined in
user.home
) is chosen.
Database Directory
A database in BaseX consists of several files, which are located in a directory named by the name of the database.
If the user’s home directory has been chosen as base directory, the database directories will be planed in a
BaseXData
directory. Otherwise, the directory will be named data
.
The database path can be changed as follows:
- GUI: Choose Options → Preferences and choose a new database path.
- General: edit the
DBPATH
in the.basex
configuration file
Note: Existing databases will not be automatically moved to the new destination.
Log Files
Log files are stored in text format in a .logs
sub-directory of the database folder (see Logging for more information).
Changelog
- Version 8.0
- Updated:
.basexperm
is obsolete.
- Version 7.7
- Updated: the
.basexhome
file marks a folder as home directory.