Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
Line 17: Line 17:
  
 
*Double click on the '''BaseX GUI''' icon or the <code>BaseX.jar</code> file
 
*Double click on the '''BaseX GUI''' icon or the <code>BaseX.jar</code> file
−
*Run one of the <code>basexgui</code>/<code>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>
  
−
<b>Important</b>: 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.
  
Line 27: Line 27:
  
 
*Double click on the '''BaseX Server (Start)''' icon. This will also start the JAX-RX server.
 
*Double click on the '''BaseX Server (Start)''' icon. This will also start the JAX-RX server.
−
*Run one of the <code>basexserver</code>/<code>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>
  
−
<b>Important</b>: For concurrently accessing the databases (especially for write transactions),
+
'''Important''': If you concurrently access the databases (especially for write transactions),
−
you have to use the BaseX Server. Please don't use any other BaseX mode with the databases
+
the BaseX Server is the way to go. Don't use any other standalone/GUI BaseX instances
−
from the BaseX Server while the server is working.
+
to access databases which are also opened by the server.
  
 
==BaseX Client==
 
==BaseX Client==
−
There are several ways of starting the client communicating with the server (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]]):
  
 
*Double click on the '''BaseX Client''' icon
 
*Double click on the '''BaseX Client''' icon
−
*Run one of the <code>basexclient</code>/<code>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>
  
Line 53: Line 53:
  
 
*Double click on the '''BaseX''' icon
 
*Double click on the '''BaseX''' icon
−
*Run one of the <code>basex</code>/<code>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>
  
Line 65: Line 65:
  
 
*Double click on the '''BaseX Server (Start)''' icon
 
*Double click on the '''BaseX Server (Start)''' icon
−
*Run one of the <code>basexjaxrx</code>/<code>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
  
 
==BaseX HTTP Server==
 
==BaseX HTTP Server==
Line 73: Line 73:
  
 
*Double click on the '''BaseX Server (Start)''' icon
 
*Double click on the '''BaseX Server (Start)''' icon
−
*Run one of the <code>basexhttp</code>/<code>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
  
 
==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 11:51, 13 September 2011

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):

BaseX HTTP Server

Introduced with Version 6.8: The HTTP server can be started as follows (get more information here):

See also

Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started

Retrieved from "http://docs.basex.org/index.php?title=Startup&oldid=4297"