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

Commit 49b5695

Browse files
author
Mike Parker
committed
Updates README.md to cover attachments functionality
Signed-off-by: Mike Parker <michael.parker@docker.com>
1 parent 6d16347 commit 49b5695

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,29 +177,35 @@ $ docker-app helm --stack-version=v1beta1
177177

178178
## Single file or directory representation
179179

180-
If you prefer having the three documents in separate YAML files, omit the `-s` option to
181-
the `docker-app init` command. This will create a directory instead of a singe file, containing
180+
If you prefer having the three core documents in separate YAML files, omit the `-s` / `--single-file` option to
181+
the `docker-app init` command. This will create a directory instead of a single file, containing
182182
`metadata.yml`, `docker-compose.yml` and `settings.yml`.
183183

184184
Converting between the two formats can be achieved by using the `docker-app split` and `docker-app merge` commands.
185185

186+
Note that you cannot store attachments in the single file format. If you want to use attachments you should use the directory format.
187+
188+
## Attachments (Storing additional files)
189+
190+
If you want to store additional files in the application package, such as `prod.yml`, `test.yml` or other config files, use the directory format and simply place these files inside the *.dockerapp/ directory. These will be bundled into the package when using `docker-app push`
191+
186192
## Sharing your application on the Hub
187193

188194
You can push any application to the Hub using `docker-app push`:
189195

190196
``` bash
191-
$ docker-app push --namespace myHubUser --tag latest
197+
$ docker-app push --namespace myhubuser --tag latest
192198
```
193199

194-
This command will push to the Hub an image named `myHubUser/hello.dockerapp:latest`.
200+
This command will push to the Hub an image named `myhubuser/hello.dockerapp:latest`.
195201

196-
By default, this command uses the application version defined in `metadata.yml` as the tag,
197-
and the value of the metadata field `namespace` as the image namespace.
202+
If you omit the `--tag latest` argument, this command uses the application `version` defined in `metadata.yml` as the tag.
203+
If you omit the `--namespace myhubuser` argument, this command uses the application `namespace` defined in `metadata.yml` as the image namespace.
198204

199205
All `docker-app` commands accept an image name as input, which means you can run on a different host:
200206

201207
``` bash
202-
$ docker-app inspect myHubUser/hello
208+
$ docker-app inspect myhubuser/hello
203209
```
204210

205211
## Forking an existing image

0 commit comments

Comments
 (0)