Web Application - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:10Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:33:30Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG at 10:27, 26 October 2023

2023-10-26T10:27:42Z

CG: /* Servlet Container */

2023-09-17T12:21:43Z

Servlet Container

CG at 12:19, 17 September 2023

2023-09-17T12:19:04Z

CG: /* Authentication */

2022-07-25T14:10:31Z

Authentication

CG at 14:10, 25 July 2022

2022-07-25T14:10:04Z

CG: Text replacement - "ub-director" to "ubdirector"

2022-07-25T13:59:16Z

Text replacement - "ub-director" to "ubdirector"

CG: /* Startup */

2022-07-25T13:01:36Z

Startup

CG at 12:52, 25 July 2022

2022-07-25T12:52:11Z

@@ Line 23: / Line 23: @@
 The Jetty logging level can be adjusted by adding the following properties to the start script:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 -Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG
 </pre>
@@ Line 115: / Line 115: @@
 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:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <context-param>
    <param-name>org.basex.dbpath</param-name>
@@ Line 136: / Line 136: @@
 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:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <servlet>
    <servlet-name>REST</servlet-name>

@@ Line 25: / Line 25: @@
 <syntaxhighlight lang="xml">
 -Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG
-</syntaxhighlight>
+</pre>
 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).
@@ Line 126: / Line 126: @@
    <param-value>f:/basex/repository</param-value>
 </context-param>
-</syntaxhighlight>
+</pre>
 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.
@@ Line 145: / Line 145: @@
    </init-param>
 </servlet>
-</syntaxhighlight>
+</pre>
 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.

@@ Line 2: / Line 2: @@
 =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.
@@ Line 130: / Line 128: @@
 </syntaxhighlight>
-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.
+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.
 To enable or disable a specific service, the corresponding servlet entry in the {{Code|web.xml}} file needs to be removed/commented.
@@ Line 166: / Line 164: @@
 ;Version 8.6
-* Updated: Authentication readded to RESTXQ.
+* Updated: Authentication re-added to RESTXQ.
 * 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).

@@ Line 39: / Line 39: @@
 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).
-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 [https://www.eclipse.org/jetty/documentation/current/jetty-xml-config.html Jetty Documentation].
+If you use Jetty (which is the default HTTP server of BaseX), the server configuration is 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 [https://www.eclipse.org/jetty/documentation/current/jetty-xml-config.html Jetty Documentation].
 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/.

@@ Line 8: / Line 8: @@
 * If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon.
-Both an instance of [https://www.eclipse.org/jetty/ Jetty] and BaseX [[Database Server]] will be started. By default, Jetty listens to the port 8080, and the [[Database Server|BaseX Database Server]] is accessible on port {{Code|1984}}. After startup, you can access a plain HTML welcome page via http://localhost:8080.
+Both an instance of [https://www.eclipse.org/jetty/ Jetty] and BaseX [[Database Server]] will be started. 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:

@@ Line 151: / Line 151: @@
 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.
-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:
+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>:
-: <code>http://admin:admin@localhost:8080/</code>
+: <code>http://admin:...@localhost:8080/</code>
 Users are specified in a {{Code|users.xml}} file, which is stored in the database directory (see [[User Management]] for more information).

@@ Line 53: / Line 53: @@
 The following services are available and enabled by default:
 {| class="wikitable"
 |- valign="top"
 ! Name
@@ Line 89: / Line 89: @@
 {| class="wikitable"
-|-
+|- valign="top"
 ! width="160" | Option
 ! width="90" |Default
 ! Description
-|-
+|- valign="top"
 |{{Option|USER}}
 |{{Code|admin}}
 | If a user is specified, no credentials must be passed on by the client.
-|-
+|- valign="top"
 |{{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}}.
-|-
+|- valign="top"
 |{{Option|RESTXQPATH}}
 |{{Code|.}}
 |Relative or absolute directory referencing the [[RESTXQ]] modules. By default, the option points to the standard web application directory.
-|-
+|- valign="top"
 |{{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.
-|-
+|- valign="top"
 |{{Option|AUTHMETHOD}}
 |{{Code|Basic}}
@@ Line 183: / Line 183: @@
 ;Version 7.3
 * Updated: {{Code|client}} mode replaced with {{Code|server}} mode
 ;Version 7.2
 * Web Application concept revised

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

@@ Line 3: / Line 3: @@
 =Startup=
-{{Announce|With Version 10, the default ports have been changed from 8984/8985 to 8080/8081.}}
+{{Announce|With Version 10, the default admin password has been removed, and the default ports have been changed from 8984/8985 to 8080/8081.}}
 * 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.
@@ Line 160: / Line 160: @@
 ;Version 10.0
-* Updated: The default ports have been changed from 8984/8985 to 8080/8081.
+* Updated: The default admin password has been removed, and the default ports have been changed from 8984/8985 to 8080/8081.
 ;Version 9.0