Difference between revisions of "Startup"
Line 16: | Line 16: | ||
There are several ways of starting the GUI (get more information [[Startup Options#BaseX GUI|here]]): | There are several ways of starting the GUI (get more information [[Startup Options#BaseX GUI|here]]): | ||
− | *Double click on | + | * Double click on the <code>BaseX.jar</code> file. |
− | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts | + | * Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts. |
− | *Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code> | + | * Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>. |
+ | * On ''Windows'': Double click on the '''BaseX GUI''' icon. | ||
'''Important''': The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same database | '''Important''': The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same database | ||
Line 26: | Line 27: | ||
There are several ways of starting the server (get more information [[Startup Options#BaseX Server|here]]): | There are several ways of starting the server (get more information [[Startup Options#BaseX Server|here]]): | ||
− | *Double click on the '''BaseX | + | * On ''Windows'': Double click on the '''BaseX GUI''' icon. This will also start the JAX-RX server. |
− | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts | + | * Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts. |
− | *Execute the command <code>java -cp BaseX.jar org.basex.BaseXServer</code> | + | * Execute the command <code>java -cp BaseX.jar org.basex.BaseXServer</code>. |
'''Important''': If you concurrently access the databases (especially for write transactions), | '''Important''': If you concurrently access the databases (especially for write transactions), | ||
Line 37: | Line 38: | ||
There are several ways of starting the client version (get more information [[Startup Options#BaseX Client|here]]): | There are several ways of starting the client version (get more information [[Startup Options#BaseX Client|here]]): | ||
− | |||
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexclient.bat]]</code> scripts | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexclient.bat]]</code> scripts | ||
*Execute the command <code>java -cp BaseX.jar org.basex.BaseXClient</code> | *Execute the command <code>java -cp BaseX.jar org.basex.BaseXClient</code> | ||
+ | * On ''Windows'': Double click on the '''BaseX Client''' icon | ||
The default <code>admin</code> user can be used to connect to the server: <br/> | The default <code>admin</code> user can be used to connect to the server: <br/> | ||
Line 52: | Line 53: | ||
There are several ways of starting the standalone version (get more information [[Startup Options#BaseX Standalone|here]]): | There are several ways of starting the standalone version (get more information [[Startup Options#BaseX Standalone|here]]): | ||
− | |||
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basex]]</code>/<code>[[Start Scripts#Windows: basex.bat|basex.bat]]</code> scripts | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basex]]</code>/<code>[[Start Scripts#Windows: basex.bat|basex.bat]]</code> scripts | ||
*Execute the command <code>java -cp BaseX.jar org.basex.BaseX</code> | *Execute the command <code>java -cp BaseX.jar org.basex.BaseX</code> | ||
+ | * On ''Windows'': Double click on the '''BaseX''' icon | ||
<b>Important</b>: The Standalone client is not synchronized with other BaseX instances. You should avoid accessing the same database | <b>Important</b>: The Standalone client is not synchronized with other BaseX instances. You should avoid accessing the same database | ||
Line 64: | Line 65: | ||
The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]]): | The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]]): | ||
− | + | * Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx.bat]]</code> scripts | |
− | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx.bat]]</code> scripts | + | * On ''Windows'': Double click on the '''BaseX Server (Start)''' icon |
==BaseX HTTP Server== | ==BaseX HTTP Server== | ||
Line 72: | Line 73: | ||
The HTTP server can be started as follows (get more information [[Startup Options#BaseX HTTP Server|here]]): | The HTTP server can be started as follows (get more information [[Startup Options#BaseX HTTP Server|here]]): | ||
− | + | * Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts | |
− | *Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts | + | * On ''Windows'': Double click on the '''BaseX Server (Start)''' icon |
==See also == | ==See also == | ||
[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]] | [[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]] | ||
[[Category:Beginner]] | [[Category:Beginner]] |
Revision as of 10:47, 17 September 2011
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.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 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 Server
There are several ways of starting the server (get more information here):
- On Windows: Double click on the BaseX GUI 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):
- 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 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 Standalone
There are several ways of starting the standalone version (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 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 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) icon
BaseX HTTP Server
Introduced with Version 6.8: 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) icon
See also
Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started