Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
m
==Home directory==This page is part of the [[Getting Started]] Section. It gives some insight into the configuration of BaseX.
As BaseX is a portable application it searches for the location of the home directory by itself.<br />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.*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.*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.==Configuration Files==
==Database directory==BaseX maintains some configuration files, which are stored in the project’s [[#Home Directory|Home Directory]]:
A database in * <code>.basex</code> contains all options that are relevant for running the server or standalone versions of BaseX consists of several files, which are .* <code>.basexgui</code> defines all bundled 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 folder 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 database name<code>web.xml<br /code>file. ==Home Directory== 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''' {{Code|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 {{Code|user.dir}}) is selected if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory. All * If not, the '''application directory''' (the folder in which BaseX is located) is chosen if one of these two files are stored 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>BaseXDataQ{java:org.basex.util.Prop}HOMEDIR()</code> to find out. ==Database Directory== [[Databases]] consists of several binary files. These are located in a directory in named by the name of the home database. The database root directoryis named {{Code|data}}. <br /> The database path can be changed in the following waysas 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>subdirectory of the database folder (see [[Logging]] for more information).
Note: After having changed the database path, all existing databases have to be manually moved to the new location.=Changelog=
==Configuration files==;Version 9.0
BaseX uses three * Updated: Detection and configuration files:of home directory and subdirectories.
* <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;Version 8.0
By default, all files * Updated: {{Code|.basexperm}} is obsolete. Users are now stored in the home directory{{Code|users. They can be placed xml}} in the application database directory as well(see [[User Management]] for more information).
==User and log files==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>;Version 7.7
Text replacement - "ub-director" to "ubdirector"
* Updated: The {{Code|.basexhome}} file marks a folder as [[Category: Internal#Home Directory|home directory]].
