Bureaucrats, editor, reviewer, Administrators
13,551
edits
Changes
Jump to navigation
Jump to search
m
Text replace - "{{Mono|" to "{{Code|"
The official releases include the BaseX JAR file, libraries and optional [[Start Scripts]].
If you do not use an installer, we recommend to manually add the project’s
{{MonoCode|bin}} directory to your path environment; this way, you will be able to run
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 {{MonoCode|BaseX.jar}} file.* Run one of the {{MonoCode|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} or {{MonoCode|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts.* Execute the following command: {{MonoCode|java -cp BaseX.jar org.basex.BaseXGUI}}
* On ''Windows'': Double click on the '''BaseX GUI''' icon.
* For [[Maven]] users: type in {{MonoCode|mvn exec:java}} in the main directory of the {{MonoCode|basex}} project.
==BaseX Standalone==
(get more information on all [[Startup Options#BaseX Standalone|Startup Options]]):
* Run one of the {{MonoCode|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{MonoCode|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute the following command: {{MonoCode|java -cp BaseX.jar org.basex.BaseX}}
* On ''Windows'': Double click on the '''BaseX''' icon.
provides [[User Management|user management]] and [[Logging|logs all user interactions]].
By default, the server listens to the port {{MonoCode|1984}}.
There are several ways of starting and stopping the server
(get more information on all [[Startup Options#BaseX Server|Startup Options]]):
* Run one of the {{MonoCode|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]}} or {{MonoCode|[[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts. Add the {{MonoCode|stop}} keyword to gracefully shut down the server.* Execute the following command: {{MonoCode|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{MonoCode|stop}} keyword will ensure a graceful shutdown.
* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon.
Pressing {{MonoCode|Ctrl+c}} 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 {{MonoCode|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{MonoCode|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.* Execute the following command: {{MonoCode|java -cp BaseX.jar org.basex.BaseXClient}}
* On ''Windows'': Double click on the '''BaseX Client''' icon.
The default {{MonoCode|admin}} user can be used to connect to the server: <br/>* <b>Username:</b> {{MonoCode|admin}}* <b>Password:</b> {{MonoCode|admin}}The password should be changed with the {{MonoCode|[[Commands#PASSWORD|PASSWORD]]}} command after the first login.<br/>
Please check out the article on the [[Database Server]] for more details.
The HTTP Server gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX.
By default, it starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server],
which listens to the port {{MonoCode|8984}}, and the BaseX Server, which listens to {{MonoCode|1984}}.
The HTTP Server can be started as follows
(get more information on all [[Startup Options#BaseX HTTP Server|Startup Options]]):
* Run one of the {{MonoCode|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{MonoCode|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Add the {{MonoCode|stop}} keyword to gracefully shut down the server.
* On ''Windows'': Double click on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.
* For [[Maven]] users: type in {{MonoCode|mvn jetty:run}} in the main directory of the {{MonoCode|basex-api}} project, and press {{MonoCode|Ctrl+c}} to shut down the process.
* You may also want to deploy BaseX as a [[Web Application]].
