Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
The starting script files are available for every Each BaseX [[Startup]] mode can be launched with its own Start Script which can in turn be used with its own range of [[Command-Line Options]]. The BaseX and can be started on every operating system[https://basex.<br org/>Note: Probably you have to modify the pathes in the scriptdownload/ Windows and ZIP distributions] readily include all Start Scripts.
==* We recommend you to manually add the {{Code|bin}} directory of your BaseX Server==directory to the [https://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your environment.* You can copy the start scripts to another location in your file system. After that, you should edit the scripts and assign the BaseX directory to the {{Code|MAIN}} variable.* The Windows installer automatically adds the project’s {{Code|bin}} directory to your path environment.* If you work with [[Maven]], you can directly run the scripts in the [https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://github.com/BaseXdb/basex/tree/master/basex-api/etc basex-api/etc] sub-directories of the project.
The If BaseX Server terminates with an be started with {{Code|Out of Memory}} or {{Code|Java heap space}} error, you can assign more RAM via the following scripts:{{Code|-Xmx}} flag (see below). The conservative value that was chosen in our distributions ensures that BaseX will also run on 32 bit JVMs.
===Others===The following scripts launch the standalone version of BaseX:
The BaseX GUI an be started with the following scripts:<syntaxhighlight lang="batch">@echo offsetLocal EnableDelayedExpansion
==REM Run codejava -cp "%CP%" %BASEX_JVM% org.basex.BaseX Standalone==%*</syntaxhighlight>
The BaseX Standalone an be started with the following scripts==Linux/Mac:{{Code|basex}}==
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
===Windows==Standalone=
==BaseX GUIWindows: {{Code|basex.bat}}==
REM Path to core and library classesset MAIN=%~dp0/..set CP==Windows===%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
REM Options for virtual machineset BASEX_JVM===Others===-Xmx1200m %BASEX_JVM%
<syntaxhighlight lang===Windows==="bash">#!/usr/bin/env bash
# Path to this scriptFILE="${BASH_SOURCE[0]}"while [ -h "$FILE" ] ; do SRC="$(readlink "$FILE")" FILE=Others"$( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"doneMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )" # Core and library classesCP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH # Options for virtual machine (can be extended by global options)BASEX_JVM="-Xmx2g $BASEX_JVM" # Run codejava -cp "$CP" $BASEX_JVM org.basex.BaseX "$@"</syntaxhighlight> =GUI, Server, Client= If you would like to launch the GUI, Server or Client version of BaseX, please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer</code> or <code>BaseXClient</code>. =HTTP Server= The scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below: ==Windows: {{Code|basexhttp.bat}}== <syntaxhighlight lang="batch">@echo offsetLocal EnableDelayedExpansion REM Path to core and library classesset MAIN=%~dp0/..set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/* REM Options for virtual machineset BASEX_JVM=-Xmx1200m %BASEX_JVM% REM Run codejava -cp "%CP%" %BASEX_JVM% org.basex.BaseXHTTP %*</syntaxhighlight> ==Linux/Mac: {{Code|basexhttp}}== <syntaxhighlight lang="bash">#!/usr/bin/env bash # Path to this scriptFILE="${BASH_SOURCE[0]}"while [ -h "$FILE" ] ; do SRC="$(readlink "$FILE")" FILE="$( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"doneMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )" # API, core, and library classesCP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH # Options for virtual machine (can be extended by global options)BASEX_JVM="-Xmx2g $BASEX_JVM" # Run codejava -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"</syntaxhighlight> =Included Start Scripts= The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts: {| class="wikitable"|- valign="top"! Windows! Linux/Mac! Description|- valign="top"| {{Code|basex.bat}}| {{Code|basex}}| Launches the BaseX standalone mode.|- valign="top"| {{Code|basexclient.bat}}| {{Code|basexclient}}| Starts a BaseX client.|- valign="top"| {{Code|basexgui.bat}}| {{Code|basexgui}}| Starts the BaseX GUI.|- valign="top"| {{Code|basexhttp.bat}}| {{Code|basexhttp}}| Starts the BaseX HTTP Server.|- valign="top"| {{Code|basexserver.bat}}| {{Code|basexserver}}| Starts the BaseX database server.|} For the BaseX HTTP and database server, there are also stop scripts available: {| class="wikitable"|- valign="top"! Windows! Linux/Mac! width="40%" | Description|- valign="top"|- valign="top"| {{Code|basexhttpstop.bat}}| {{Code|basexhttpstop}}| Stops the BaseX HTTP Server.|- valign="top"| {{Code|basexserverstop.bat}}| {{Code|basexserverstop}}| Stops the BaseX database server.|} =Changelog= ;Version 7.5 * Updated: Static dependencies removed from Windows batch scripts. ;Version 7.2 * Updated: The {{Code|BaseXHTTP}} start class moved from {{Code|org.basex.api}} to {{Code|org.basex}}. ;Version 7.0 * Updated: The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.
