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 an installer, we recommend to manually add the project’s{{Code|bin}} 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.

====Synchronization====If you plan to concurrently read and write your dataBaseX has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.x , you should resort to theclient/server architecture11. This is because the GUIx), Linux (SuSE xxx, Debian, Redhat, CentOS, the standalone clientUbuntu) and the client/server architecture of BaseX all work in different JVMs OpenBSD (Javavirtual machinesup to 7.x) and are not synchronized among each other. You should be awarethat, in the worst case, databases might get corrupt if you use BaseX instancesin different JVMs It is platform-independent and try to enforce updatesruns on any system supporting Java.

=Startup=BaseX GUI==The [[GUI]] is the visual interface to the features of BaseX.It can be used to create new databases, perform queries or interactivelyexplore your XML data.

The GUI can be started as follows First, ensure that an up-to-date version of the Java Runtime Environment (get more information on all [[Startup Options#BaseX GUI|Startup Options]]JRE)is available:

* Double click on the {{Code|class="wikitable"|-! BaseX.jar}} file.Version! Minimum Java Version|-| 10| 11|-| 9* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex8|basexgui]]}} or {{Code-|[[Start Scripts#Windows: basex.bat8|basexgui.bat]]}} scripts.7* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXGUI}}* On ''Windows'': Double click on the '| ''BaseX GUIolder''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code6|basex}} project.

Note that the GUI does ''not'' interact with the client/server architectureIf you have several versions or distributions installed, you can type {{Code|java -version}} on command-line to check which Java version is currently used.

==BaseX Standalone==The [If you have Windows, we recommend the {{Code|.msi}} distributions from [Standalone Mode]https://adoptium.net/ Adoptium] . The JRE packages are sufficient, but you can be used to enter database commands, or execute automated database operations and queries, on command linealso install the JDK (Java Development Kit).

The standalone version can be started as follows(Next, [https://basex.org/download get more information on all [[Startup Options#a fresh copy of BaseX Standalone|Startup Options]])from our homepage. The following distributions are available:

Note that the standalone mode does The '''Core Package'not'' interact with is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.

==BaseX ServerFull Distributions==The [[Database Server]] comes into play if BaseX is to be used bymore than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],provides [[User Management|user management]] and [[Logging|logs all user interactions]].

By defaultIn addition, the server listens to '''ZIP Package''' and the port {{Code|1984}}.There are several ways of starting '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and stopping the server(get more information on all [[Startup Options#BaseX Server|Startup OptionsDBA]]), a browser-based database administration interface. If you unzip or install BaseX, the target directory will contain the following directories:

* Run one of the {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|[[Start_Scripts#bin}}| Start scripts (Windows, Linux).2FMac:_basex|-| {{Code|basexserver]]data}} or | The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Start Scripts#Windows: basex.batCatalog Resolver|basexserver.batcatalog and DTD files]].|-| {{Code|lib}} scripts| Extra libraries (Jetty, Tagsoup, …). Add the |-| {{Code|stoplib/custom}} keyword to gracefully shut down | Directory in which additional JAR files can be placed (such as the serverSaxon library).* Execute the following command: |-| {{Code|java -cp BaseXrepo}}| [[Repository]] for external XQuery modules (the [http://www.jar orgxqueryfunctions.basexcom FunctX] library is included as example).BaseXServer|-| {{Code|src}}| Directory for your XQuery scripts and other source data. Again, the |-| {{Code|stopwebapp}} keyword will ensure a graceful shutdown.* On ''Windows''| [[Web Application]] directory: Double click on home of the '''BaseX Server''' iconRESTXQ web application, REST scripts, which will also start the and [[#BaseX HTTP Server|HTTP ServerDBA]], or the '''BaseX Server (stop)''' icon.|}

Pressing {{CodeGlobal [[Options]] are stored in the [[Configuration|Ctrl+c}} will close all connections and databases and shut down the server process.basex configuration file]].

==If BaseX Client==The [[Database Serveris 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 on all [[Startup Options#BaseX Clientadd the {{Code|Startup Options]]):bin}} directory to your PATH environment variable.

The default {{Code|admin}} user '''WAR Archive''' can be used to connect to the server: <br/>* <b>Username:</b> {{Code|admin}}* <b>Password:</b> {{Code|admin}}The password should be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} 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==.

The HTTP Server can be started as followsIf you want to perform parallel (get more information concurrent) read and write operations on all [[Startup Options#your databases, you must use the client/server architecture or run BaseX HTTP Server|Startup Options]]as a web application. You 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. Update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases.

* Run one of For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} GUI or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Add a standalone instance at the {{Code|stop}} keyword to gracefully shut down the serversame time.* 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.