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: README.md
+52-7Lines changed: 52 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,64 @@
5
5
6
6
A Docker-style CLI for pulling and pushing images directly to container registries, not via Docker daemon.
7
7
8
+
[日本語](./README_ja.md)
9
+
10
+
## Features
11
+
12
+
* Pulls and pushes container images directly to a container registry instead of via the Docker daemon.
13
+
* Provides a subset of the Docker CLI commands.
14
+
* Works with Azure CLI to authenticate to container registries.
15
+
16
+
## Usage
17
+
18
+
```
19
+
A Docker-style CLI for pulling and pushing images directly to container registries
20
+
21
+
Usage:
22
+
docksider [OPTIONS] COMMAND [ARG...]
23
+
docksider [command]
24
+
25
+
Available Commands:
26
+
help Help about any command
27
+
image Manage images
28
+
images List images
29
+
login Authenticate to a registry
30
+
pull Download an image from a registry
31
+
push Upload an image to a registry
32
+
33
+
Flags:
34
+
-h, --help help for docksider
35
+
36
+
Use "docksider [command] --help" for more information about a command.
37
+
```
38
+
39
+
## Installation
40
+
41
+
The executable for Windows platforms can be downloaded from the [Releases](https://github.com/openclosed-dev/docksider/releases) page and should be saved in a folder included in your `PATH` environment variable.
42
+
43
+
Alternatively, if you have the Golang SDK installed, you can simply run the following command to install this program in your local environment.
44
+
45
+
```shell
46
+
go install github.com/openclosed-dev/docksider/cmd/docksider@latest
47
+
```
48
+
8
49
## Configuration
9
50
10
-
Set up the environment variables in Windows.
51
+
Set the following environment variables on Windows platforms.
52
+
53
+
### `DOCKER_HOST`
11
54
12
-
| name | value |
13
-
| - | - |
14
-
| DOCKER_COMMAND | the full path to this executable including filename |
15
-
| DOCKER_HOST | the URL of the Docker daemon specified in the format `tcp://<address>:<port>`|
55
+
The URL of the Docker daemon in the format `tcp://<address>:<port>`.
16
56
17
57
Note that the Docker daemon must be up and running on the specified address and port.
18
58
19
59
See [Configure remote access for Docker daemon](https://docs.docker.com/engine/daemon/remote-access/)
20
60
61
+
### `DOCKER_COMMAND`
62
+
63
+
The full path to this executable, including the filename.
64
+
This variable is required for Azure CLI to properly find this program.
65
+
21
66
## Using with Azure Container Registry
22
67
23
68
1. Log in to your Azure container registry using Azure CLI.
@@ -27,8 +72,8 @@ See [Configure remote access for Docker daemon](https://docs.docker.com/engine/d
27
72
az acr login -n <registry>
28
73
```
29
74
30
-
2. Upload a container image to the container registry, which is retrieved from the Docker daemon.
75
+
2. Upload the container image obtained from the Docker daemon to the container registry.
0 commit comments