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{{Mono|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.

====GUI/Standalone vsBaseX 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 7.x). It is platform-independent and runs on any system supporting Java. Client/Server====

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

==BaseX Standalone==The If you have Windows, we recommend the {{Code|.msi}} distributions from [[Standalone_Tutorial|BaseX Standalonehttps://adoptium.net/ Adoptium]] interface . The JRE packages are sufficient, but you can be usedto enter database commands, or execute automated database operationsand 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:

==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 {{Mono|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]}}/{{Mono|[[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts.* Execute the command {{Mono|java -cp BaseX.jar org.basex.BaseXServer}}.* On ''Windows'ZIP Package''': Double click on and the '''BaseX ServerWindows Installer''' start icon. This will also start contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[#BaseX HTTP Server|HTTP ServerDBA]], a browser-based database administration interface.If you unzip or install BaseX, the target directory will contain the following directories:

Pressing {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {Mono{Code|Ctrl+cdata}} will close all connections | The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Catalog Resolver|catalog and databases 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://www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and shut down other source data.|-| {{Code|webapp}}| [[Web Application]] directory: home of the server processRESTXQ 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 on via the start scripts or the Windows icons, all [[Startup Options#BaseX ClientJAR files in the {{Code|Startup Options]]):lib}} directory and its descendant directories will be added to the class path.

*Run one of If you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the {{Mono|[[Start_Scripts#Linux.2FMac:_basexCode|basexclient]]bin}}/{{Mono|[[Start Scripts#Windows: basex.bat|basexclientdirectory to your PATH environment variable.bat]]}} scripts*Execute the command {{Mono|java -cp BaseX.jar org.basex.BaseXClient}}* 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==

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 {{Mono|8984}} by defaultoptionally, and the scripts for starting BaseX Server,which listens to {{Mono|1984}}.

* Run one of If you want to perform parallel (concurrent) read and write operations on your databases, you must use the {{Mono|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}}client/{{Mono|[[Start Scripts#Windows: basexhttpserver architecture or run BaseX as a web application.bat|basexhttp.bat]]}} scripts* On ''Windows'': Double click on the '''BaseX Server''' start icon* For [[Maven]] users: type You can safely open a database in {{Mono|mvn jetty:run}} in the main directory of the {{Mono|basexdifferent JVMs (Java virtual machines) for read-api}} project. By defaultonly access, the HTTP services and you will talk not encounter any problems when reading from and writing to a local BaseX instancedifferent databases. If Update operations from different JVMs to the System property {{Mono|org.basex.mode}} is set to {{Mono|client}}, a remote server instance same database will be addressed. Please have a look into the {{Mono|web.xml}} file for more optionsrejected or may even lead to corrupt databases.

Pressing {{Mono|Ctrl+c}} will close all connections and databases and shut down 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 server processGUI or a standalone instance at the same time. More details on concurrency can be found on the [[Transaction Management]] page.

===;Version 710.0===* Update: Switched to Java 11

;Version 9.0* UpdatedUpdate: the BaseXJAXRX has been replaced with BaseXHTTPSwitched to Java 8

[[Category;Version 7.0* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP