Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
An instance of the [httpsAfter startup, you can access an HTML welcome page via http://www.eclipse.org/jetty/ Jetty Web Server] will be started, which by default listens to the port {{Code|localhost:8984}}. Additionally, the BaseX database server will be started, accessible on port {{Code|1984}}.
After startup, the HTML welcome page The Jetty logging level can be accessed via http://localhostadjusted by adding the following properties to the start script:8984.
You can adjust the Jetty logging level by adding the following properties to the start script: <pre classsyntaxhighlight lang="brush:xml">
Initial database options Unless BaseX is deployed as servlet, the location of the web application directory can be adjusted via the {{Option|WEBPATH}} option, and compression of HTTP responses can be specified in enabled via the {{CodeOption|web.xmlGZIP}} fileoption. They need to Further database options can be defined as context parameters and prefixed with in the {{Code|org.basexweb.xml}}file. The most important options for the web application context are as follows:
→Maven
* Run one of the {{Code|basexhttp}} or {{Code|basexhttp.bat}} scripts. Call the script with the {{Code|stop}} keyword to gracefully shut down the server.
* If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server(Start)''' icon.
Various [[Command-Line_Options#HTTP Server|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposed purposes (e.g. if the default memory limit is too restrictive).
An instance of the [https://www.eclipse.org/jetty/ Jetty Web Server] will be started, which by default listens to the port {{Code|8984}}. Additionally, the BaseX [[Database Server]] will be started, accessible on port {{Code|1984}}. The command-line output will look something like that (the JSP warning message [httphttps://stackoverflow.com/questions/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can be ignored]):
<pre classsyntaxhighlight lang="brush:xml">
BaseX [HTTP Server]
[main] INFO org.eclipse.jetty.util.log - Logging initialized @375ms to org.eclipse.jetty.util.log.Slf4jLog
HTTP Server was started (port: 8984).
HTTP STOP Server was started (port: 8985).
</presyntaxhighlight>
-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG
</presyntaxhighlight>
BaseX can also be deployed as web servlet in a servlet container or with Maven:
==Servlet Container==
In order to deploy BaseX HTTP Services in a servlet container, you can download the WAR distribution of BaseX from the [httphttps://basex.org/download download site], or compile it by calling <code>mvn compile war:war</code> in the <code>basex-api</code> directory. The WAR file can then be deployed following the instructions of the corresponding servlet container ([httphttps://www.eclipse.org/jetty/documentation/current/quickstart-deploying-webapps.html jettyJetty], [httphttps://tomcat.apache.org/tomcat-79.0-doc/deployer-howto.html tomcatTomcat], etc.).
You can configure the port, context path, etc. by following the instructions of the corresponding servlet container. This is needed if you want to replace the default URL path (e.g. http://localhost:8080/rest) with a custom one (e.g. http://localhost:8984/basex/rest).
If you use Jetty (which is the default HTTP server of BaseX), the server configuration is available via the {{Code|jetty.xml}} file, which is stored in the {{Code|WEB-INF}} directory next to the {{Code|web.xml}}. For detailed configuration , refer to the [httphttps://www.eclipse.org/jetty/documentation/current/jetty-xml-config.html Jetty Documentation].
To run on [httphttps://tomcat.apache.org/ Apache Tomcat], start the Tomcat server and add any <code>*.war</code> distribution to deploy via the Tomcat web interface. By default, the interface is accessible via http://localhost:8080/manager/html/.
==Maven==
Check out the BaseX sources via [[Developing with Eclipse|Eclipse]] or [[Git]]. Execute <code>mvn install</code> in the main project directory and then <code>mvn install jetty:run</code> in the <code>basex-api</code> sub-directory. This will start a Jetty instance in which the servlets will be deployed.
The same options as in the case of deployment apply in a servlet container. In this case, however, there is no WAR archive. Instead, Jetty looks up all files in the directory <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp basex-api/src/main/webapp]</code>. Jetty and servlet options can be configured in the {{Code|jetty.xml}} and {{Code|web.xml}} files as described above in the [[#Configuration|Servlet Container Configuration]]. The Jetty stop port can be changed in the [httphttps://docswww.codehauseclipse.org/displayjetty/JETTYdocumentation/Maven+Jetty+Plugin current/jetty-maven-plugin.html Maven Jetty Plugin] sesion in the {{Code|pom.xml}} file.
=Services=
=Configuration=
{| class="wikitable"
|}
All options are prefixed with {{Code|org.basex.}}. Local file paths in options may be absolute or relative. If a relative path is specified, its root will be the servlet servlet’s ({{Code|webapp}}) path:
<pre classsyntaxhighlight lang="brush:xml">
<context-param>
<param-name>org.basex.dbpath</param-name>
<param-value>f:/basex/repository</param-value>
</context-param>
</presyntaxhighlight>
Context parameters can be requested from XQuery via [[Process_Module#proc:property-names|proc:property-names]] and [[Process_Module#proc:property|proc:property]]. How to set these options is specific to the servlet container. For example, in Jetty it can be done by [http://www.eclipse.org/jetty/documentation/current/override-web-xml.html overriding the web.xml] file. Another option is to directly edit the {{Code|WEB-INF/web.xml}} file in the WAR archive (WAR files are simple ZIP files). Refer to the sample [https://github.com/BaseXdb/basex/blob/master/basex-api/src/main/webapp/WEB-INF/web.xml web.xml] of the basex-api package.
Different credentials can be assigned to a service by specifying local init parameters. In the following example, an alternative user is specified for the REST service:
<pre classsyntaxhighlight lang="brush:xml">
<servlet>
<servlet-name>REST</servlet-name>
</init-param>
</servlet>
</presyntaxhighlight>
If the HTTP server is started with no pre-defined user, the credentials must be passed on by the client via [httphttps://en.wikipedia.org/wiki/Basic_access_authentication Basic Authentication] or [httphttps://en.wikipedia.org/wiki/Digest_authentication Digest Authentication] (depending on the server setting).
With cURL, internet browsers, and other tools, you can specify basic authentication credentials within the request string as plain text, using the format <code>USER:PASSWORD@URL</code>. An example:
