Startup

From BaseX Documentation
Revision as of 00:11, 13 January 2011 by CG (talk | contribs)
Jump to navigation Jump to search

Requirements

Java

A Runtime Environment of Java 1.6 (JRE) is needed to run BaseX. BaseX is platform-independent and should run on any platform that has a Java Virtual Machine available. BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux(SuSE xxx, Debian) and OpenBSD (4.x).

BaseX

Download the latest BaseX version for your operating system here. Run the Windows installer, or download the BaseX.zip archive to get all project components, including the start scripts. If you do not use the Windows installer, we recommend to add the bin directory, which contains all the start scripts, to your path environment; this way, you can run BaseX from every folder in the shell/terminal.

Starting the BaseX GUI

There are several methods for starting the GUI:

  • Double click on BaseX.jar
  • Execute the command: java -cp BaseX.jar org.basex.BaseXGUI
  • Start the script basexgui / basexgui.bat

Note: The BaseX GUI is just working on local databases. While you can always access local database from a BaseX server instance, you should avoid accessing databases concurrently with the GUI and the Server, esp. if updates are performed.

Starting the BaseX Server

There are several methods for starting the Server (get more information here):

  • Execute the command: java -cp BaseX.jar org.basex.BaseXServer
  • Start the script basexserver / basexserver.bat

Note: 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.

Starting the BaseX Client

There are several methods for starting the server-based Client (get more information here):

  • Execute the command: java -cp BaseX.jar org.basex.BaseXClient
  • Start the script basexclient / basexclient.bat

A default admin user can be used to connect:

  • Username: admin
  • Password: admin

The password can be changed using the PASSWORD command.

See also the Server Tutorial section for more details.

Starting the BaseX Standalone Client

There are several methods for starting the Standalone mode (get more information here):

  • Execute the command: java -cp BaseX.jar org.basex.BaseX
  • Start the script basex / basex.bat

See also

Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started