Startup
Contents
Requirements
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
Please download the latest BaseX version from our homepage.
The official releases include the BaseX runnable, Start Scripts, and API files.
If you do not use the Windows installer, or use another operating system, we recommend
to 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.
BaseX GUI
There are several ways of starting the GUI (get more information here):
- Double click on the BaseX GUI icon or the
BaseX.jar
file - Run one of the
basexgui
/basexgui.bat
scripts - Execute the command:
java -cp BaseX.jar org.basex.BaseXGUI
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 Server
There are several ways of starting the server (get more information here):
- Double click on the BaseX Server (Start) icon. This will also start the JAX-RX server.
- Run one of the
basexserver
/basexserver.bat
scripts - Execute the command
java -cp BaseX.jar org.basex.BaseXServer
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
There are several ways of starting the client version (get more information here):
- Double click on the BaseX Client icon
- Run one of the
basexclient
/basexclient.bat
scripts - Execute the command
java -cp BaseX.jar org.basex.BaseXClient
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.
Check out the Server Tutorial section for more details.
BaseX Standalone
There are several ways of starting the standalone version (get more information here):
- Double click on the BaseX icon
- Run one of the
basex
/basex.bat
scripts - Execute the command
java -cp BaseX.jar org.basex.BaseX
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 JAX-RX Server
Deprecated from Version 6.8: The JAX-RX (REST) server can be started as follows (get more information here):
- Double click on the BaseX Server (Start) icon
- Run one of the
basexjaxrx
/basexjaxrx.bat
scripts
BaseX HTTP Server
Introduced with Version 6.8: The HTTP server can be started as follows (get more information here):
- Double click on the BaseX Server (Start) icon
- Run one of the
basexhttp
/basexhttp.bat
scripts
See also
Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started