update readme
This commit is contained in:
parent
50efe29100
commit
aa2cf99358
2 changed files with 27 additions and 4 deletions
30
README.md
30
README.md
|
|
@ -17,15 +17,34 @@
|
||||||
|
|
||||||
[^1]: We should note that NGINX doesn't guarantee such a consistency by default. To this end, you have to add `if` statement in the configuration file in NGINX.
|
[^1]: We should note that NGINX doesn't guarantee such a consistency by default. To this end, you have to add `if` statement in the configuration file in NGINX.
|
||||||
|
|
||||||
## Making an executable binary
|
## Installing/Building an executable binary of `rpxy`
|
||||||
|
|
||||||
|
<!-- ### From `crates.io`
|
||||||
|
|
||||||
|
The simplest way is to install from [`crates.io`](https://crates.io/crates/rpxy) as follows.
|
||||||
|
|
||||||
```:bash
|
```:bash
|
||||||
|
% cargo install rpxy
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you have an executive binary `~/.cargo/bin/rpxy`.
|
||||||
|
|
||||||
|
Alternatively, y -->
|
||||||
|
You can build an executable binary yourself by checking out this Git repository.
|
||||||
|
|
||||||
|
```:bash
|
||||||
|
# Cloning the git repository
|
||||||
|
% git clone https://github.com/junkurihara/rust-rpxy
|
||||||
|
% cde rust-rpxy
|
||||||
|
|
||||||
|
# Update submodule hyperium/h3
|
||||||
|
% git submodule update --init
|
||||||
|
|
||||||
|
# Build
|
||||||
% cargo build --release
|
% cargo build --release
|
||||||
```
|
```
|
||||||
|
|
||||||
Then you have a binary at `./target/release/rpxy`.
|
Then you have an executive binary `rust-rpxy/target/release/rpxy`.
|
||||||
|
|
||||||
You can also use [`docker` image](https://hub.docker.com/r/jqtype/rpxy) instead of building from the source.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
@ -37,4 +56,7 @@ todo!
|
||||||
|
|
||||||
## Using `docker` image
|
## Using `docker` image
|
||||||
|
|
||||||
|
You can also use [`docker` image](https://hub.docker.com/r/jqtype/rpxy) instead of directly executing the binary.
|
||||||
|
|
||||||
|
|
||||||
todo!
|
todo!
|
||||||
|
|
|
||||||
1
TODO.md
1
TODO.md
|
|
@ -5,4 +5,5 @@
|
||||||
- Smaller footprint of docker image using musl
|
- Smaller footprint of docker image using musl
|
||||||
- Refactoring
|
- Refactoring
|
||||||
- Options to serve custom http_error page.
|
- Options to serve custom http_error page.
|
||||||
|
- Prometheus metrics
|
||||||
- etc.
|
- etc.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue