tuxmain/rust-rpxy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix readme

Browse source
This commit is contained in:
Jun Kurihara 2022-08-02 11:04:10 +09:00
commit 44bfae6cc7
No known key found for this signature in database
GPG key ID: 48ADFD173ED22B03
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -5,7 +5,7 @@
![Build and Publish Docker](https://github.com/junkurihara/rust-rpxy/actions/workflows/docker_build_push.yml/badge.svg) ![Build and Publish Docker](https://github.com/junkurihara/rust-rpxy/actions/workflows/docker_build_push.yml/badge.svg)
![ShiftLeft Scan](https://github.com/junkurihara/rust-rpxy/actions/workflows/shift_left.yml/badge.svg) ![ShiftLeft Scan](https://github.com/junkurihara/rust-rpxy/actions/workflows/shift_left.yml/badge.svg)
**WIP Project** > **WIP Project**
## Introduction ## Introduction
@ -66,13 +66,13 @@ reverse_proxy = [{ upstream = [{ location = 'app1.local:8080' }] }]
In the above setting, `rpxy` listens on port 80 (TCP) and serves incoming cleartext HTTP request including a `app1.example.com` in its HOST header or URL in its Request line. In the above setting, `rpxy` listens on port 80 (TCP) and serves incoming cleartext HTTP request including a `app1.example.com` in its HOST header or URL in its Request line.
For example, request messages like the followings. For example, request messages like the followings.
``` ```http
GET http://app1.example.com/path/to HTTP/1.1\r\n GET http://app1.example.com/path/to HTTP/1.1\r\n
``` ```
or or
``` ```http
GET /path/to HTTP/1.1\r\n GET /path/to HTTP/1.1\r\n
HOST: app1.example.com\r\n HOST: app1.example.com\r\n
``` ```
@ -99,8 +99,10 @@ Here we note that by specifying `default_application` entry, *HTTP* requests wil
The request message will be routed to the backend application specified with the domain name `app1.localdomain:8080` or IP address over cleartext HTTP. If the backend channel needs to serve TLS like forwarding to `https://app1.localdomain:8080`, you need to enable a `tls` option for the location. The request message will be routed to the backend application specified with the domain name `app1.localdomain:8080` or IP address over cleartext HTTP. If the backend channel needs to serve TLS like forwarding to `https://app1.localdomain:8080`, you need to enable a `tls` option for the location.
``` ```toml
revese_proxy = [
{ location = 'app1.localdomain:8080', tls = true } { location = 'app1.localdomain:8080', tls = true }
]
``` ```
#### Load Balancing #### Load Balancing
@ -231,6 +233,7 @@ Other than them, all you need is to mount your `config.toml` as `/etc/rpxy.toml`
If you obtain certificates and private keys from [Let's Encrypt](https://letsencrypt.org/), you have PKCS1-formatted private keys. So you need to convert such retrieved private keys into PKCS8 format to use in `rpxy`. If you obtain certificates and private keys from [Let's Encrypt](https://letsencrypt.org/), you have PKCS1-formatted private keys. So you need to convert such retrieved private keys into PKCS8 format to use in `rpxy`.
The most easiest way is to use `openssl` by The most easiest way is to use `openssl` by
```bash ```bash
openssl pkcs8 -topk8 -nocrypt \ openssl pkcs8 -topk8 -nocrypt \
-in yoru_domain_from_le.key \ -in yoru_domain_from_le.key \
@ -243,7 +246,6 @@ openssl pkcs8 -topk8 -nocrypt \
todo! todo!
## License ## License
`rpxy` is free, open-source software licensed under MIT License. `rpxy` is free, open-source software licensed under MIT License.