Skip to content

Commit 6a71c9a

Browse files
authored
Merge branch 'ekzhang:main' into main
2 parents dd954c9 + 03f2e53 commit 6a71c9a

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,48 @@ Similar to [localtunnel](https://github.com/localtunnel/localtunnel) and [ngrok]
2323

2424
## Installation
2525

26-
If you're on macOS, `bore` is packaged as a Homebrew core formula.
26+
### macOS
27+
28+
`bore` is packaged as a Homebrew core formula.
2729

2830
```shell
2931
brew install bore-cli
3032
```
3133

34+
### Linux
35+
36+
#### Arch Linux
37+
38+
`bore` is available in the AUR as `bore`.
39+
40+
```shell
41+
yay -S bore # or your favorite AUR helper
42+
```
43+
44+
#### Gentoo Linux
45+
46+
`bore` is available in the [gentoo-zh](https://github.com/microcai/gentoo-zh) overlay.
47+
48+
```shell
49+
sudo eselect repository enable gentoo-zh
50+
sudo emerge --sync gentoo-zh
51+
sudo emerge net-proxy/bore
52+
```
53+
54+
### Binary Distribution
55+
3256
Otherwise, the easiest way to install bore is from prebuilt binaries. These are available on the [releases page](https://github.com/ekzhang/bore/releases) for macOS, Windows, and Linux. Just unzip the appropriate file for your platform and move the `bore` executable into a folder on your PATH.
3357

58+
### Cargo
59+
3460
You also can build `bore` from source using [Cargo](https://doc.rust-lang.org/cargo/), the Rust package manager. This command installs the `bore` binary at a user-accessible path.
3561

3662
```shell
3763
cargo install bore-cli
3864
```
3965

66+
### Docker
67+
4068
We also publish versioned Docker images for each release. The image is built for an AMD 64-bit architecture. They're tagged with the specific version and allow you to run the statically-linked `bore` binary from a minimal "scratch" container.
4169

4270
```shell

0 commit comments

Comments
 (0)