CProX

CProX is an easy to configure static serve, redirect, reverse proxy and load balancing web server.

• CProX
• Features
• Tested with
• Configuration
• Gettings started
  • Install
  • Help
  • Run
• Contributing
• License
• Disclaimer

Features

• Support for http, https, ws, wss and any subprotocol.
• Simple cli tool and easy envtionment variables.
• Automatically self-signed certificate if required (or disabled)!

Tested with

• node v16
• npm v8

Configuration

Please checkout the configuration guide.
But here a quick example:

cprox \
    *=STATIC:/var/www/html \
    */test=STATIC:/var/www/test \
    example.com=REDIRECT:https://www.example.com \
    www.example.com=STATIC:/var/www/example \
    www.example.com/proxy=PROXY:http://127.0.0.1:58080

Gettings started

Checkout the test.sh and the start.sh scripts to understand what you need to think about and how to start the server.

Install

npm i -g cprox

Help

Checkout the help output for a quit overview:

cprox -h

Run

Run as redirect server:

cprox *=REDIRECT:https://start.duckduckgo.com

Run as static file server:

cprox *=STATIC:/var/www/html

Run as proxy server:

cprox *=PROXY:http://127.0.0.1:8080

Cli tool help output:

Contributing

Contributions to this project are welcome!
Interested users can refer to the guidelines provided in the CONTRIBUTING.md file to contribute to the project and help improve its functionality and features.

License

This project is licensed under the MIT license, providing users with flexibility and freedom to use and modify the software according to their needs.

Disclaimer

This project is provided without warranties.
Users are advised to review the accompanying license for more information on the terms of use and limitations of liability.