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:

'''Important'''{| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data: If you concurrently access 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 databases (especially for write transactionsSaxon library),.|-| {{Code|repo}}| [[Repository]] for external XQuery modules (the BaseX Server [http://www.xqueryfunctions.com FunctX] library is the way to goincluded as example). Don't use any |-| {{Code|src}}| Directory for your XQuery scripts and other standalone/GUI BaseX instancessource data.|-| {{Code|webapp}}to access databases which are also opened by | [[Web Application]] directory: home of the serverRESTXQ web application, REST scripts, and [[DBA]].|}

==BaseX Client==The Global [[Server_TutorialOptions]] are stored in the [[Configuration|BaseX Client.basex configuration file]] interface can be used to sendcommands and queries to the server instance on command line.

It can be If BaseX is started as follows(get more information [[Startup Options#BaseX Clientvia the start scripts or the Windows icons, all JAR files in the {{Code|here]]):lib}} directory and its descendant directories will be added to the class path.

*Run one of If you work with the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.batZIP distribution, and if you want to make BaseX globally available, you can add the {{Code|basexclient.bat]]</code> scripts*Execute the command <code>java -cp BaseX.jar org.basexbin}} directory to your PATH environment variable.BaseXClient</code>* On ''Windows'': Double click on the '''BaseX Client''' start icon

Please check out our little [[Server Tutorial]] for more detailsThe '''WAR Archive''' can be embedded in existing Java web servers.

==BaseX HTTP ServerOther Distributions==

<font color='orangered'>Introduced with Version 6.8</font>:<br/>The HTTP server is required to activate Various other distributions are available from the [[REST]] and [[WebDAV]] services of BaseX.It starts an instance download page, most of which contain only the [http://jetty.codehaus.org/jetty/ Jetty WebServer]core package and,which listens to the port <code>8984</code> by defaultoptionally, and the scripts for starting BaseX Server,which listens to <code>1984</code>.

* Run one of If you want to perform parallel (concurrent) read and write operations on your databases, you must use the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]<client/code>/<code>[[Start Scripts#Windows: basexhttpserver architecture or run BaseX as a web application.bat|basexhttp.bat]]</code> scripts* On ''Windows'': Double click on the '''BaseX Server You can safely open a database in different JVMs (StartJava virtual machines)''' start icon* For [[Maven]] users: type in <code>mvn jetty:run</code> in the main directory of the <code>basexfor read-api</code> projectonly access, and you will not encounter any problems when reading from and writing to different databases. The BaseX server needs Update operations from different JVMs to the same database will be manually started if the <code>org.basex.local</code> property is set rejected or may even lead to <code>false</code> (this is the default). Please have a look into the <code>pom.xml</code> file of the <code>basex-api</code> project for more optionscorrupt databases.

<font color='orangered'>Deprecated from Version 6.8</font>:The JAX-RX (REST) server More details on concurrency can be started as follows (get more information found on the [[Startup Options#BaseX JAX-RX Server|hereTransaction Management]]):page.

==See also ==;Version 10.0[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]]* Update: Switched to Java 11 ;Version 9.0* Update: Switched to Java 8 ;Version 8.0* Update: Switched to Java 7 ;Version 7.0[[Category* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP