Skip to content

Commit

Permalink
doc: Add a reference to the docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
theofidry committed Nov 2, 2023
1 parent 64ce593 commit 2003b0b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ For the full documentation see https://box-project.github.io/box.
1. [Composer](doc/installation.md#composer)
1. [Homebrew](doc/installation.md#homebrew)
1. [GitHub](doc/installation.md#github)
1. [Docker](doc/installation.md#docker)
1. [Usage](#usage)
1. [Configuration][the configuration documentation]
1. [Base path (`base-path`)](doc/configuration.md#base-path-base-path)
Expand Down
10 changes: 10 additions & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
1. [Composer](#composer)
1. [Homebrew](#homebrew)
1. [GitHub](#github)
1. [Docker](#docker)


## PHAR
Expand Down Expand Up @@ -88,6 +89,14 @@ rm box.phar.asc
chmod +x box.phar
```

## Docker

The official docker image for the project is [`boxproject/box`][docker-image]:

```shell
docker pull boxproject/box
```


<br />
<hr />
Expand All @@ -97,6 +106,7 @@ chmod +x box.phar

[releases]: https://github.com/humbug/box/releases
[composer]: https://getcomposer.org
[docker-image]: https://hub.docker.com/r/boxproject/box
[bamarni/composer-bin-plugin]: https://github.com/bamarni/composer-bin-plugin
[phive]: https://github.com/phar-io/phive
[github-release]: https://github.com/box-project/box/releases

0 comments on commit 2003b0b

Please sign in to comment.