Skip to content

Commit 78b0331

Browse files
committed
updates shared secret
1 parent 6ddee41 commit 78b0331

File tree

3 files changed

+15
-76
lines changed

3 files changed

+15
-76
lines changed

content/docs/reference/reference.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@
541541
"shared-secret-file": {
542542
"id": "shared-secret-file",
543543
"title": "Shared Secret File",
544-
"path": "/shared-secret#shared-secret-file",
544+
"path": "/shared-secret",
545545
"description": "File path containing base64-encoded shared secret.",
546546
"services": [],
547547
"type": "string",

content/docs/reference/shared-secret.mdx

+12-73
Original file line numberDiff line numberDiff line change
@@ -15,82 +15,25 @@ import TabItem from '@theme/TabItem';
1515

1616
# Shared Secret
1717

18-
**Shared Secret** is the base64-encoded, 256-bit key used to mutually authenticate requests between Pomerium services. It's critical that secret keys are random, and stored safely.
19-
20-
### How to configure
21-
22-
<Tabs>
23-
<TabItem value="Core" label="Core">
24-
25-
| **Config file keys** | **Environment variables** | **Type** | **Usage** |
26-
| :------------------- | :------------------------ | :------- | :------------- |
27-
| `shared_secret` | `SHARED_SECRET` | `string` | \***optional** |
28-
29-
\* Standalone Pomerium Core configurations do not require a `shared_secret` or `shared_secret_file`. If you don't set a shared secret, Pomerium will generate one for you.
30-
31-
:::enterprise Shared Secret in Enterprise Configurations
32-
33-
If you're connecting to the [Enterprise Console](/docs/enterprise), your Pomerium Core and Enterprise configurations each require the same shared secret.
34-
35-
See the [Enterprise Quickstart](/docs/enterprise/quickstart) for an example implementation.
36-
37-
:::
18+
## Summary
3819

39-
### Examples
20+
**Shared Secret** is the base64-encoded, 256-bit key used to mutually authenticate requests between Pomerium services. It's critical that secret keys are random, and stored safely.
4021

4122
:::note
4223

4324
If you adjust your shared secret and/or how it's accessed by Pomerium, you may create a [**secret mismatch**](/docs/troubleshooting#shared-secret-mismatch).
4425

4526
:::
4627

47-
To generate a key, run the following command:
48-
49-
```shell
50-
head -c32 /dev/urandom | base64
51-
```
52-
53-
Add the value to your configuration file:
54-
55-
```yaml
56-
shared_secret: wC4RFsEdM1gHFzvRt3XW+iWw6Ddt/1kKkdh66OKxiqs=
57-
```
58-
59-
```bash
60-
SHARED_SECRET=wC4RFsEdM1gHFzvRt3XW+iWw6Ddt/1kKkdh66OKxiqs=
61-
```
62-
63-
</TabItem>
64-
<TabItem value="Enterprise" label="Enterprise">
65-
66-
`shared_secret` is a bootstrap configuration setting and is not configurable in the Console.
67-
68-
</TabItem>
69-
<TabItem value="Kubernetes" label="Kubernetes">
70-
71-
| **Name** | **Type** | **Usage** |
72-
| :---------------------- | :------- | :----------- |
73-
| `secrets.shared_secret` | `string` | **required** |
74-
75-
See Kubernetes [bootstrap secrets](/docs/k8s/reference#spec) for more information.
76-
77-
</TabItem>
78-
</Tabs>
79-
80-
## Shared Secret File
81-
82-
**Shared Secret File** is the location of a file containing the base64-encoded, 256-bit key used to mutually authenticate requests between Pomerium services. It's critical that secret keys are random, and stored safely.
83-
84-
### How to configure
28+
## How to configure
8529

8630
<Tabs>
8731
<TabItem value="Core" label="Core">
8832

8933
| **Config file keys** | **Environment variables** | **Type** | **Usage** |
9034
| :------------------- | :------------------------ | :------- | :------------- |
91-
| `shared_secret_file` | `SHARED_SECRET_FILE` | `string` | \***optional** |
92-
93-
\* Standalone Pomerium Core configurations do not require a `shared_secret` or `shared_secret_file`. If you don't set a shared secret, Pomerium will generate one for you.
35+
| `shared_secret` | `SHARED_SECRET` | `string` | **required** |
36+
| `shared_secret_file` | `SHARED_SECRET_FILE` | `string` | **required** |
9437

9538
:::enterprise Shared Secret in Enterprise Configurations
9639

@@ -102,30 +45,26 @@ See the [Enterprise Quickstart](/docs/enterprise/quickstart) for an example impl
10245

10346
### Examples
10447

105-
:::note
106-
107-
If you adjust your shared secret and/or how it's accessed by Pomerium, you may create a [**secret mismatch**](/docs/troubleshooting#shared-secret-mismatch).
108-
109-
:::
110-
111-
`shared_secret_file` points to a file containing the secret. This is useful when deploying in environments that provide secret management like [Docker Swarm](https://docs.docker.com/engine/swarm/secrets/).
112-
11348
To generate a key, run the following command:
11449

11550
```shell
11651
head -c32 /dev/urandom | base64
11752
```
11853

119-
Place the value in your `shared_secret_file`:
54+
Add the value to your configuration file:
12055

12156
```yaml
122-
shared_secret_file: '/run/secrets/POMERIUM_SHARED_SECRET'
57+
shared_secret: wC4RFsEdM1gHFzvRt3XW+iWw6Ddt/1kKkdh66OKxiqs=
58+
```
59+
60+
```bash
61+
SHARED_SECRET_FILE='/run/secrets/POMERIUM_SHARED_SECRET'
12362
```
12463

12564
</TabItem>
12665
<TabItem value="Enterprise" label="Enterprise">
12766

128-
`shared_secret_file` is a bootstrap configuration setting and is not configurable in the Console.
67+
`shared_secret` is a bootstrap configuration setting and is not configurable in the Console.
12968

13069
</TabItem>
13170
<TabItem value="Kubernetes" label="Kubernetes">

static/_redirects

+2-2
Original file line numberDiff line numberDiff line change
@@ -467,8 +467,8 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
467467
/docs/reference/signing-key-file /docs/reference/signing-key
468468

469469
# Shared Secret settings
470-
/docs/reference/shared-secret /docs/reference/shared-secret-settings#shared-secret
471-
/docs/reference/shared-secret-file /docs/reference/shared-secret-settings#shared-secret-file
470+
/docs/reference/shared-secret /docs/reference/shared-secret-settings
471+
/docs/reference/shared-secret-file /docs/reference/shared-secret-settings
472472

473473
# Topics links - now concepts
474474
/docs/topics/auth-logs /docs/capabilities/audit-logs

0 commit comments

Comments
 (0)