Changes

Jump to navigation Jump to search
621 bytes added ,  15:31, 10 April 2019
no edit summary
This article is part of the [[Advanced User's Guide]].
It gives some more insight into the configuration of BaseX.
 
==Configuration Files==
 BaseX uses three maintains some configuration files, which are stored in the project’s [[#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>.basexpermbasexhistory</code> contains commands that have been typed in most recently.* <code>.basexhome</code> can be created by a user name, passwords, and permissions (see to mark a folder as [[#User and Log FilesHome Directory|last paragraphhome directory]]).Its contents do not matter, so it is usually empty. 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.basexeventsxml</code> contains all existing events (see [[Events]])file.
==Home Directory==
As BaseX is a portable applicationdistributed in different flavors, and may be started from different locations, it dynamically determines its home directory. Three potential choices for the home directory exist:
* The First, the '''Java system property''' {{Code|org.basex.path}} is checked. If it contains a value, it is chosen as directory path.* If not, the '''current working user directory''' will be selected (defined by the system property {{Code|user.dir}}) is chosen if the configuration files are {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory. This way, you can define local settings, which will be ignored if you run BaseX from another directory.* SecondIf not, the '''application directory''' (the folder in which BaseX is located) is checked for configuration chosen if one of these two files. This directory will be your home directory if you have used the Windows Installer to get BaseX runningis found.* In all other cases, a {{Code|basex}} subdirectory in the '''user's home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned), from 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 what directory was chosen . You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to store the BaseX configuration and database filesfind out.
==Database Directory==
A database in BaseX [[Databases]] consists of several binary files, which . These are all bundled located in a folder with directory named by the name of the database name.By default, all of these files are stored in a The database root directory in the home directory, which is named<code>BaseXData</code>. If you use the Windows installer, this directory will be named <code>{{Code|data</code>,and reside in the application directory}}.
The database path can be changed as follows:
*[[GUI Tutorial|GUI]]: Choose ''Options'' → ''Preferences'' and choose a new database path.*[[Server TutorialGeneral: edit the {{Option|Server]]/[[Standalone TutorialDBPATH}} option in the {{Code|Standalone]].basex}} configuration file '''Note: ''' Existing databases will not automatically be moved to the new destination. ==Log Files== Log files are stored in text format in a <code>SET DBPATH [path].logs</code>sub-directory of the database folder (see [[Logging]] for more information). =Changelog= ;Version 9.0 * Updated: Detection and configuration of home directory and subdirectories. ;Version 8.0
Note* Updated: After having changed {{Code|.basexperm}} is obsolete. Users are now stored in {{Code|users.xml}} in the database path, all existing databases have to be manually moved to the new locationdirectory (see [[User Management]] for more information).
==User and Log Files==Global users, along with their passwords and permissions, are stored in the <code>.basexperm</code> file in the [[#Home Directory|home directory]]. Local users and permissions are stored inside the database files.Log files are stored in text format in the home directory <code>BaseXData/.logs</code> (see [[Logging]] for more information);Version 7.7
* Updated: The {{Code|.basexhome}} file marks a folder as [[Category: Internal#Home Directory|home directory]].
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu