ODK

https://docs.getodk.org
Admin
ODK is an open-source data collection platform that enables researchers and field teams to build...
Tokens:201,843
Snippets:2,267
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install project requirements

Source: https://docs.getodk.org/cygwin

Activate the environment and install dependencies from requirements.txt.

```bash
> workon odkenv
```

```bash
$ pip install -r requirements.txt
```

--------------------------------

### Service Configuration Example

Source: https://docs.getodk.org/central-install-digital-ocean

Example structure of the service configuration file.

```json
"env": {
  "domain": "https://${DOMAIN}:${HTTPS_PORT}",
  "sysadminAccount": "${SYSADMIN_EMAIL}"
},
"external": {
}
```

--------------------------------

### Install and manage virtualenvwrapper

Source: https://docs.getodk.org/cygwin

Commands to install the wrapper and manage virtual environments.

```bash
> pip install virtualenvwrapper-win
```

```bash
> mkvirtualenv odkenv
```

```bash
(odkenv) /odk/docs
```

```bash
> deactivate
```

```bash
> workon odkenv
```

--------------------------------

### Get Server Logo

Source: https://docs.getodk.org/central-api-system-endpoints

Example of the binary data returned when a custom server logo is configured.

```text
"(binary data)"
```

--------------------------------

### Install PostgreSQL 10 on Ubuntu

Source: https://docs.getodk.org/aggregate-tomcat

Command to install the PostgreSQL 10 database server on Ubuntu.

```bash
sudo apt-get install postgresql-10
```

--------------------------------

### Install Python Dependencies

Source: https://docs.getodk.org/docs-tech-guide

Upgrades pip and installs required documentation tools from requirements.txt.

```bash
(odkenv) /odk/docs/ $ pip install --upgrade pip
(odkenv) /odk/docs/ $ pip install -r requirements.txt
```

```powershell
(odkenv) /odk/docs/ > pip install --upgrade pip
(odkenv) /odk/docs/ > pip install -r requirements.txt
```

--------------------------------

### Entity Creation Response Example

Source: https://docs.getodk.org/central-api-entity-management

Example of a successful 200 OK response containing the created entity details and versioning information.

```json
{
  "uuid": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44",
  "createdAt": "2018-01-19T23:58:03.395Z",
  "updatedAt": "2018-03-21T12:45:02.312Z",
  "deletedAt": "2018-03-21T12:45:02.312Z",
  "creatorId": 1,
  "conflict": null,
  "currentVersion": {
    "label": "John (88)",
    "current": true,
    "createdAt": "2018-03-21T12:45:02.312Z",
    "creatorId": 1,
    "userAgent": "Enketo/3.0.4",
    "conflictingProperties": null,
    "version": 1,
    "baseVersion": null,
    "branchId": null,
    "trunkVersion": null,
    "branchBaseVersion": null,
    "data": {
      "firstName": "John",
      "age": "88"
    },
    "dataReceived": {
      "label": "John (88)",
      "firstName": "John",
      "age": "88"
    }
  }
}
```

--------------------------------

### Install OpenJDK 11 on Ubuntu

Source: https://docs.getodk.org/aggregate-tomcat

Use this command to install the required Java Runtime Environment on Ubuntu systems.

```bash
sudo apt-get install openjdk-11-jre
```

--------------------------------

### Install virtualenv

Source: https://docs.getodk.org/cygwin

Install the virtualenv package using pip.

```bash
> pip install virtualenv
```

--------------------------------

### Get CLI help

Source: https://docs.getodk.org/briefcase-using

Display help information for the Briefcase command line interface.

```bash
$ java -jar {path/to/briefcase-jar-file} --help
```

--------------------------------

### Install and Initialize Git LFS

Source: https://docs.getodk.org/docs-tech-guide

Commands to install and configure Git Large File Storage for managing non-text assets.

```bash
$ git lfs install
```

```bash
$ brew install git-lfs
$ git lfs install
```

```powershell
> git lfs install
```

--------------------------------

### Install and Verify Python with Homebrew

Source: https://docs.getodk.org/docs-tech-guide

Use Homebrew to install Python on macOS and verify the installation version.

```bash
$ brew install python
.
.
.
$ python3 --version
Python 3.7.0
```

