Skip to content

Commit

Permalink
Merge pull request #296 from PhrozenByte/patch-1
Browse files Browse the repository at this point in the history
docs: Add wrapper script for container installs
  • Loading branch information
bgilbert authored Jan 7, 2022
2 parents 42dcb91 + e14834e commit 82a49c5
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,25 @@ podman run --rm -v /path/to/your_config.bu:/config.bu:z quay.io/coreos/butane:re
You may also add the following alias in your shell configuration:

```
alias butane='podman run --rm --interactive \
--security-opt label=disable \
--volume ${PWD}:/pwd --workdir /pwd \
alias butane='podman run --rm --interactive \
--security-opt label=disable \
--volume "${PWD}":/pwd --workdir /pwd \
quay.io/coreos/butane:release'
```

Alternatively you may also create a wrapper script at `~/.local/bin/butane`:

```bash
#!/bin/sh
exec podman run --rm --interactive \
--security-opt label=disable \
--volume "${PWD}":/pwd --workdir /pwd \
quay.io/coreos/butane:release \
"${@}"
```

Make sure that `~/.local/bin` is in your `$PATH`, or choose another path like `/usr/local/bin`.

#### Distribution packages

`butane` is available from the Fedora package repositories:
Expand Down

0 comments on commit 82a49c5

Please sign in to comment.