Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
 
==Requirements==
 
==Requirements==
 +
 +
===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]].
 +
If you do not use the Windows version, we recommend to manually add the project’s
 +
<code>bin</code> directory to your path environment; this way, you will be able to run
 +
BaseX from everywhere in your shell/terminal.
  
 
===Java===
 
===Java===
 
A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.
 
A Runtime Environment of [http://www.java.com 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 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===
+
==BaseX GUI==
 
+
The [[GUI_Tutorial|BaseX GUI] is the visual interface to the features of BaseX.
Please [http://basex.org/download download] the latest BaseX version from our homepage.
+
It can be used to create new databases, perform queries or interactively
The official releases include the BaseX runnable, [[Start Scripts]], and API files.
+
explore your XML data.
If you do not use the Windows installer, or use another operating system, we recommend
 
to add the project’s <code>bin</code> directory to your path environment; this way,
 
you will be able to run BaseX from everywhere in your shell/terminal.
 
  
==BaseX GUI==
+
The GUI can be started as follows (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 the <code>BaseX.jar</code> file.
 
* 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.
+
* 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
 
'''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.
 
from the GUI and the server, esp. if updates are performed.
 +
 +
==BaseX Standalone==
 +
The [[Standalone_Tutorial|BaseX Standalone] interface can be used
 +
to enter database commands, or execute automated database and query
 +
operations, on command line.
 +
 +
The standalone version can be started as follows (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
 +
*Execute the command <code>java -cp BaseX.jar org.basex.BaseX</code>
 +
* On ''Windows'': Double click on the '''BaseX''' start icon
 +
 +
<b>Important</b>: 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==
 
==BaseX Server==
 +
The [[Server_Tutorial|BaseX Server]] is needed to handle the request of
 +
multiple users (clients). It manages concurrent read and write operations,
 +
user permissions and access logs.
 +
 
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]]):
  
 
* 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>.
* On ''Windows'': Double click on the '''BaseX Server (Start)''' icon. This will also start the JAX-RX server.
+
* 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),
 
'''Important''': If you concurrently access the databases (especially for write transactions),
Line 36: Line 60:
  
 
==BaseX Client==
 
==BaseX Client==
There are several ways of starting the client version (get more information [[Startup Options#BaseX Client|here]]):
+
The [[Server_Tutorial|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 [[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
+
* On ''Windows'': Double click on the '''BaseX Client''' start 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 48: Line 76:
  
 
Please check out our little [[Server Tutorial]] for more details.
 
Please check out our little [[Server Tutorial]] for more details.
 
==BaseX Standalone==
 
 
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
 
*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
 
from the standalone client and the server, esp. if updates are performed.
 
  
 
==BaseX JAX-RX Server==
 
==BaseX JAX-RX Server==
Line 66: Line 83:
  
 
* 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
+
* On ''Windows'': Double click on the '''BaseX Server (Start)''' start icon
  
 
==BaseX HTTP Server==
 
==BaseX HTTP Server==
Line 74: Line 91:
  
 
* 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
+
* On ''Windows'': Double click on the '''BaseX Server (Start)''' 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:18, 17 September 2011

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 [[GUI_Tutorial|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 [[Standalone_Tutorial|BaseX Standalone] interface can be used to enter database commands, or execute automated database and query operations, 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 is needed to handle the request of multiple users (clients). It manages concurrent read and write operations, user permissions and access logs.

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 JAX-RX Server

Deprecated from Version 6.8: The JAX-RX (REST) server can be started as follows (get more information here):

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) start icon

See also

Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started