--------------------------------

### Dataset CSV Response Example

Source: https://docs.getodk.org/central-api-dataset-management

Example of the CSV content returned when downloading a dataset.

```csv
__id,label,geometry,species,circumference_cm,__createdAt,__creatorId,__creatorName,__updates,__updatedAt,__version
2c1ee90b-dde8-434b-9985-2eefd8465339,666cm purpleheart,-29.281608 -67.624883 0 0,purpleheart,667,2023-05-31T19:49:28.902Z,22,Alice,1,2023-05-31T19:52:34.467Z,1
84ac3a03-9980-4098-93a5-b81fdc6ea749,555cm wallaba,18.921876 77.309451 0 0,wallaba,555,2023-05-31T19:49:20.152Z,22,Alice,0,,1
```

--------------------------------

### Install Git via Homebrew

Source: https://docs.getodk.org/docs-tech-guide

Use Homebrew to install the Git version control system on macOS.

```bash
$ brew install git
```

--------------------------------

### Example of a Completed Media Download URL

Source: https://docs.getodk.org/central-submissions

A concrete example of a fully constructed URL used to trigger a browser download for a specific media file.

```text
https://my.odk.server/#/dl/projects/1/forms/forest_survey/submissions/uuid:20bcee82-4a22-4381-a6aa-f926fc85fb22/attachments/my.file.mp3
```

--------------------------------

### Bulk Entity Creation Request Example

Source: https://docs.getodk.org/central-api-entity-management

Example request body for creating multiple entities with specified UUIDs and source information.

```json
{
  "entities": [
    {
      "uuid": "54a405a0-53ce-4748-9788-d23a30cc3afa",
      "label": "John Doe (22)",
      "data": {
        "firstName": "John",
        "age": "22"
      }
    },
    {
      "uuid": "0c3a7922-b611-42ca-a961-944e09fa9aa2",
      "label": "Amy Jane (38)",
      "data": {
        "firstName": "Amy",
        "age": "38"
      }
    }
  ],
  "source": {
    "name": "my_dataset.csv",
    "size": 100
  }
}
```

--------------------------------

### List all Forms Response

Source: https://docs.getodk.org/central-api-form-management

Example JSON response returned when listing all forms in a project.

```json
[
  {
    "projectId": 1,
    "xmlFormId": "simple",
    "name": "Simple",
    "version": "2.1",
    "enketoId": "abcdef",
    "hash": "51a93eab3a1974dbffc4c7913fa5a16a",
    "keyId": 3,
    "state": "open",
    "publishedAt": "2018-01-21T00:04:11.153Z",
    "createdAt": "2018-01-19T23:58:03.395Z",
    "updatedAt": "2018-03-21T12:45:02.312Z"
  }
]
```

--------------------------------

### Install PostgreSQL Extension

Source: https://docs.getodk.org/central-install-digital-ocean

SQL command to enable the pgrowlocks extension required for file management.

```sql
CREATE EXTENSION IF NOT EXISTS pgrowlocks;
```

--------------------------------

### Restart the server

Source: https://docs.getodk.org/central-upgrade

Stops the current services and starts them again with the updated images.

```bash
$ docker compose stop && docker compose up -d
```

--------------------------------

### Retrieve public configuration response

Source: https://docs.getodk.org/central-api-system-endpoints

Example JSON response for the GET /v1/config/public endpoint.

```json
{
  "login-appearance": {
    "key": "login-appearance",
    "setAt": "2018-01-06T00:32:52.787Z",
    "value": {
      "title": "Better Data, Better Cocoa",
      "description": "pencil"
    }
  },
  "logo": {
    "key": "logo",
    "setAt": "2018-01-06T00:32:52.787Z",
    "blobExists": "true"
  },
  "hero-image": {
    "key": "hero-image",
    "setAt": "2018-01-06T00:32:52.787Z",
    "blobExists": "true"
  }
}
```

--------------------------------

### Create and Navigate to Project Directory

Source: https://docs.getodk.org/docs-tech-guide

Create a dedicated directory for ODK projects and move into it.

```bash
$ mkdir odk
$ cd odk
/odk/ $
```

```powershell
> mkdir odk
> cd odk
/odk/ >
```

