Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
<code>{{Mono|bin</code> }} directory to your path environment; this way, you will be able to run
<font color='orangered'>{{Mark|Introduced with {{Version|7.0}}</font>:<br/>
no edit summary
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
BaseX from everywhere in your shell/terminal.
The GUI can be started as follows (get more information on all [[Startup Options#BaseX GUI|Startup Options]]):
* Double click on the <code>{{Mono|BaseX.jar</code> }} file.* Run one of the <code>{{Mono|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]<}}/code>/<code>{{Mono|[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> }} scripts.* Execute the command: <code>{{Mono|java -cp BaseX.jar org.basex.BaseXGUI</code>}}.
* On ''Windows'': Double click on the '''BaseX GUI''' start icon.
* For [[Maven]] users: type in <code>{{Mono|mvn exec:java</code> }} in the main directory of the <code>{{Mono|basex</code> }} project.
==BaseX Standalone==
(get more information on all [[Startup Options#BaseX Standalone|Startup Options]]):
*Run one of the <code>{{Mono|[[Start_Scripts#Linux.2FMac:_basex|basex]]<}}/code>/<code>{{Mono|[[Start Scripts#Windows: basex.bat|basex.bat]]</code> }} scripts*Execute the command <code>{{Mono|java -cp BaseX.jar org.basex.BaseX</code>}}
* On ''Windows'': Double click on the '''BaseX''' start icon
provides [[User Management|user management]] and [[Logging|logs all user interactions]].
By default, the server listens to the port <code>{{Mono|1984</code>}}.
There are several ways of starting the server
(get more information on all [[Startup Options#BaseX Server|Startup Options]]):
* Run one of the <code>{{Mono|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]<}}/code>/<code>{{Mono|[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> }} scripts.* Execute the command <code>{{Mono|java -cp BaseX.jar org.basex.BaseXServer</code>}}.
* On ''Windows'': Double click on the '''BaseX Server''' start icon. This will also start the [[#BaseX HTTP Server|HTTP Server]].
Pressing <code>{{Mono|Ctrl+c</code> }} will close all connections and databases and shut down the server process.
==BaseX Client==
(get more information on all [[Startup Options#BaseX Client|Startup Options]]):
*Run one of the <code>{{Mono|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]<}}/code>/<code>{{Mono|[[Start Scripts#Windows: basex.bat|basexclient.bat]]</code> }} scripts*Execute the command <code>{{Mono|java -cp BaseX.jar org.basex.BaseXClient</code>}}
* On ''Windows'': Double click on the '''BaseX Client''' start icon
The default <code>{{Mono|admin</code> }} user can be used to connect to the server: <br/>* <b>Username:</b> <code>{{Mono|admin</code>}}* <b>Password:</b> <code>{{Mono|admin</code>}}The password should be changed with the <code>{{Mono|[[Commands#PASSWORD|PASSWORD]]</code> }} command after the first login.<br/>
Please check out our little [[Server Tutorial]] for more details.
==BaseX HTTP Server==
The HTTP server is required to activate the [[REST]] and [[WebDAV]] services of BaseX.
It starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty WebServer],
which listens to the port <code>{{Mono|8984</code> }} by default, and the BaseX Server,which listens to <code>{{Mono|1984</code>}}.
The HTTP Server can be started as follows
(get more information on all [[Startup Options#BaseX HTTP Server|Startup Options]]):
* Run one of the <code>{{Mono|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]<}}/code>/<code>{{Mono|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> }} scripts
* On ''Windows'': Double click on the '''BaseX Server''' start icon
* For [[Maven]] users: type in <code>{{Mono|mvn jetty:run</code> }} in the main directory of the <code>{{Mono|basex-api</code> }} project. The BaseX server needs to be manually started if the <code>{{Mono|org.basex.local</code> }} property is set to <code>{{Mono|false</code> }} (this is the default). Please have a look into the <code>{{Mono|pom.xml</code> }} file of the <code>{{Mono|basex-api</code> }} project for more options.
Pressing <code>{{Mono|Ctrl+c</code> }} will close all connections and databases and shut down the server process.
==See also ==
[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]]
[[Category:Beginner]]
