Changes

=Startup=

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

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:

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

-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG

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 purposes (e.g. if the default memory limit is too restrictive).

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

To run on [https://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==

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 [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html Maven Jetty Plugin] sesion in the {{Code|pom.xml}} file.

The following services are available and enabled by default:

|- valign="top"

! Name

{| class="wikitable"

! width="160" | Option

! width="90" |Default

! Description

|{{Option|USER}}

|{{Code|admin}}

| If a user is specified, no credentials must be passed on by the client.

|{{Option|HTTPLOCAL}}

|{{Code|false}}

|Operation mode. By default, a database server instance will be started, as soon as the first HTTP service is called. The database server can be disabled by setting this flag to {{Code|true}}.

|{{Option|RESTXQPATH}}

|{{Code|.}}

|Relative or absolute directory referencing the [[RESTXQ]] modules. By default, the option points to the standard web application directory.

|{{Option|RESTPATH}}

|{{Code|.}}

|Relative or absolute directory referencing queries and command-scripts that can be invoked via the [[REST#GET_Requests|run operation]] of REST. By default, the option points to the standard web application directory.

|{{Option|AUTHMETHOD}}

|{{Code|Basic}}

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’s ({{Code|webapp}}) path:

<context-param>

<param-name>org.basex.dbpath</param-name>

<param-value>f:/basex/repository</param-value>

</context-param>

To enable or disable a specific service, the corresponding servlet entry in the {{Code|web.xml}} file needs to be removed/commented.

No credentials need to be supplied if a default user is assigned to a service in the {{Code|web.xml}} file. In the following example, the user {{Code|rest-user}} is specified for the REST service:

<servlet>

<servlet-name>REST</servlet-name>

</init-param>

</servlet>

If the HTTP server is started with no pre-defined user, the credentials must be passed on by the client via [https://en.wikipedia.org/wiki/Basic_access_authentication Basic Authentication] or [https://en.wikipedia.org/wiki/Digest_authentication Digest Authentication], depending on the chosen authentication method in the configuration.

Users are specified in a {{Code|users.xml}} file, which is stored in the database directory (see [[User Management]] for more information).

;Version 8.6

* Updated: No password must be specified in the <code>web.xml</code> file anymore.

* Updated: Server-side user and authentication method is now enforced (cannot be overwritten by client).

;Version 7.3

* Updated: {{Code|client}} mode replaced with {{Code|server}} mode

;Version 7.2

* Web Application concept revised