Skip to content

Commit d2c3a8e

Browse files
Merge pull request #473 from getodk/ktuite/enketo-readme
Minor change to Enketo readme example config
2 parents 3f3c6b6 + 23792c1 commit d2c3a8e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/enketo.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Enketo provides a web-based form submission UI, which is used in ODK Central for
55
Enketo runs as a Node.js server and caches intermediate representations of forms in Redis. ODK Central Backend stores information for managing and launching Enketo forms from ODK Central Frontend, so all three must be configured together.
66

77
- Clone [enketo-express](https://github.com/enketo/enketo-express) and read the [Manual Installation Instructions](https://github.com/enketo/enketo-express/blob/master/tutorials/00-getting-started.md#manually). Specifically:
8-
* Install Redis. (Node.js will already be installed to run ODK Central Frontend and Backend.) Enketo will expect Redis on the default port of `6379`.
9-
* Install dependencies with `npm install`.
8+
* Install Redis. (Node.js will already be installed to run ODK Central Frontend and Backend.) Enketo will expect Redis on the default port of `6379`.
9+
* Install dependencies with `npm install`.
1010
- Configure Enketo. A minimal `config/config.json` for Enketo looks like:
1111

1212
```
@@ -20,6 +20,7 @@ Enketo runs as a Node.js server and caches intermediate representations of forms
2020
}
2121
},
2222
"base path": "-",
23+
"query parameter to pass to submission": "st",
2324
"redis": {
2425
"cache": {
2526
"port": "6379"
@@ -40,9 +41,9 @@ Enketo runs as a Node.js server and caches intermediate representations of forms
4041
- Run the Enketo server via `npm start` (from the [Enketo Documentation](https://github.com/enketo/enketo-express/blob/master/tutorials/00-getting-started.md#how-to-run)).
4142

4243
- There will be three services running:
43-
* ODK Central Frontend (via Nginx) on port `8989`
44-
* ODK Central Backend on port `8383`
45-
* Enketo server on port `8005`
44+
* ODK Central Frontend (via Nginx) on port `8989`
45+
* ODK Central Backend on port `8383`
46+
* Enketo server on port `8005`
4647

4748

4849
### Notes on existing Central Frontend configuration

0 commit comments

Comments
 (0)