Skip to content

Commit 35ba8fe

Browse files
authored
Docs: Minor changes for consistency
Fix: Added link in Table of contents Fix: Proofing changes Signed-off-by: Kate Andrews <keandrews@gmail.com>
1 parent ec00851 commit 35ba8fe

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/reference.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This page contains reference documentation for configuring CipherStash Proxy and
66

77
- [Proxy config options](#proxy-config-options)
88
- [Recommended settings for development](#recommended-settings-for-development)
9+
- [Docker-specific configuration](#docker-specific-configuration)
910
- [Prometheus metrics](#prometheus-metrics)
1011
- [Available metrics](#available-metrics)
1112
- [Supported architectures](#supported-architectures)
@@ -57,7 +58,7 @@ worker_threads = "4"
5758
# Env: CS_SERVER__THREAD_STACK_SIZE
5859
thread_stack_size = "2097152"
5960

60-
### Proxy -> Backing Database connection settings
61+
### Proxy -> Backing database connection settings
6162
[database]
6263
# Database host address
6364
# Optional
@@ -226,9 +227,9 @@ CS_DATABASE__CONFIG_RELOAD_INTERVAL="10"
226227
CS_DATABASE__SCHEMA_RELOAD_INTERVAL="10"
227228
```
228229

229-
### Docker-specific Configuration
230+
### Docker-specific configuration
230231

231-
As a convenience for development, if you use [Proxy's Docker container](../proxy.Dockerfile) with its default entrypoint and the below environment variables set, the EQL SQL will be applied to the database, and an example schema (eg. with the `users` table, from the [README Getting Started example](../README.md#getting-started)) will be loaded. These are turned on by default in the [development `docker-compose.yml`](../docker-compose.yml):
232+
As a convenience for development, if you use [Proxy's Docker container](../proxy.Dockerfile) with its default entrypoint and the below environment variables set, the EQL SQL will be applied to the database, and an example schema (for example, with the `users` table, from the [README Getting Started example](../README.md#getting-started)) will be loaded. These are turned on by default in the [development `docker-compose.yml`](../docker-compose.yml):
232233

233234
(It is not recommended to use either of these in production.)
234235

@@ -237,7 +238,7 @@ CS_DATABASE__INSTALL_EQL="true"
237238
CS_DATABASE__INSTALL_EXAMPLE_SCHEMA="true"
238239
```
239240

240-
As a convenience for production, if you use [Proxy's Docker container](../proxy.Dockerfile) with the default entrypoint and the below environment variable set, the AWS RDS global certificate bundle will be added to the OS' set of trusted certificates. This is recommended when running Proxy on AWS.
241+
As a convenience for production, if you use [Proxy's Docker container](../proxy.Dockerfile) with the default entrypoint and the below environment variable set, the AWS RDS global certificate bundle will be added to the operating system's set of trusted certificates. This is recommended when running Proxy on AWS.
241242

242243
```bash
243244
CS_DATABASE__INSTALL_AWS_RDS_CERT_BUNDLE="true"

0 commit comments

Comments
 (0)