From 886b6c1df0c44ddcdbc0b70569b8e40d57240469 Mon Sep 17 00:00:00 2001 From: Zack DeRose Date: Mon, 2 Nov 2020 02:41:02 -0700 Subject: [PATCH] docs(docs): Adding description for encryptionKey task runner option --- docs/angular/guides/configuration.md | 1 + docs/react/guides/configuration.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/angular/guides/configuration.md b/docs/angular/guides/configuration.md index c8b42f855160d..324f992babd08 100644 --- a/docs/angular/guides/configuration.md +++ b/docs/angular/guides/configuration.md @@ -265,6 +265,7 @@ Tasks runners can accept different options. The following are the options suppor - `captureStderr` defines whether the cache will capture stderr or just stdout - `skipNxCache` defines whether the Nx Cache should be skipped. Defaults to `false` - `cacheDirectory` defines where the local cache is stored, which is `node_modules/.cache/nx` by default. +- `encryptionKey` (when using `"@nrwl/nx-cloud"` only) defines an encryption key to support end-to-end encryption of your cloud cache. You may also provide an environment variable with the key `NX_CLOUD_ENCRYPTION_KEY` that contains an encryption key as its value. The Nx Cloud task runner will normalize the key length, so any length of key is acceptable. - `runtimeCacheInputs` defines the list of commands that will be run by the runner to include into the computation hash value. `runtimeCacheInputs` can be set as follows: diff --git a/docs/react/guides/configuration.md b/docs/react/guides/configuration.md index d5d9888c9363a..35c9ee8d021e8 100644 --- a/docs/react/guides/configuration.md +++ b/docs/react/guides/configuration.md @@ -288,6 +288,7 @@ Tasks runners can accept different options. The following are the options suppor - `captureStderr` defines whether the cache will capture stderr or just stdout - `skipNxCache` defines whether the Nx Cache should be skipped. Defaults to `false` - `cacheDirectory` defines where the local cache is stored, which is `node_modules/.cache/nx` by default. +- `encryptionKey` (when using `"@nrwl/nx-cloud"` only) defines an encryption key to support end-to-end encryption of your cloud cache. You may also provide an environment variable with the key `NX_CLOUD_ENCRYPTION_KEY` that contains an encryption key as its value. The Nx Cloud task runner will normalize the key length, so any length of key is acceptable. - `runtimeCacheInputs` defines the list of commands that will be run by the runner to include into the computation hash value. `runtimeCacheInputs` can be set as follows: