mirror of
https://github.com/ekzhang/bore.git
synced 2025-12-15 19:37:47 +01:00
Merge branch 'ekzhang:main' into main
This commit is contained in:
30
README.md
30
README.md
@@ -23,20 +23,48 @@ Similar to [localtunnel](https://github.com/localtunnel/localtunnel) and [ngrok]
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
If you're on macOS, `bore` is packaged as a Homebrew core formula.
|
### macOS
|
||||||
|
|
||||||
|
`bore` is packaged as a Homebrew core formula.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
brew install bore-cli
|
brew install bore-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
#### Arch Linux
|
||||||
|
|
||||||
|
`bore` is available in the AUR as `bore`.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
yay -S bore # or your favorite AUR helper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Gentoo Linux
|
||||||
|
|
||||||
|
`bore` is available in the [gentoo-zh](https://github.com/microcai/gentoo-zh) overlay.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
sudo eselect repository enable gentoo-zh
|
||||||
|
sudo emerge --sync gentoo-zh
|
||||||
|
sudo emerge net-proxy/bore
|
||||||
|
```
|
||||||
|
|
||||||
|
### Binary Distribution
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
### Cargo
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
cargo install bore-cli
|
cargo install bore-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
Reference in New Issue
Block a user