--------------------------------

### Retrieve Submission Version GeoJSON

Source: https://docs.getodk.org/central-api-submission-management

Example response body for a GET request to fetch the GeoJSON representation of a specific submission version.

```json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "uuid:b1628661-65ed-4cab-8e30-19c17fef2de0",
      "geometry": {
        "type": "Point",
        "coordinates": [
          4.7871262893819555,
          52.24107555748181,
          0
        ]
      },
      "properties": {
        "fieldpath": "/singular/input_geopoint"
      }
    }
  ]
}
```

--------------------------------

### Backup and diff configuration files

Source: https://docs.getodk.org/central-upgrade

Create backups and view differences for configuration templates to facilitate manual migration.

```bash
$ cp files/service/config.json.template files/service/config.json.template.bak
```

```bash
$ git diff files/service/config.json.template
```

```bash
$ cp docker-compose.yml docker-compose.yml.bak
```

```bash
$ git diff docker-compose.yml
```

--------------------------------

### Get Form Schema Fields Response

Source: https://docs.getodk.org/central-api-form-management

Example JSON response containing a depth-first traversal list of fields defined in the XForm.

```json
[
  {
    "name": "meta",
    "path": "/meta",
    "type": "structure"
  },
  {
    "name": "instanceID",
    "path": "/meta/instanceID",
    "type": "string"
  },
  {
    "name": "name",
    "path": "/name",
    "type": "string"
  },
  {
    "name": "age",
    "path": "/age",
    "type": "int"
  },
  {
    "name": "photo",
    "path": "/photo",
    "type": "binary",
    "binary": true
  }
]
```

--------------------------------

### Build documentation site

Source: https://docs.getodk.org/docs-tech-guide

Compiles documentation files into a working website using Sphinx.

```Bash
(odkenv) /odk/docs/ $ make autobuild
```

```PowerShell
(odkenv) /odk/docs/ > rm -r -fo tmp
(odkenv) /odk/docs/ > rm -r -fo build
(odkenv) /odk/docs/ > Copy-Item src -Destination tmp -Recurse
(odkenv) /odk/docs/ > sphinx-build -b dirhtml tmp build
```

--------------------------------

### Retrieve Form Version XML

Source: https://docs.getodk.org/central-api-form-management

Example XML response returned when requesting a specific form version via the GET /v1/projects/{projectId}/forms/{xmlFormId}/versions/{version}.xml endpoint.

```xml
<h:html xmlns="http://www.w3.org/2002/xforms" xmlns:h="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:jr="http://openrosa.org/javarosa">
  <h:head>
    <h:title>Simple</h:title>
    <model>
      <instance>
        <data id="simple" version="2.1">
          <meta>
            <instanceID/>
          </meta>
          <name/>
          <age/>
        </data>
      </instance>

      <bind nodeset="/data/meta/instanceID" type="string" readonly="true()" calculate="concat('uuid:', uuid())"/>
      <bind nodeset="/data/name" type="string"/>
      <bind nodeset="/data/age" type="int"/>
    </model>

  </h:head>

    <input ref="/data/name">
      <label>What is your name?</label>
    </input>
    <input ref="/data/age">
      <label>What is your age?</label>
    </input>
  </h:body>
</h:html>
```

--------------------------------

### GET /v1/audits

Source: https://docs.getodk.org/central-api-system-endpoints

Retrieves a list of audit log entries. Supports filtering by action type, start and end timestamps, and pagination via limit and offset parameters. Extended metadata can be requested via the X-Extended-Metadata header.

```APIDOC
## GET /v1/audits

### Description
Allows access to system log entries with paging and filtering options.

### Method
GET

### Endpoint
/v1/audits

### Parameters
#### Query Parameters
- **action** (string) - Optional - The name of the action to filter by.
- **start** (string) - Optional - The timestamp before which log entries are to be filtered out (ISO 8601).
- **end** (string) - Optional - The timestamp after which log entries are to be filtered out (ISO 8601).
- **limit** (number) - Optional - The maximum number of entries to return.
- **offset** (number) - Optional - The zero-indexed number of entries to skip.

### Response
#### Success Response (200)
- **actorId** (number) - The ID of the actor that initiated the action.
- **action** (string) - The action that was taken.
- **acteeId** (string) - The ID of the permissioning object against which the action was taken.
- **details** (object) - Additional details about the action.
- **loggedAt** (string) - ISO date format of the log entry.

#### Response Example
[
  {
    "actorId": 42,
    "action": "user.session.create",
    "details": {
      "userAgent": "Mozilla/5.0"
    },
    "acteeId": "85cb9aff-005e-4edd-9739-dc9c1a829c44",
    "loggedAt": "2018-04-18T23:19:14.802Z"
  }
]
```

