Difference between revisions of "Startup"
Line 2: | Line 2: | ||
===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 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 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=== | ===BaseX=== | ||
− | + | Please download the latest BaseX version [http://basex.org/download from our homepage]. | |
− | + | All official releases include the BaseX runnable, [[Start Scripts]], and API files. If you do not use the Windows installer, we recommend to add the <code>bin</code> directory, which contains all the start scripts, to your path environment; this way, you can run BaseX from every folder in the shell/terminal. | |
==BaseX GUI== | ==BaseX GUI== | ||
+ | There are several ways of starting the GUI: | ||
− | + | *Double click on the '''BaseX''' icon, or <code>BaseX.jar</code> | |
− | + | *Start the script <code>basexgui</code>/<code>basexgui.bat</code> | |
− | *Double click on the BaseX icon, or <code>BaseX.jar</code> | ||
*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>Note</b>: The BaseX GUI is just working on local databases. While you can always access | <b>Note</b>: The BaseX GUI is just working on local databases. While you can always access | ||
Line 24: | Line 22: | ||
==BaseX Server== | ==BaseX Server== | ||
− | There are several | + | There are several ways of starting the server (get more information [[Startup Advanced|here]]): |
+ | *Click on the '''BaseX Server''' icon | ||
+ | *Start one of the <code>basexserver</code>/<code>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>Note</b>: For concurrently accessing the databases (especially for write transactions), | <b>Note</b>: For concurrently accessing the databases (especially for write transactions), | ||
Line 35: | Line 34: | ||
==BaseX Client== | ==BaseX Client== | ||
− | There are several | + | There are several ways of starting the client communicating with the server (get more information [[Startup Advanced|here]]): |
+ | *Click on the '''BaseX Client''' icon | ||
+ | *Start one of the <code>basexclient</code>/<code>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> | ||
− | |||
A default admin user can be used to connect: <br/> | A default admin user can be used to connect: <br/> | ||
Line 49: | Line 49: | ||
==BaseX Standalone== | ==BaseX Standalone== | ||
− | There are several | + | There are several ways of starting the standalone client (get more information [[Startup Advanced|here]]): |
+ | *Click on the '''BaseX Standalone''' icon | ||
+ | *Start one of the <code>basex</code>/<code>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> | ||
− | |||
==See also == | ==See also == |
Revision as of 13:31, 17 January 2011
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
Please download the latest BaseX version from our homepage.
All official releases include the BaseX runnable, Start Scripts, and API files. 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.
BaseX GUI
There are several ways of starting the GUI:
- Double click on the BaseX icon, or
BaseX.jar
- Start the script
basexgui
/basexgui.bat
- Execute the command:
java -cp BaseX.jar org.basex.BaseXGUI
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.
BaseX Server
There are several ways of starting the server (get more information here):
- Click on the BaseX Server icon
- Start one of the
basexserver
/basexserver.bat
scripts - Execute the command:
java -cp BaseX.jar org.basex.BaseXServer
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.
BaseX Client
There are several ways of starting the client communicating with the server (get more information here):
- Click on the BaseX Client icon
- Start one of the
basexclient
/basexclient.bat
scripts - Execute the command:
java -cp BaseX.jar org.basex.BaseXClient
A default admin user can be used to connect:
- Username:
admin
- Password:
admin
The password can be changed using the PASSWORD
command.
Check out the Server Tutorial section for more details.
BaseX Standalone
There are several ways of starting the standalone client (get more information here):
- Click on the BaseX Standalone icon
- Start one of the
basex
/basex.bat
scripts - Execute the command:
java -cp BaseX.jar org.basex.BaseX
See also
Server Tutorial, GUI Tutorial, Standalone Tutorial, Getting Started