BaseX installation

See an error, omission, obsolete information below? Let us know by opening a new issue report with one click. Thanks!

Time stamp: 29-08-2025.

Installation instructions for the BaseX development branch

Audience: For now, the status of this document is: only for the curious. We are going to retire the eXist line in 2026 at the latest, though.

Credits for the documentation and coding effort: Eliza Margaretha

Basex installation steps

1. Download basex zip and the dev-bx branch

2. (optional) change the port for basexin the following file:

/opt/basex/basex117/webapp/WEB-INF/jetty.xml

Default port: 8080

3. Make a symlink of dev-bx to the basex directory webapps/clarin

• copy commit-id.xml to webapps/clarin/data (this item will soon become invalid)

4. Open the basexgui and create a new database with input path webapps/clarin/data

5. Open the web.xml at webapps/WEB-INF/web.xml and add the following servlet mapping

   <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>/clarin/resources/*</url-pattern>
   </servlet-mapping>

5a. To enable Rest service without authentication, add "rest-user" to the REST servlet as follows.

  <servlet>
    <servlet-name>REST</servlet-name>
    <servlet-class>org.basex.http.rest.RESTServlet</servlet-class>
    <init-param>
    	<param-name>org.basex.user</param-name>
    	<param-value>rest-user</param-value>
  	 </init-param>
  </servlet>

5b. Create a new "rest-user" in the database

• Open http://localhost:[port]/dba
• Select "Users" from the top menu
• Click "Create"

    Name : rest-user
    Password: ...
    Permission: read

6. Run basexhttp

7. Open http://localhost:[port]/clarin/index.xq