--------------------------------

### Verify Python Installation on Windows

Source: https://docs.getodk.org/docs-tech-guide

Check the installed Python version in PowerShell after running the Windows installer.

```powershell
> python --version
Python 3.7.0
```

--------------------------------

### Pick Form or Instance

Source: https://docs.getodk.org/collect-api

Launch an activity to allow the user to pick a form or instance and return the URI.

```APIDOC
## Pick Form/Instance

### Description
Use ACTION_PICK to let the user select a form or instance. The result is returned in onActivityResult.

### Code
```java
Intent intent = new Intent(Intent.ACTION_PICK);
intent.setType("vnd.android.cursor.dir/vnd.odk.form");
startActivityForResult(intent, PICK_FORM_REQUEST);
```
```

--------------------------------

### Configure SSL Settings in .env

Source: https://docs.getodk.org/central-install-digital-ocean

Navigate to the central directory, open the .env file, and set the domain and SSL type.

```bash
$ cd central
```

```bash
$ nano .env
```

```text
DOMAIN=MyOdkCentralServer.com
SSL_TYPE=customssl
```

--------------------------------

### Cross-Reference Examples

Source: https://docs.getodk.org/docs-syntax-guide

Examples of linking to documents, sections, and glossary terms.

```rst
- Link to this document:

  - :doc:`contributing`
  - :doc:`anchor text <contributing>`

- Link to this section:

  - :ref:`cross-referencing`
  - :ref:`anchor text <cross-referencing>`

- Link to a term:

  - :term:`participant`
  - :term:`anchor text <participant>`

```

--------------------------------

### Create working directory

Source: https://docs.getodk.org/cygwin

Create a new directory for the project.

```bash
> mkdir odk
```

--------------------------------

### GET /v1/example2

Source: https://docs.getodk.org/central-api-authentication

Demonstrates how to use HTTPS Basic Authentication by providing an Authorization header. The header must contain a base64 encoded string of the user's email and password.

```APIDOC
## GET /v1/example2

### Description
Demonstrates the use of HTTPS Basic Authentication for API requests. This method is discouraged due to performance impacts and security risks.

### Method
GET

### Endpoint
/v1/example2

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Base64 encoding of the credentials in the format 'email:password'. Example: `Basic bXkuZW1haWwuYWRkcmVzc0BvcGVuZGF0YWtpdC5vcmc6bXkucGFzc3dvcmQ=`

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
{
  "success": true
}
```

--------------------------------

### Create Virtual Environment

Source: https://docs.getodk.org/docs-tech-guide

Initialize a Python virtual environment named odkenv.

```bash
/odk/ $ python3 -m venv odkenv
```

```powershell
/odk/ > python -m venv odkenv
```

--------------------------------

### List virtual environment contents

Source: https://docs.getodk.org/cygwin

Verify the creation of the virtual environment by listing its files.

```bash
> ls odkenv
```

--------------------------------

### Digest Authentication Interaction Example

Source: https://docs.getodk.org/openrosa-authentication

Example HTTP request and response flow for Digest Authentication.

```http
GET /dir/index.html HTTP/1.0
```

```http
HTTP/1.0 401 Unauthorized
Server: HTTPd/0.9
Date: Sun, 10 Apr 2005 20:26:47 GMT
WWW-Authenticate: Digest realm="testrealm@host.com",
                       qop="auth,auth-int",
                       nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093",
                       opaque="5ccc069c403ebaf9f0171e9517f40e41"
Content-Type: text/html
Content-Length: 311

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">

<HTML>
  <HEAD>
    <TITLE>Error</TITLE>
    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
  </HEAD>
  <BODY>
    <H1>401 Unauthorized.</H1>
  </BODY>
</HTML>
```

