You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/docs/reference/shared-secret.mdx
+81-14
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
---
2
-
id: shared-secret
3
-
title: Shared Secret
4
-
description: |
5
-
Shared Secret is the base64 encoded 256-bit key used to mutually authenticate requests between services.
2
+
id: shared-secret-settings
3
+
title: Shared Secret Settings
4
+
description: This page discusses shared secret settings in Pomerium, which are used to mutually authenticate requests between Pomerium services.
6
5
keywords:
7
6
- reference
8
7
- Shared Secret
@@ -14,33 +13,39 @@ toc_max_heading_level: 2
14
13
importTabsfrom'@theme/Tabs';
15
14
importTabItemfrom'@theme/TabItem';
16
15
17
-
# Shared Secret
16
+
# Shared Secret Settings
18
17
19
-
## Summary
18
+
## Shared Secret
20
19
21
-
**Shared Secret** is the base64-encoded, 256-bit key used to mutually authenticate requests between services. It's critical that secret keys are random, and stored safely.
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.
\* 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.
33
32
34
-
Pomerium Core configurations do not require a `shared_secret` or `shared_secret_file`. You only need to include a shared secret if you are running the Console.
33
+
:::enterprise Shared Secret in Enterprise Configurations
35
34
36
-
If you are connecting to the Console, your Pomerium Core and Console configurations require the same shared secret.
35
+
If you're connecting to the [Enterprise Console](/docs/enterprise), your Pomerium Core and Enterprise configurations each require the same shared secret.
37
36
38
-
See the [**Enterprise Quickstart**](/docs/enterprise/quickstart) for an example implementation.
37
+
See the [Enterprise Quickstart](/docs/enterprise/quickstart) for an example implementation.
39
38
40
39
:::
41
40
42
41
### Examples
43
42
43
+
:::note
44
+
45
+
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).
|`secrets.shared_secret`|`string`|**required** (unless using [shared_secret_file](/docs/reference/shared-secret-file)) |
75
+
|`secrets.shared_secret`|`string`|**required**|
76
+
77
+
See Kubernetes [bootstrap secrets](/docs/k8s/reference#spec) for more information.
78
+
79
+
</TabItem>
80
+
</Tabs>
81
+
82
+
## Shared Secret File
83
+
84
+
**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.
\* 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.
96
+
97
+
:::enterprise Shared Secret in Enterprise Configurations
98
+
99
+
If you're connecting to the [Enterprise Console](/docs/enterprise), your Pomerium Core and Enterprise configurations each require the same shared secret.
100
+
101
+
See the [Enterprise Quickstart](/docs/enterprise/quickstart) for an example implementation.
102
+
103
+
:::
104
+
105
+
### Examples
106
+
107
+
:::note
108
+
109
+
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).
110
+
111
+
:::
112
+
113
+
`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/).
Copy file name to clipboardexpand all lines: content/docs/troubleshooting.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,7 @@ Events:
148
148
149
149
### Shared Secret Mismatch
150
150
151
-
Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret). When services or the databroker have mismatched secrets, Pomerium will fail.
151
+
Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret). When Pomerium services share a mismatched secret, or these services share a secret that is not the same secret set in the Databroker service, Pomerium will fail.
152
152
153
153
Pomerium Core will log a shared secret mismatch with:
154
154
@@ -163,7 +163,7 @@ Pomerium Core will log a shared secret mismatch with:
163
163
}
164
164
```
165
165
166
-
And Pomerium Enterprise will log the error with:
166
+
Pomerium Enterprise will log a shared secret mismatch with:
0 commit comments