Changes

* If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server(Start)''' icon.

The command-line output will look something like that (the JSP warning message Both an instance of [httphttps://stackoverflowwww.comeclipse.org/questionsjetty/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can Jetty] and BaseX [[Database Server]] will be ignoredstarted. By default, Jetty listens to the port 8080, and the [[Database Server|BaseX Database Server])] is accessible on port 1984. After startup, you can access a plain HTML welcome page via http://localhost:8080.

Unless you have already chosen an admin password yet (e.g., via the Windows installer or a previous installation), you can do so by invoking the {{Command|PASSWORD}} command on your terminal: <pre class="brush:xml">basexhttp -c PASSWORD

Server was started (port: 1984)[main] INFO org.eclipse.jetty.util.log - Logging initialized @239ms to org.eclipse.jetty.util.log.Slf4jLog...HTTP STOP Server was started (port: 808081).HTTP STOP Server was started (port: 89858080).Password: _

You can adjust the The Jetty logging level can be adjusted by adding the following properties to the start script:

<pre classlang="brush:xml">

After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984. 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).

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:89848080/basex/rest).

If you use Jetty (which is the default HTTP server of BaseX), the server configuration is available via defined in 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/.

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-directorysubdirectory. 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.

{| class="wikitable"

The [[DBA]] is a web-based database administration interface written in RESTXQ. It allows you to create and administrate databases, evaluate queries in realtime, view log files, manage users, etc. It is embedded in the full distributions of BaseX, and it can be accessed after startup via http://localhost:8080/dba/.

Initial Further database options can be specified defined as context parameters in the {{Code|web.xml}} file. They need to be defined as context parameters and prefixed with {{Code|org.basex.}}. The most important options for the web application context are as follows:

|-valign="top"

|-valign="top"

|-valign="top"

|-valign="top"

|-valign="top"

|-valign="top"

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 classlang="brush:xml">

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 {{Code|basex-api }} package.

Different No credentials can need to be supplied if a default user is assigned to a service by specifying local init parametersin the {{Code|web.xml}} file. In the following example, an alternative the user {{Code|rest-user }} is specified for the REST service:

<pre classlang="brush:xml">

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)chosen authentication method in the configuration.

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:

: <code>http://admin:admin...@localhost:89848080/</code>

* Updated: Authentication readded re-added to RESTXQ.