Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit eee6fb5

Browse files
silvin-lubeckichris-crone
authored andcommitted
Update README with the plugin installation
* Update windows installation too, which seems obsolete Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
1 parent 3930fe7 commit eee6fb5

1 file changed

Lines changed: 48 additions & 10 deletions

File tree

README.md

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ services:
3131
- 5678:5678
3232
```
3333
34-
With `docker-app` installed let's create an Application Package based on this Compose file:
34+
With `docker-app` [installed](#installation) let's create an Application Package based on this Compose file:
3535

3636
```bash
3737
$ docker-app init --single-file hello
@@ -187,30 +187,68 @@ Removing network hello_default
187187
## Installation
188188

189189
Pre-built binaries are available on [GitHub releases](https://github.com/docker/app/releases) for Windows, Linux and macOS.
190+
Each tarball contains two binaries:
191+
- `docker-app-plugin-{linux|macos|windows}` which is docker-app as a [docker cli plugin](https://github.com/docker/cli/issues/1534)
192+
- `docker-app-standalone-{linux|macos|windows}` which is docker-app as a standalone utility
193+
194+
To use `docker-app` plugin, just type `docker app` instead of `docker-app` and all the examples will work the same way:
195+
```bash
196+
$ docker app version
197+
Version: v0.8
198+
Git commit: XXX
199+
Built: Wed Feb 27 12:37:06 2019
200+
OS/Arch: darwin/amd64
201+
Experimental: off
202+
Renderers: none
203+
204+
$ docker-app version
205+
Version: v0.8
206+
Git commit: XXX
207+
Built: Wed Feb 27 12:37:06 2019
208+
OS/Arch: darwin/amd64
209+
Experimental: off
210+
Renderers: none
211+
```
190212

191213
### Linux or macOS
192214

215+
Download your OS tarball:
193216
```bash
194217
export OSTYPE="$(uname | tr A-Z a-z)"
195218
curl -fsSL --output "/tmp/docker-app-${OSTYPE}.tar.gz" "https://github.com/docker/app/releases/download/v0.6.0/docker-app-${OSTYPE}.tar.gz"
196219
tar xf "/tmp/docker-app-${OSTYPE}.tar.gz" -C /tmp/
197-
install -b "/tmp/docker-app-${OSTYPE}" /usr/local/bin/docker-app
220+
```
221+
222+
To install `docker-app` as a standalone:
223+
```bash
224+
install -b "/tmp/docker-app-standalone-${OSTYPE}" /usr/local/bin/docker-app
225+
```
226+
227+
To install `docker-app` as a docker cli plugin:
228+
```bash
229+
mkdir -p ~/.docker/cli-plugins && cp "/tmp/docker-app-plugin-${OSTYPE}" ~/.docker/cli-plugins/docker-app
198230
```
199231

200232
### Windows
233+
234+
Download the Windows tarball:
201235
```powershell
202-
function Expand-Tar($tarFile, $dest) {
236+
Invoke-WebRequest -Uri https://github.com/docker/app/releases/download/v0.6.0/docker-app-windows.tar.gz -OutFile docker-app.tar.gz -UseBasicParsing
237+
tar xf "docker-app.tar.gz"
238+
```
203239

204-
if (-not (Get-Command Expand-7Zip -ErrorAction Ignore)) {
205-
Install-Package -Scope CurrentUser -Force 7Zip4PowerShell > $null
206-
}
240+
To install `docker-app` as a standalone, copy it somewhere in your path:
241+
```powershell
242+
cp docker-app-plugin-windows.exe PATH/docker-app.exe
243+
```
207244

208-
Expand-7Zip $tarFile $dest
209-
}
210-
Invoke-WebRequest -Uri https://github.com/docker/app/releases/download/v0.6.0/docker-app-windows.tar.gz
211-
Expand-Tar docker-app-windows.tar.gz docker-app-windows.exe
245+
To install `docker-app` as a docker cli plugin:
246+
```powershell
247+
New-Item -ItemType Directory -Path ~/.docker/cli-plugins -ErrorAction SilentlyContinue
248+
cp docker-app-plugin-windows.exe ~/.docker/cli-plugins/docker-app.exe
212249
```
213250

251+
214252
**Note:** To use Application Packages as images (i.e.: `save`, `push`, or `install` when package is not present locally) on Windows, one must be in Linux container mode.
215253

216254
## Single file or directory representation

0 commit comments

Comments
 (0)