Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
Line 44: Line 44:
 
<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
 
from the standalone client and the server, esp. if updates are performed.
 
from the standalone client and the server, esp. if updates are performed.
 +
 +
==BaseX REST Server==
 +
There are several ways of starting the REST server (get more information [[Startup Advanced#BaseX REST Server|here]]):
 +
 +
*Double click on the '''BaseX REST''' icon
 +
*Run one of the <code>basexrest</code>/<code>basexrest.bat</code> scripts
  
 
==BaseX GUI==
 
==BaseX GUI==
Line 54: Line 60:
 
<b>Important</b>: The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same database
 
<b>Important</b>: 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 REST Server==
 
There are several ways of starting the REST server (get more information [[Startup Advanced#BaseX REST Server|here]]):
 
 
*Double click on the '''BaseX REST''' icon
 
*Run one of the <code>basexrest</code>/<code>basexrest.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 23:28, 23 January 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, 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 Server

There are several ways of starting the server (get more information here):

  • Double click on the BaseX Server icon
  • Run one of the basexserver/basexserver.bat scripts
  • Execute the command java -cp BaseX.jar org.basex.BaseXServer

Important: For concurrently accessing the databases (especially for write transactions), you have to use the BaseX Server. Please don't use any other BaseX mode with the databases from the BaseX Server while the server is working.

BaseX Client

There are several ways of starting the client communicating with the server (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 REST Server

There are several ways of starting the REST server (get more information here):

  • Double click on the BaseX REST icon
  • Run one of the basexrest/basexrest.bat scripts

BaseX GUI

There are several ways of starting the GUI:

  • 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.

See also

Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started