Changes

This article is part of the [[Getting Started]] Guide.It tells you how to get BaseX running.

==Requirements=Introduction=

===BaseX===Please [http://basex.org/download download] the latest BaseX version from our homepage.The official releases include the BaseX JAR file, libraries and optional [[Start Scripts]]is very light-weight.If you do not use the Windows version, we recommend to manually add the project’s<code>bin</code> directory to your path environment; this way, you will It can be able to runBaseX from everywhere and used in your shell/terminal.many different ways:

===Java===# BaseX comes with a [[GUI|Graphical User Interface]] that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.A Runtime Environment of # You can start BaseX as a standalone [[http://www.java.com Java 1.6Command-Line Client]] (JRE) is needed if you prefer to work in the terminal, or want to run BaseXdo batch processing.BaseX # The [[Database Server]] is platform independent the right choice if you have multiple users or clients, or if you use other programming languages and runs on any system that provides a Java Virtual Machineif you don’t require HTTP services.BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10# The [[Web Application|HTTP Server]] provides [[REST]] and [[WebDAV]] services.x),Linux(SuSE xxxWith [[RESTXQ]], Debiancomplex web applications can be built, Ubuntu) and OpenBSD (4the embedded [[DBA]] application allows you to work with BaseX in the browser.x)# It can also be embedded as a Java library in your applications.

==BaseX GUI==The [[GUI_Tutorial|BaseX GUI]] is the visual interface has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.x , 11.x), Linux (SuSE xxx, Debian, Redhat, CentOS, Ubuntu) and OpenBSD (up to the features of BaseX7.x).It can be used to create new databases, perform queries or interactivelyexplore your XML datais platform-independent and runs on any system supporting Java.

The GUI can be started as follows (get more information [[=Startup Options#BaseX GUI|here]]):=

* Double click on the <code>BaseX.jar</code> file.* Run one First, ensure that an up-to-date version of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts.* Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>.* On ''Windows'': Double click on the '''BaseX GUI''' start icon.* For [[Maven]] usersJava Runtime Environment (JRE) is available: type in <code>mvn exec:java</code> in the main directory of the <code>basex</code> project.

{| class="wikitable"|-! BaseX Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older'Important''': The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same databasefrom the GUI and the server, esp. if updates are performed.| 6|}

==BaseX Standalone==The [[Standalone_Tutorial|BaseX Standalone]] interface can be usedto enter database commands, If you have several versions or execute automated database operationsand queriesdistributions installed, you can type {{Code|java -version}} on command -lineto check which Java version is currently used.

If you have Windows, we recommend the {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The standalone version JRE packages are sufficient, but you can be started as followsalso install the JDK (get more information [[Startup Options#BaseX Standalone|here]]Java Development Kit):.

*Run one of the <code>Next, [[Start_Scripts#Linux.2FMachttps:_basex|basex]]</code>/<code>[[Start Scripts#Windows: basex.bat|basex.bat]]<org/code> scripts*Execute the command <code>java -cp download get a fresh copy of BaseX] from our homepage.jar org.basex.BaseX</code>* On ''Windows''The following distributions are available: Double click on the '''BaseX''' start icon

==BaseX Server==The [[Server_Tutorial|BaseX Server]] comes into play if BaseX '''Core Package''' is to be used bymore than one user (client)a very compact JAR file. It handles concurrent [[Transaction_Management|read and write transactions]]contains the BaseX database management system, the XQuery processor, the client/server architecture,provides [[User Management|user management]] and [[Logging|logs all the graphical user interactions]]interface. It runs without additional libraries.

* Run one of In addition, the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts.* Execute the command <code>java -cp BaseX.jar org.basex.BaseXServer</code>.* On ''Windows'ZIP Package''': Double click on and the '''BaseX Server (Start)Windows Installer''' start iconcontain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[DBA]], a browser-based database administration interface. This If you unzip or install BaseX, the target directory will also start contain the JAX-RX (HTTP) server.following directories:

Pressing <code>Ctrl+c<{| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Catalog Resolver|catalog and DTD files]].|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).|-| {{Code|lib/custom}}| Directory in which additional JAR files can be placed (such as the Saxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery modules (the [http://code> will close all connections www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and databases other source data.|-| {{Code|webapp}}| [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and shut down the server process[[DBA]].|}

'''Important''': If you plan to concurrently access your databases (especially for write transactions),Global [[Options]] are stored in the BaseX Server mode is mandatory[[Configuration|. You may encounter unexpected behavior and possibly even corrupt databasesif you use any other standalone/GUI BaseX instances to access databases which are also opened by the serverbasex configuration file]].

==If BaseX Client==The [[Server_Tutorialis started via the start scripts or the Windows icons, all JAR files in the {{Code|BaseX Client]] interface can lib}} directory and its descendant directories will be used to sendcommands and queries added to the server instance on command lineclass path.

It If you work with the ZIP distribution, and if you want to make BaseX globally available, you can be started as follows(get more information [[Startup Options#BaseX Clientadd the {{Code|here]]):bin}} directory to your PATH environment variable.

The default <code>admin</code> user '''WAR Archive''' can be used to connect to the server: <br/>* <b>Username:</b> <code>admin</code>* <b>Password:</b> <code>admin</code>The password should be changed with the <code>[[Commands#PASSWORD|PASSWORD]]</code> command after the first loginembedded in existing Java web servers.<br/>

==Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX HTTP Server==.

<font color='orangered'>Introduced with Version 6.8</font>:<br/>The HTTP server is required to activate the [[REST]] and [[WebDAV]] services of BaseX.It starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty WebServer],which listens to the port <code>8984</code> by default, and the BaseX Server,which listens to <code>1984</code>.Concurrent Operations=

The HTTP Server If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or run BaseX as a web application. You can be started as followssafely open a database in different JVMs (get more information [[Startup Options#BaseX HTTP Server|here]]Java virtual machines):for read-only access, and you will not encounter any problems when reading from and writing to different databases. Update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases.

* Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts* On ''Windows'': Double click on the '''BaseX Server For example, if you only read data, you can easily run several clients (Startstandalone, GUI, database clients)''' start icon* For [[Maven]] users: type in <code>mvn jetty:run</code> in the main directory of the <code>basex-api</code> projectparallel. The BaseX server needs to be manually started if If you update your data, however, you shouldn’t use the <code>org.basex.local</code> property is set to <code>false</code> (this is the default). Please have GUI or a look into the <code>pom.xml</code> file of standalone instance at the <code>basex-api</code> project for more optionssame time.

Pressing <code>Ctrl+c</code> will close all connections and databases and shut down More details on concurrency can be found on the server process[[Transaction Management]] page.

<font color='orangered'>Deprecated from ;Version 69.8</font>:0The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]])* Update:Switched to Java 8

* Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx;Version 8.bat]]</code> scripts0* On ''Windows''Update: Double click on the '''BaseX Server (Start)''' start iconSwitched to Java 7

==See also ==;Version 7.0[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]][[Category* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP