From a67625cb9c53e1a298560d5b8b8d8cf650d5867b Mon Sep 17 00:00:00 2001 From: Jun Kurihara Date: Thu, 19 Sep 2024 11:25:48 +0900 Subject: [PATCH] update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 274a096..2569555 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ By default, `rpxy` provides the *TLS connection sanitization* by correctly bindi ## Installing/Building an Executable Binary of `rpxy` +### Building from Source + You can build an executable binary yourself by checking out this Git repository. ```bash @@ -45,6 +47,12 @@ Then you have an executive binary `rust-rpxy/target/release/rpxy`. Note that we do not have an option of installation via [`crates.io`](https://crates.io/), i.e., `cargo install`, at this point since some dependencies are not published yet. Alternatively, you can use docker image (see below) as the easiest way for `amd64` environment. +### Package Installation for Linux (RPM/DEB) + +You can found the Jenkins CI/CD build scripts for `rpxy` in the [./build](./build) directory. + +Prebuilt packages for Linux RPM and DEB are available at [https://rpxy.gamerboy59.dev](https://rpxy.gamerboy59.dev), provided by [@Gamerboy59](https://github.com/Gamerboy59). + ## Usage `rpxy` always refers to a configuration file in TOML format, e.g., `config.toml`. You can find an example of the configuration file, `config-example.toml`, in this repository.