Skip to content
This repository has been archived by the owner on Jun 13, 2021. It is now read-only.

Commit

Permalink
Update README with the plugin installation
Browse files Browse the repository at this point in the history
* Update windows installation too, which seems obsolete

Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>
  • Loading branch information
silvin-lubecki committed Feb 28, 2019
1 parent 463585d commit f1c7f52
Showing 1 changed file with 48 additions and 10 deletions.
58 changes: 48 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ services:
- 5678:5678
```
With `docker-app` installed let's create an Application Package based on this Compose file:
With `docker-app` [installed](#installation) let's create an Application Package based on this Compose file:

```bash
$ docker-app init --single-file hello
Expand Down Expand Up @@ -188,30 +188,68 @@ Removing network hello_default
## Installation

Pre-built binaries are available on [GitHub releases](https://github.com/docker/app/releases) for Windows, Linux and macOS.
Each tarball contains two binaries:
- `docker-app-plugin-{linux|macos|windows}` which is docker-app as a [docker cli plugin](https://github.com/docker/cli/issues/1534)
- `docker-app-standalone-{linux|macos|windows}` which is docker-app as a standalone utility

To use `docker-app` plugin, just type `docker app` instead of `docker-app` and all the examples will work the same way:
```bash
$ docker app version
Version: v0.8
Git commit: XXX
Built: Wed Feb 27 12:37:06 2019
OS/Arch: darwin/amd64
Experimental: off
Renderers: none

$ docker-app version
Version: v0.8
Git commit: XXX
Built: Wed Feb 27 12:37:06 2019
OS/Arch: darwin/amd64
Experimental: off
Renderers: none
```

### Linux or macOS

Download your OS tarball:
```bash
export OSTYPE="$(uname | tr A-Z a-z)"
curl -fsSL --output "/tmp/docker-app-${OSTYPE}.tar.gz" "https://github.com/docker/app/releases/download/v0.6.0/docker-app-${OSTYPE}.tar.gz"
tar xf "/tmp/docker-app-${OSTYPE}.tar.gz" -C /tmp/
install -b "/tmp/docker-app-${OSTYPE}" /usr/local/bin/docker-app
```

To install `docker-app` as a standalone:
```bash
install -b "/tmp/docker-app-standalone-${OSTYPE}" /usr/local/bin/docker-app
```

To install `docker-app` as a docker cli plugin:
```bash
mkdir -p ~/.docker/cli-plugins && cp "/tmp/docker-app-plugin-${OSTYPE}" ~/.docker/cli-plugins/docker-app
```

### Windows

Download the Windows tarball:
```powershell
function Expand-Tar($tarFile, $dest) {
Invoke-WebRequest -Uri https://github.com/docker/app/releases/download/v0.6.0/docker-app-windows.tar.gz -OutFile docker-app.tar.gz -UseBasicParsing
tar xf "docker-app.tar.gz"
```

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

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


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

## Single file or directory representation
Expand Down

0 comments on commit f1c7f52

Please sign in to comment.