Skip to content

Commit

Permalink
docs: add missing environment variable options
Browse files Browse the repository at this point in the history
  • Loading branch information
@mmalenic
mmalenic committed Dec 23, 2022
1 parent 95ed615 commit ad096c8
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions htsget-config/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ To configure the data server, set the following options:
| <span id="data_server_addr">`data_server_addr`</span> | The address for the data server. | Socket address | `'127.0.0.1:8080'` |
| <span id="data_server_local_path">`data_server_local_path`</span> | The local path which the data server can access to serve files. | Filesystem path | `'data'` |
| <span id="data_server_serve_at">`data_server_serve_at`</span> | The path which the data server will prefix to all response URLs for tickets. | URL path | `'/data'` |
| <span id="data_server_serve_at">`data_server_key`</span> | The path to the PEM formatted X.509 private key used by the data server. This is used to enable TLS with HTTPS. | Filesystem path | Not set |
| <span id="data_server_serve_at">`data_server_cert`</span> | The path to the PEM formatted X.509 certificate used by the data server. This is used to enable TLS with HTTPS. | Filesystem path | Not set |
| <span id="data_server_key">`data_server_key`</span> | The path to the PEM formatted X.509 private key used by the data server. This is used to enable TLS with HTTPS. | Filesystem path | Not set |
| <span id="data_server_cert">`data_server_cert`</span> | The path to the PEM formatted X.509 certificate used by the data server. This is used to enable TLS with HTTPS. | Filesystem path | Not set |
| <span id="data_server_cors_allow_credentials">`data_server_cors_allow_credentials`</span> | Controls the CORS Access-Control-Allow-Credentials for the data server. | Boolean | `false` |
| <span id="data_server_cors_allow_origins">`data_server_cors_allow_origins`</span> | Set the CORS Access-Control-Allow-Origin returned by the data server, this can be set to `All` to send a wildcard, `Mirror` to echo back the request sent by the client, or a specific array of origins. | `'All'`, `'Mirror'` or a array of origins | `['http://localhost:8080']` |
| <span id="data_server_cors_allow_headers">`data_server_cors_allow_headers`</span> | Set the CORS Access-Control-Allow-Headers returned by the data server, this can be set to `All` to allow all headers, or a specific array of headers. | `'All'`, or a array of headers | `'All'` |
Expand Down Expand Up @@ -251,14 +251,18 @@ The following environment variables - corresponding to the TOML config - are ava
| `HTSGET_TICKET_SERVER_CORS_ALLOW_CREDENTIALS` | See [`ticket_server_cors_allow_credentials`](#ticket_server_cors_allow_credentials) |
| `HTSGET_TICKET_SERVER_CORS_ALLOW_ORIGINS` | See [`ticket_server_cors_allow_origins`](#ticket_server_cors_allow_origins) |
| `HTSGET_TICKET_SERVER_CORS_ALLOW_HEADERS` | See [`ticket_server_cors_allow_headers`](#ticket_server_cors_allow_headers) |
| `HTSGET_TICKET_SERVER_CORS_ALLOW_METHODS` | See [`ticket_server_cors_allow_methods`](#ticket_server_cors_allow_methods) |
| `HTSGET_TICKET_SERVER_CORS_MAX_AGE` | See [`ticket_server_cors_max_age`](#ticket_server_cors_max_age) |
| `HTSGET_TICKET_SERVER_CORS_EXPOSE_HEADERS` | See [`ticket_server_cors_expose_headers`](#ticket_server_cors_expose_headers) |
| `HTSGET_DATA_SERVER_ADDR` | See [`data_server_addr`](#data_server_addr) |
| `HTSGET_DATA_SERVER_LOCAL_PATH` | See [`data_server_local_path`](#data_server_local_path) |
| `HTSGET_DATA_SERVER_SERVE_AT` | See [`data_server_serve_at`](#data_server_serve_at) |
| `HTSGET_DATA_SERVER_KEY` | See [`data_server_key`](#data_server_key) |
| `HTSGET_DATA_SERVER_CERT` | See [`data_server_cert`](#data_server_cert) |
| `HTSGET_DATA_SERVER_CORS_ALLOW_CREDENTIALS` | See [`data_server_cors_allow_credentials`](#data_server_cors_allow_credentials) |
| `HTSGET_DATA_SERVER_CORS_ALLOW_ORIGINS` | See [`data_server_cors_allow_origins`](#data_server_cors_allow_origins) |
| `HTSGET_DATA_SERVER_CORS_ALLOW_HEADERS` | See [`data_server_cors_allow_headers`](#data_server_cors_allow_headers) |
| `HTSGET_DATA_SERVER_CORS_ALLOW_METHODS` | See [`data_server_cors_allow_methods`](#data_server_cors_allow_methods) |
| `HTSGET_DATA_SERVER_CORS_MAX_AGE` | See [`data_server_cors_max_age`](#data_server_cors_max_age) |
| `HTSGET_DATA_SERVER_CORS_EXPOSE_HEADERS` | See [`data_server_cors_expose_headers`](#data_server_cors_expose_headers) |
| `HTSGET_ID` | See [`id`](#id) |
Expand Down

0 comments on commit ad096c8

Please sign in to comment.