Skip to content

Commit 623f3f8

Browse files
committed
feat: documentation for docker-pass CLI plugin
1 parent 64afb7e commit 623f3f8

File tree

7 files changed

+128
-0
lines changed

7 files changed

+128
-0
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass
4+
title: docker pass
5+
layout: cli
6+
aliases:
7+
- /engine/reference/commandline/pass/
8+
---
9+
10+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
command: docker pass
2+
short: Manage your local OS keychain secrets.
3+
long: |-
4+
Docker Pass is a helper that allows you to store secrets securely in your local OS keychain and inject them into containers later.
5+
6+
On Windows: Uses the Windows Credential Manager API.
7+
8+
On macOS: Uses macOS Keychain services API.
9+
10+
On Linux: `org.freedesktop.secrets` API (requires DBus + gnome-keyring/kdewallet to be installed).
11+
12+
13+
usage: docker pass set|get|ls|rm
14+
pname: docker
15+
plink: docker.yaml
16+
cname:
17+
- docker pass set
18+
- docker pass get
19+
- docker pass ls
20+
- docker pass rm
21+
clink:
22+
- docker_pass_set.yaml
23+
- docker_pass_get.yaml
24+
- docker_pass_ls.yaml
25+
- docker_pass_rm.yaml
26+
deprecated: false
27+
experimental: true
28+
experimentalcli: true
29+
kubernetes: false
30+
swarm: false
31+
examples: |-
32+
### Using keychain secrets in containers
33+
34+
Create a secret:
35+
36+
```console
37+
$ docker pass set GH_TOKEN=123456789
38+
```
39+
40+
Creating a secret from STDIN:
41+
42+
```console
43+
echo 123456789 > token.txt
44+
cat token.txt | docker pass set GH_TOKEN
45+
```
46+
47+
Run a container that uses the secret:
48+
49+
```console
50+
$ docker run -e GH_TOKEN= -dt --name demo busybox
51+
```
52+
53+
Inspect your secret from inside the container
54+
55+
```console
56+
$ docker debug demo
57+
...
58+
docker > echo $GH_TOKEN
59+
123456789
60+
```
61+
62+
Explicitly assigning a secret to another environment variable:
63+
64+
```console
65+
$ docker run -e GITHUB_TOKEN=se://GH_TOKEN -dt --name demo busybox
66+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass get
2+
short: Get a secret
3+
usage: docker pass get <name>
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass ls
2+
short: List secrets
3+
usage: docker pass ls
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass rm
2+
short: Remove a secret
3+
usage: docker pass rm <name>
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
command: docker pass set
2+
short: Set a secret
3+
usage: docker pass set <name>=<value>
4+
long: |-
5+
Secrets can also be created from STDIN:
6+
```console
7+
<some command> | docker pass set <name>
8+
```
9+
pname: docker pass
10+
plink: docker_pass.yaml
11+
deprecated: false
12+
hidden: false
13+
experimental: true
14+
experimentalcli: true
15+
kubernetes: false
16+
swarm: false

data/summary.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,9 @@ Docker MCP Catalog:
182182
availability: Beta
183183
Docker MCP Toolkit:
184184
availability: Beta
185+
Docker Pass:
186+
requires: Docker Desktop 4.54 and later
187+
availability: Beta
185188
Docker Projects:
186189
availability: Beta
187190
Docker Sandboxes:

0 commit comments

Comments
 (0)