Skip to content

Commit d8cac8d

Browse files
committed
Add new sections including installation to README
1 parent cc75388 commit d8cac8d

2 files changed

Lines changed: 130 additions & 7 deletions

File tree

README.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,64 @@
55

66
A Docker-style CLI for pulling and pushing images directly to container registries, not via Docker daemon.
77

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+
849
## Configuration
950

10-
Set up the environment variables in Windows.
51+
Set the following environment variables on Windows platforms.
52+
53+
### `DOCKER_HOST`
1154

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>`.
1656

1757
Note that the Docker daemon must be up and running on the specified address and port.
1858

1959
See [Configure remote access for Docker daemon](https://docs.docker.com/engine/daemon/remote-access/)
2060

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+
2166
## Using with Azure Container Registry
2267

2368
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
2772
az acr login -n <registry>
2873
```
2974

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.
3176

3277
```shell
33-
docksider push <registry>/<image>:<tag>
78+
docksider push <registry>.azurecr.io/<image>:<tag>
3479
```

README_ja.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Docksider
2+
3+
[![Build](https://github.com/openclosed-dev/docksider/actions/workflows/build.yml/badge.svg)](https://github.com/openclosed-dev/docksider/actions/workflows/build.yml)
4+
[![Release](https://img.shields.io/github/release/openclosed-dev/docksider/all.svg)](https://github.com/openclosed-dev/docksider/releases)
5+
6+
7+
Dockerデーモン経由ではなく、コンテナレジストリにイメージを直接プルおよびプッシュするためのDockerスタイルのCLI。
8+
9+
## 特徴
10+
11+
* Docker デーモン経由ではなく、コンテナイメージをコンテナレジストリに直接プルおよびプッシュします。
12+
* Docker CLI コマンドのサブセットを提供します。
13+
* Azure CLI と連携してコンテナレジストリに認証します。
14+
15+
## 使い方
16+
17+
```
18+
A Docker-style CLI for pulling and pushing images directly to container registries
19+
20+
Usage:
21+
docksider [OPTIONS] COMMAND [ARG...]
22+
docksider [command]
23+
24+
Available Commands:
25+
help Help about any command
26+
image Manage images
27+
images List images
28+
login Authenticate to a registry
29+
pull Download an image from a registry
30+
push Upload an image to a registry
31+
32+
Flags:
33+
-h, --help help for docksider
34+
35+
Use "docksider [command] --help" for more information about a command.
36+
```
37+
38+
## インストール
39+
40+
Windows用の実行ファイルは、[Releases](https://github.com/openclosed-dev/docksider/releases) ページからダウンロードでき、`PATH` 環境変数に含まれるフォルダに保存する必要があります。
41+
42+
あるいは、Go言語のSDKがインストールされている場合は、次のコマンドを実行するだけで、このプログラムをローカル環境にインストールできます。
43+
44+
```shell
45+
go install github.com/openclosed-dev/docksider/cmd/docksider@latest
46+
```
47+
48+
## 設定
49+
50+
Windowsで次の環境変数を設定します。
51+
52+
### `DOCKER_HOST`
53+
54+
Docker デーモンの URL。形式は`tcp://<address>:<port>`
55+
56+
指定されたアドレスとポートで Dockerデーモンが起動して実行されている必要があることに注意してください。
57+
58+
[Configure remote access for Docker daemon](https://docs.docker.com/engine/daemon/remote-access/)を参照してください。
59+
60+
### `DOCKER_COMMAND`
61+
62+
この実行可能ファイルへのフルパス。ファイル名を含みます。
63+
この変数は、Azure CLIがこのプログラムを正しく検出するために必要です。
64+
65+
## Azure Container Registryと使う
66+
67+
1. Azure CLIを使用して Azureコンテナレジストリにログインします。
68+
69+
```shell
70+
az login
71+
az acr login -n <registry>
72+
```
73+
74+
2. Dockerデーモンから取得したコンテナ イメージをコンテナレジストリにアップロードします。
75+
76+
```shell
77+
docksider push <registry>.azurecr.io/<image>:<tag>
78+
```

0 commit comments

Comments
 (0)