Changes

This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running. The application can be run and used in various ways:

'''Important:''' If you plan to concurrently read and write your data, the client/serverarchitecture BaseX is mandatoryvery light-weight. This is because the standalone applications It can be run and theclient/server architecture of BaseX all work used in many different JVMs (Java virtual machines)and are not synchronized among each other. You should be aware that, in the worst case,databases might get corrupt if you use BaseX in different modes and try to enforce updates.ways:

====BaseX====Please [http://basexhas been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.org/download download] the latest BaseX version from our homepagex , 11.The official releases include the BaseX JAR filex), Linux (SuSE xxx, Debian, libraries and optional [[Start Scripts]].If you do not use an installerRedhat, we recommend to manually add the project’s{{Code|bin}} directory to your path environment; this wayCentOS, you will be able Ubuntu) and OpenBSD (up to runBaseX from everywhere in your shell/terminal7.x). It is platform-independent and runs on any system supporting Java.

=Startup===Java====A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.BaseX is platform independent and runs on any system that provides a Java Virtual Machine.BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).

==BaseX GUI==The [[GUI]] is the visual interface First, ensure that an up-to -date version of the features of BaseX.It can be used to create new databases, perform queries or interactivelyexplore your XML data.Java Runtime Environment (JRE) is available:

The GUI can be started as follows (get more information on all [[Startup Options#{| class="wikitable"|-! BaseX GUIVersion! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|Startup Options]]):}

* Double click on the {{Code|BaseX.jar}} file.* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} If you have several versions or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts.* Execute the following command: distributions installed, you can type {{Code|java -cp BaseX.jar org.basex.BaseXGUIversion}}* On ''Windows'': Double click on the '''BaseX GUI''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} projectcommand-line to check which Java version is currently used.

Note that If you have Windows, we recommend the GUI does ''not'' interact with {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are sufficient, but you can also install the client/server architectureJDK (Java Development Kit).

==Next, [https://basex.org/download get a fresh copy of BaseX Standalone==The [[Standalone Mode]] can be used to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML datafrom our homepage.The following distributions are available:

* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On The ''Windows'': Double click on the Core Package'''is a very compact JAR file. It contains the BaseX''' icondatabase management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.

==BaseX Server==The [[Database Server]] comes into play if BaseX is to be used bymore than one user (client). It handles concurrent [[Transaction_Management|read In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and write transactions]]other advanced features,provides [[User Management|user managementStart Scripts]] , and the [[Logging|logs all user interactionsDBA]], a browser-based database administration interface.If you unzip or install BaseX, the target directory will contain the following directories:

By default{| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, the server listens to the port Linux).|-| {{Code|1984data}}| The database directory.There are several ways of starting |-| {{Code|etc}}| Example data: XML sample, [[Catalog Resolver|catalog and stopping DTD files]].|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).|-| {{Code|lib/custom}}| Directory in which additional JAR files can be placed (such as the serverSaxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery modules (get more information on all the [http://www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and other source data.|-| {{Code|webapp}}| [[Startup Options#BaseX Server|Startup OptionsWeb Application]])directory:home of the RESTXQ web application, REST scripts, and [[DBA]].|}

* Run one of the {{Code|Global [[Start_Scripts#Linux.2FMac:_basex|basexserverOptions]]}} or {{Code|are stored in the [[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.* Execute the following command: {{CodeConfiguration|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Serverconfiguration file]], or the '''BaseX Server (stop)''' icon.

Pressing If BaseX is started via the start scripts or the Windows icons, all JAR files in the {{Code|Ctrl+clib}} directory and its descendant directories will close all connections and databases and shut down be added to the server processclass path.

==If you work with the ZIP distribution, and if you want to make BaseX Client==The [[Database Serverglobally available, you can add the {{Code|BaseX Client]] interface can be used bin}} directory to sendcommands and queries to the server instance on command lineyour PATH environment variable.

* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}* On The ''Windows'WAR Archive': Double click on the '''BaseX Client''' iconcan be embedded in existing Java web servers.

Please check out Various other distributions are available from the article on download page, most of which contain only the [[Database Server]] core package and, optionally, scripts for more detailsstarting BaseX.

==BaseX HTTP Server=Concurrent Operations=

The HTTP Server gives access If you want to the [[REST]], [[RESTXQ]] perform parallel (concurrent) read and [[WebDAV]] Services of BaseX.By defaultwrite operations on your databases, it starts an instance of you must use the [http:client//jettyserver architecture or run BaseX as a web application.codehausYou can safely open a database in different JVMs (Java virtual machines) for read-only access, and you will not encounter any problems when reading from and writing to different databases.org/jetty/ Jetty Web Server],which listens Update operations from different JVMs to the port {{Code|8984}}, and the BaseX Server, which listens same database will be rejected or may even lead to {{Code|1984}}corrupt databases.

To run the HTTP ServerFor example, if you only read data, you need to [http://basex.org/products/download/ download] one of the full distributions of BaseX can easily run several clients (exestandalone, zipGUI, wardatabase clients)in parallel. If you update your data, however, as you shouldn’t use the GUI or a standalone instance at the JAR version does not include any additionally required librariessame time. It can then be started as follows(get more information on all [[Startup Options#BaseX HTTP Server|Startup Options]]):

* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Call the script with the {{Code|stop}} keyword to gracefully shut down the server.* On ''Windows'': Double click More details on concurrency can be found on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.* For [[Maven]] users: type in {{Code|mvn jetty:run}} in the main directory of the {{Code|basex-api}} project, and press {{Code|Ctrl+c}} to shut down the process.* You may also want to deploy BaseX as a [[Web ApplicationTransaction Management]]page.