Skip to content

Commit 031c77c

Browse files
committed
Add part about docker-box-script.sh
Signed-off-by: Joern Bernhardt <[email protected]>
1 parent f72b2c8 commit 031c77c

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

Diff for: README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Set up aliases in `.*rc` file:
2323
```
2424
alias mountbox="${HOME}/.docker-box/docker-box-static-mount.sh"
2525
alias box="${HOME}/.docker-box/docker-box.sh"
26+
alias boxed="${HOME}/.docker-box/docker-box-script.sh"
2627
alias dr="${HOME}/.docker-box/docker-box-run.sh"
2728
```
2829

@@ -34,19 +35,21 @@ For example:
3435
```
3536
alias mountbox="DOCKER_BOX_APPS_PATH=${HOME}/.docker-box-apps ${HOME}/.docker-box/docker-box-static-mount.sh"
3637
alias box="DOCKER_BOX_APPS_PATH=${HOME}/.docker-box-apps ${HOME}/.docker-box/docker-box.sh"
38+
alias boxed="DOCKER_BOX_APPS_PATH=${HOME}/.docker-box-apps ${HOME}/.docker-box/docker-box-script.sh"
3739
alias dr="${HOME}/.docker-box/docker-box-run.sh"
3840
```
3941

4042
## Usage
4143

42-
There are three different use-cases currently to share data between your
44+
There are four different use-cases currently to share data between your
4345
sandboxed app (= the untrusted thing you want to run) and the host (= your
44-
computer). If you have installed the three aliases as mentioned above, those
46+
computer). If you have installed the four aliases as mentioned above, those
4547
will match:
4648

4749
1. Having the current working directory in your container (= `box`)
48-
2. Have a static mount in your container (= `mountbox`)
49-
3. Run the current directory like a docker container (for development) (= `dr`)
50+
2. Having the current working directory in your container and run it non-interactively (= `boxed`)
51+
3. Have a static mount in your container (= `mountbox`)
52+
4. Run the current directory like a docker container (for development) (= `dr`)
5053

5154
### 1. Mount the current working directory into `/app`
5255

@@ -57,7 +60,17 @@ box youtube-dl ...
5760
Would download the URL you passed as argument into the current directory
5861
through `youtube-dl`.
5962

60-
### 2. Mount a static sandbox directory into `/app`
63+
### 1. Mount the current working directory into `/app`
64+
65+
```
66+
boxed pdf-document-feeder my-scanned-document.pdf my-scanned-document-sorted.pdf
67+
```
68+
69+
Would sort `my-scanned-document.pdf` when you used a PDF feeder without duplex
70+
to scan it. It will not attach a terminal to it, so it could run, for example,
71+
in Automator scripts.
72+
73+
### 3. Mount a static sandbox directory into `/app`
6174

6275
```
6376
mountbox youtube-dl ...
@@ -66,7 +79,7 @@ mountbox youtube-dl ...
6679
This will use the `sandbox` subdirectory below the `docker-box` scripts, thus
6780
downloading into that directory when using the `youtube-dl` docker-box-app.
6881

69-
### 3. Directly run the current directory with a Dockerfile inside a container
82+
### 4. Directly run the current directory with a Dockerfile inside a container
7083

7184
```
7285
dr cargo run --help

0 commit comments

Comments
 (0)