```http
GET /dir/index.html HTTP/1.0
Host: localhost
Authorization: Digest username="Mufasa",
                      realm="testrealm@host.com",
                      nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093",
                      uri="/dir/index.html",
                      qop=auth,
                      nc=00000001,
                      cnonce="0a4f113b",
                      response="6629fae49393a05397450978507c4ef1",
                      opaque="5ccc069c403ebaf9f0171e9517f40e41"
```

```http
HTTP/1.0 200 OK
Server: HTTPd/0.9
Date: Sun, 10 Apr 2005 20:27:03 GMT
Content-Type: text/html
Content-Length: 7984
```

--------------------------------

### Sample Logback Configuration

Source: https://docs.getodk.org/briefcase-using

A template for a logback.xml file to define rolling file appenders and log patterns.

```xml
<configuration>
  <appender name="ROLLINGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>briefcase.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>briefcase.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
      <totalSizeCap>100MB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%d [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="info">
    <appender-ref ref="ROLLINGFILE" />
  </root>
</configuration>
```

--------------------------------

### Impersonal Pronoun 'Same' Examples

Source: https://docs.getodk.org/docs-style-guide

Examples showing the replacement of the non-standard 'same' with clearer alternatives.

```text
ODK Collect is an Android app. The same can be used for...
```

```text
ODK Collect is an Android app. It can be used for...
```

```text
ODK Collect is an Android app that is used to...
```

--------------------------------

### Configure environment settings

Source: https://docs.getodk.org/central-install-digital-ocean

Copy the template environment file and open it for editing.

```bash
$ cp .env.template .env
```

```bash
$ nano .env
```

--------------------------------

### Configure external app launch in XLSForm

Source: https://docs.getodk.org/collect-external-apps

Use the 'ex:' appearance to define the intent action and pass comma-delimited extras to an external application.

```text
integer | counter | Click launch to start the counter app | ex:org.opendatakit.counter(form_id='counter-form', form_name='Counter Form', question_id='1', question_name='Counter')
```

--------------------------------

### Meaningless Variable Naming Example

Source: https://docs.getodk.org/docs-style-guide

An example of poor coding style using non-descriptive variable names.

```Python
def myFunction(foo):

  for bar in foo:
     bar[foo] = foo[spam] + spam[foo]

  return foobar
```

--------------------------------

### Verb Form and Title Examples

Source: https://docs.getodk.org/docs-style-guide

Examples illustrating the preference for gerunds over 'How to' constructions in section titles.

```text
How to install ODK Collect
--------------------------
```

```text
Installing ODK Collect
----------------------
```

```text
Installing ODK Central
------------------------

Download ODK Central
~~~~~~~~~~~~~~~~~~~~~~

Section content here.
```

--------------------------------

### Pronoun Usage Examples

Source: https://docs.getodk.org/docs-style-guide

Examples demonstrating the shift from gendered or plural-confusing pronouns to clearer, neutral phrasing.

```text
The enumerator uses his device.
```

```text
The enumerator uses their device.
```

```text
When using Collect, first the enumerator opens the app on their device. Then they complete the survey.
```

```text
To use Collect:

- open the app
- complete the survey
```

--------------------------------

### Launching Briefcase with Custom Log Configuration

Source: https://docs.getodk.org/briefcase-using

Command to execute Briefcase while specifying a custom logback configuration file.

```bash
$ java -Dlogging.config="{path/to/logback.xml}" -jar {path/to/briefcase-jar-file}
```

--------------------------------

### Verify Python Installation

Source: https://docs.getodk.org/docs-tech-guide

Check the installed version of Python 3 to ensure it meets the minimum requirement of 3.6+.

```bash
$ python3 --version
Python 3.7.0
```

--------------------------------

### Creating a Web User

Source: https://docs.getodk.org/central-command-line

Create a new user account by specifying the email address.

```bash
$ docker compose exec service odk-cmd --email example@getodk.org user-create
```

--------------------------------

### Set frontend build mode

Source: https://docs.getodk.org/central-upgrade

Add this line to the .env file to enable building the frontend from source.

```text
FRONTEND_BUILD_MODE=source
```

--------------------------------

### Example of deprecated feature warning

Source: https://docs.getodk.org/aggregate-app-engine

This is an example of a warning message that may appear in the output window during the upload process.

```text
  listBackends : Warning: This application uses Backends, a deprecated feature that has been replaced by Modules, which offers additional functionality. Please convert your backends to modules as described at: https://developers.google.com/appengine/docs/java/modules/converting.
```

--------------------------------

### Create a Dataset Response

Source: https://docs.getodk.org/central-api-dataset-management

Example JSON response returned upon successfully creating a Dataset.

```json
{
  "name": "people",
  "createdAt": "2018-01-19T23:58:03.395Z",
  "projectId": 1,
  "approvalRequired": false,
  "ownerOnly": false,
  "lastUpdate": "2018-01-19T23:58:03.395Z",
  "sourceForms": [],
  "linkedForms": [],
  "properties": []
}
```

--------------------------------

### Launch Form or Instance List Activity

Source: https://docs.getodk.org/collect-api

Use an Intent with ACTION_VIEW to display the list of available forms or saved instances to the user.

```APIDOC
## Launch Form List

### Description
Displays the list of forms for the user to select and fill.

### Code
```java
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setType("vnd.android.cursor.dir/vnd.odk.form");
startActivity(intent);
```

## Launch Instance List

### Description
Displays the list of saved instances for the user to select and edit.

### Code
```java
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setType("vnd.android.cursor.dir/vnd.odk.instance");
startActivity(intent);
```
```

--------------------------------

### Change installer permissions on Linux

Source: https://docs.getodk.org/aggregate-app-engine

Use this command in a terminal to make the ODK Aggregate installer executable on Linux systems.

```bash
$ chmod 554 "ODK Aggregate vN.N.N linux-installer.run"
```

--------------------------------

### CSV Response Example for Deleted Dataset Entities

Source: https://docs.getodk.org/central-api-dataset-management

Example of the CSV format returned when downloading entities from a soft-deleted dataset.

```csv
__id,label,geometry,species,circumference_cm,__createdAt,__creatorId,__creatorName,__updates,__updatedAt,__version
2c1ee90b-dde8-434b-9985-2eefd8465339,666cm purpleheart,-29.281608 -67.624883 0 0,purpleheart,667,2023-05-31T19:49:28.902Z,22,Alice,1,2023-05-31T19:52:34.467Z,1
```

--------------------------------

### Launch instance list activity

Source: https://docs.getodk.org/collect-api

Starts the ODK Collect activity to display a list of saved forms for editing.

```java
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setType("vnd.android.cursor.dir/vnd.odk.instance");
startActivity(intent);
```

--------------------------------

### Create native virtual environment

Source: https://docs.getodk.org/cygwin

Initialize a new virtual environment with a specific Python interpreter.

```bash
> virtualenv -p <python path/python.exe> odkenv
```

--------------------------------

### Connect to PostgreSQL Database

Source: https://docs.getodk.org/central-install-digital-ocean

Commands to connect to the database server using either the default or a custom configuration.

```bash
$ docker exec -it central-postgres14-1 psql -U odk -W odk
```

```bash
$ psql -h mydbhost -p 5432 -U mydbadmin
```

--------------------------------

### Install Apache Tomcat 8.5 on macOS and Ubuntu

Source: https://docs.getodk.org/aggregate-tomcat

Commands to install Apache Tomcat 8.5 using package managers on macOS and Ubuntu.

```bash
brew install tomcat@8.5
```

```bash
sudo apt-get install tomcat8 tomcat8-common tomcat8-user tomcat8-admin
```

--------------------------------

### Create upgrade permission file

Source: https://docs.getodk.org/central-upgrade

Creates a marker file required to proceed with the PostgreSQL 14 upgrade.

```bash
$ touch ./files/allow-postgres14-upgrade
```

--------------------------------

### Example Sphinx build output

Source: https://docs.getodk.org/docs-tech-guide

Shows the expected success message or warning format when running the build process.

```text
build succeeded, 18 warnings.
```

```text
/path/to/file-name.rst:LINENUMBER: WARNING: warning message

short excerpt from the file
```
Tokens:
Raw