rProx

A very basic reverse proxy in Rust
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

This is a basic reverse proxy, with hotreloading, and the abiltiy to write middleware in Golang*

*Not yet implemented

(back to top)

Built With

• Rust
• Hyper
• Tokio
• Goscript

(back to top)

Getting Started

Prerequisites

• Rust - Install with rustup

Installation

1. Clone the repo

   $ git clone https://github.com/nyxkrage/rprox.git

2. Build with Cargo

   $ cargo build

3. Run the project

   $ cargo run

(back to top)

Usage

See test.yaml for an example configuration

(back to top)

Roadmap

• HTTP proxying
• HTTPS with Rustls
• Middleware with Goscript
• CLI Argument parsing
• hotreloading of config file

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)