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.
REM Run BaseXjava -cp "%BXPATH%" %VM% org.==Linux/Mac: {{Code|basex.BaseXServer %*}}==
@endlocal<syntaxhighlight lang="bash"><#!/usr/bin/pre>env bash
<pre class# Core and library classesCP="brush$MAIN/BaseX.jar:$MAIN/lib/*:bash">#!$MAIN/lib/bincustom/bash*:$CLASSPATH
# Options for virtual machineVM=-Xmx1gGUI, Server, Client=
# Run If you would like to launch the GUI, Server or Client version of BaseXjava -cp "$BXPATH" $VM , please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer "$@"</precode>or <code>BaseXClient</code>.
===Windows=: {{Code|basexhttp.bat}}==
REM # Path to this scriptset PWDFILE=%~dp0"${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 )"
REM Paths to distributed files or source directories# API, core, and library classesset BXPATHCP=basex$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH
REM # Options for virtual machine(can be extended by global options)set VMBASEX_JVM="-Xmx1gXmx2g $BASEX_JVM"
REM # Run BaseXcodejava -cp "%BXPATH%$CP" %VM% $BASEX_JVM org.basex.BaseXGUI %*BaseXHTTP "$@"</syntaxhighlight>
@endlocal</pre>=Included Start Scripts=
===Others===The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts:
The For the BaseX Standalone an be started with the following HTTP and database server, there are also stop scriptsavailable:
<pre class="brush:bash">@setlocal@echo offChangelog=
REM Path to this scriptset PWD=%~dp0;Version 7.5
REM Paths to distributed files or source directoriesset BXPATH=basex* Updated: Static dependencies removed from Windows batch scripts.jar
REM Options for virtual machineset VM=-Xmx1g;Version 7.2
REM Run BaseXjava -cp "%BXPATH%" %VM% * Updated: The {{Code|BaseXHTTP}} start class moved from {{Code|org.basex.api}} to {{Code|org.basex}}.BaseX %*
@endlocal</pre>;Version 7.0
===Others===* Updated: The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
===Windows==Standalone=
The following scripts launch the standalone version of BaseX: ==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">@setlocal
@echo off
setLocal EnableDelayedExpansion
REM Path to this scriptcore and library classesset PWDMAIN=%~dp0/..set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
REM Paths to distributed files or source directoriesOptions for virtual machineset BXPATHBASEX_JVM=basex.jar-Xmx1200m %BASEX_JVM%
REM Options for virtual machineRun codeset VM=java -Xmx1gcp "%CP%" %BASEX_JVM% org.basex.BaseX %*</syntaxhighlight>
# 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 )"
# Path to this scriptOptions for virtual machine (can be extended by global options)PWDBASEX_JVM=`dirname "-Xmx2g $0`BASEX_JVM"
# Paths to distributed files or source directoriesRun codeBXPATH=java -cp "$CP" $BASEX_JVM org.basex.jarBaseX "$@"#BXPATH=$PWD/../target</classessyntaxhighlight>
==BaseX GUI=HTTP Server=
The BaseX GUI an scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be started with the following scriptsfound below:
<pre classsyntaxhighlight lang="brush:bashbatch">@setlocal
@echo off
setLocal EnableDelayedExpansion
REM Path to core and library classes
set MAIN=%~dp0/..
set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
REM Options for virtual machine
set BASEX_JVM=-Xmx1200m %BASEX_JVM%
REM Run code
java -cp "%CP%" %BASEX_JVM% org.basex.BaseXHTTP %*
</syntaxhighlight>
==Linux/Mac: {{Code|basexhttp}}==
<syntaxhighlight lang="bash">
#!/usr/bin/env bash
{| 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 Standaloneclient.|- 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.|}
{| class="wikitable"|- valign="top"! Windows! Linux/Mac! width=Windows"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.|}
