Skip to content

Commit

Permalink
doc: Add installation instructions for GitHub releases (#1099)
Browse files Browse the repository at this point in the history
  • Loading branch information
theofidry authored Oct 21, 2023
1 parent 922dcaa commit b7472c2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ For the full documentation see https://box-project.github.io/box.
1. [Phive](doc/installation.md#phive)
1. [Composer](doc/installation.md#composer)
1. [Homebrew](doc/installation.md#homebrew)
1. [GitHub](doc/installation.md#github)
1. [Usage](#usage)
1. [Configuration][the configuration documentation]
1. [Base path (`base-path`)](doc/configuration.md#base-path-base-path)
Expand Down
23 changes: 23 additions & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
1. [Phive](#phive)
1. [Composer](#composer)
1. [Homebrew](#homebrew)
1. [GitHub](#github)


## PHAR
Expand Down Expand Up @@ -66,6 +67,28 @@ To upgrade `box` use the following command:
$ brew upgrade box
```

## GitHub

You may download the Box PHAR directly from the [GitHub release][github-release] directly.
You should however beware that it is not as secure as downloading it from the other mediums.
Hence, it is recommended to check the signature when doing so:

```
# Do adjust the URL based on the latest release
wget -O box.phar "https://github.com/box-project/box/releases/download/4.4.0/box.phar"
wget -O box.phar.asc "https://github.com/box-project/box/releases/download/4.4.0/box.phar.asc"
# Check that the signature matches
gpg --verify box.phar.asc box.phar
# Check the issuer (the ID can also be found from the previous command)
gpg --keyserver hkps://keys.openpgp.org --recv-keys 41539BBD4020945DB378F98B2DF45277AEF09A2F
rm box.phar.asc
chmod +x box.phar
```


<br />
<hr />

Expand Down

0 comments on commit b7472c2

Please sign in to comment.