embarklabs
/
embark-docker
mirror of https://github.com/embarklabs/embark-docker.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

should refer to `run_embark` vs. `run.sh` in some places

This commit is contained in:
Michael Bradley, Jr 2018-08-02 14:12:15 -05:00
parent eaf05016fb
commit 94d4493a78
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -17,9 +17,10 @@ the docker host's `$PWD`.
[`run.sh`](https://github.com/embark-framework/embark-docker/blob/master/run.sh) [`run.sh`](https://github.com/embark-framework/embark-docker/blob/master/run.sh)
is a Bash script that simplifies usage of the embark container: publishing is a Bash script that simplifies usage of the embark container: publishing
ports, bind mounting a host volume, and so on. ports, bind mounting a host volume, and so on. The script exports a shell
function named `run_embark`.
Many aspects of the script's behavior can be overridden with environment Many aspects of `run_embark`'s behavior can be overridden with environment
variables, and that approach can be (optionally) combined with `docker build`: variables, and that approach can be (optionally) combined with `docker build`:
``` shell ``` shell
@ -62,7 +63,7 @@ EMBARK_DOCKER_RUN_OPTS_REPLACE=true
run_embark [docker-run-opts] -- [command] run_embark [docker-run-opts] -- [command]
``` ```
By default `run.sh` invokes `docker run` with the By default `run_embark` invokes `docker run` with the
[`--rm`](https://docs.docker.com/engine/reference/run/#clean-up---rm) option, [`--rm`](https://docs.docker.com/engine/reference/run/#clean-up---rm) option,
making the embark container ephemeral, i.e. it will not persist on the docker making the embark container ephemeral, i.e. it will not persist on the docker
host's file system after the container exits. To override this behavior: host's file system after the container exits. To override this behavior:
@ -223,7 +224,7 @@ SCRIPT
' '
``` ```
Since `run.sh` mounts the docker host's `$PWD` into the container's `/dapp`, and Since `run_embark` mounts the docker host's `$PWD` into the container's `/dapp`, and
since `/dapp` is the container's default working directory, it's also possible since `/dapp` is the container's default working directory, it's also possible
to do: to do: