Skip to content

Commit

Permalink
Fix Docker volume mount docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Callum027 committed Feb 11, 2023
1 parent be0ba12 commit fe328aa
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Once you have a valid configuration file, you can try Buildarr on your local mac
The following command will mount the current folder into the Docker container so `buildarr.yml` can be read, and start Buildarr in daemon mode.

```bash
$ docker run -d --name buildarr -v ./:/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest
$ docker run -d --name buildarr -v $(pwd):/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest
```

If installed using `pip`, simply run the `buildarr` CLI command.
Expand Down Expand Up @@ -196,7 +196,7 @@ Buildarr is still early in development, and even currently implemented features
If you encounter an issue or error while using Buildarr, please do a Buildarr ad-hoc run with verbose log output by executing `buildarr run --log-level DEBUG` and making an issue on [our GitHub repository](https://github.com/buildarr/buildarr/issues/new) explaining the issue and attaching the output. (Please ensure that any API keys or other sensitive information are obfuscated before submitting.)

```bash
$ docker run -d --name buildarr -v ./:/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest run --log-level DEBUG
$ docker run -d --name buildarr -v $(pwd):/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest run --log-level DEBUG
```

For developers looking to make a contribution to this project, thank you! Documentation of the internal APIs is still in the works, so for now, the best way to learn how Buildarr works is to clone the project and have a look at the comments and docstrings.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Once you have a valid configuration file, you can try Buildarr on your local mac
The following command will mount the current folder into the Docker container so `buildarr.yml` can be read, and start Buildarr in daemon mode.

```bash
$ docker run -d --name buildarr -v ./:/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest
$ docker run -d --name buildarr -v $(pwd):/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest
```

If installed using `pip`, simply run the `buildarr` CLI command.
Expand Down Expand Up @@ -194,7 +194,7 @@ Buildarr is still early in development, and even currently implemented features
If you encounter an issue or error while using Buildarr, please do a Buildarr ad-hoc run with verbose log output by executing `buildarr run --log-level DEBUG` and making an issue on [our GitHub repository](https://github.com/buildarr/buildarr/issues/new) explaining the issue and attaching the output. (Please ensure that any API keys or other sensitive information are obfuscated before submitting.)

```bash
$ docker run -d --name buildarr -v ./:/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest run --log-level DEBUG
$ docker run -d --name buildarr -v $(pwd):/config -e PUID=$(id -u) -e PGID=$(id -g) callum027/buildarr:latest run --log-level DEBUG
```

For developers looking to make a contribution to this project, thank you! Documentation of the internal APIs is still in the works, so for now, the best way to learn how Buildarr works is to clone the project and have a look at the comments and docstrings.
Expand Down

0 comments on commit fe328aa

Please sign in to comment.