Startup
This article is part of the Getting Started Guide. It tells you how to get BaseX running.
Contents
Requirements
BaseX
Please download the latest BaseX version from our homepage.
The official releases include the BaseX JAR file, libraries and optional Start Scripts.
If you do not use the Windows version, we recommend to manually add the project’s
bin
directory to your path environment; this way, you will be able to run
BaseX from everywhere in your shell/terminal.
Java
A Runtime Environment of 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 BaseX GUI is the visual interface to the features of BaseX. It can be used to create new databases, perform queries or interactively explore your XML data.
The GUI can be started as follows (get more information here):
- Double click on the
BaseX.jar
file. - Run one of the
basexgui
/basexgui.bat
scripts. - Execute the command:
java -cp BaseX.jar org.basex.BaseXGUI
. - On Windows: Double click on the BaseX GUI start icon.
Important: The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same database from the GUI and the server, esp. if updates are performed.
BaseX Standalone
The BaseX Standalone interface can be used to enter database commands, or execute automated database operations and queries, on command line.
The standalone version can be started as follows (get more information here):
- Run one of the
basex
/basex.bat
scripts - Execute the command
java -cp BaseX.jar org.basex.BaseX
- On Windows: Double click on the BaseX start icon
Important: The Standalone client is not synchronized with other BaseX instances. You should avoid accessing the same database from the standalone client and the server, esp. if updates are performed.
BaseX Server
The BaseX Server comes into play if BaseX is to be used by more than one user (client). It handles concurrent read and write operations, provides User Management and logs user actions.
By default, the server listens to the port 1984
.
There are several ways of starting the server
(get more information here):
- Run one of the
basexserver
/basexserver.bat
scripts. - Execute the command
java -cp BaseX.jar org.basex.BaseXServer
. - On Windows: Double click on the BaseX Server (Start) start icon. This will also start the JAX-RX (HTTP) server.
Important: If you concurrently access the databases (especially for write transactions), the BaseX Server is the way to go. Don't use any other standalone/GUI BaseX instances to access databases which are also opened by the server.
BaseX Client
The BaseX Client interface can be used to send commands and queries to the server instance.
The client version can be started as follows (get more information here):
- Run one of the
basexclient
/basexclient.bat
scripts - Execute the command
java -cp BaseX.jar org.basex.BaseXClient
- On Windows: Double click on the BaseX Client start icon
The default admin
user can be used to connect to the server:
- Username:
admin
- Password:
admin
The password should be changed with the PASSWORD
command after the first login.
Please check out our little Server Tutorial for more details.
BaseX HTTP Server
Introduced with Version 6.8:
The HTTP server is required to activate the REST and WebDAV services of BaseX.
It starts an instance of the Jetty WebServer that listens
to the default port 8984
.
The HTTP server can be started as follows (get more information here):
- Run one of the
basexhttp
/basexhttp.bat
scripts - On Windows: Double click on the BaseX Server (Start) start icon
BaseX JAX-RX Server
Deprecated from Version 6.8: The JAX-RX (REST) server can be started as follows (get more information here):
- Run one of the
basexjaxrx
/basexjaxrx.bat
scripts - On Windows: Double click on the BaseX Server (Start) start icon
See also
Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started