There are two ways to use proxen: - The simple way is to type proxen . Each subcommand corresponds to one feature of the program.
- The other way is to use a config file. You can name that file however you want. It is a Json file. Here is how to use it:
proxen -f or proxen --file
The advantage of using the config file, is that you can exploit all the available features, in one call. And you can call each feature several time in the file.
proxen as a reverse proxy
This feature allows you to forward all requests from an input port, to an output port. So no more need for NGNX in simple cases ! The input port must be free, so that proxen can listen on it. You can also ask proxen to secure its server, by passing paths to a key and a cert file.
$3
- HTTP without ssl or tls `sh proxen rprox `
- Secured HTTP
`sh proxen rprox `
$3
Add the field "rprox" to the root object of the file.
`json { "rprox": { "": { "key": "", // You certificate files must cover all the provided domains ! "cert": "", "hosts": { "": "`
- Example 5 (All previous cases together)
`json { "rprox": { "": "`
proxen as a redirection server
This feature allows you to explicitly redirect clients from a source port to another port or url. The redirection is performed through a "301" HTTP response code. The source port must be free, so that proxen can listen on it. You can also provide paths to a cert and a key file, to make the connection secure.
In the examples below, the destination (dest) can be:
- A port number:
In this case, the redirection preserves: - the protocol - the domain - the path - the querystring
Only the the port changes
- The string "http" (lowercase):
In this case, the redirection preserves: - the domain - the path - the querystring
The protocol is set to "HTTP", and the port is set to 80.
- The string "https" (lowercase):
Works like the previous case. But the protocol is set to "HTTPS", and the port to 443.
- A custom url:
This allows you to redirect requests wherever you want. If you want to use some parts of the original request in the destination url, you can use the following variables in your url string: - {protocol} -> Will be replaced by the original request's protocol - {domain} -> Will be replaced by the original domain - {port} -> The original port - {path} -> Original path - {query} -> Original querystring
Example:
`sh proxen red 1555 https://blabla.com:{port}/custom/path{query} # Only preserves port and querystring `
$3
- Without ssl or tls `sh proxen red `
- Secured HTTP
`sh proxen red ``
$3
Not yet implemented Will be available in version 3.1.5 Expected release date: May 5 2022
proxen as a proxy
This feature will allow you to access any resource on the web, using your server as a proxy
Not yet implemented. Will be available in version 3.2.0 Expected release date: May 30 2022
proxen as a download server
This feature will allow you to download any resource on your server, until you are ready to download it on your local machine. It can be very useful when the resource will not remain available for a long time, but you can't immediately download it because of a poor internet connection, or lack of disk space on your local machine
Not yet implemented. Will be available in version 3.3.0 Expected release date: June 30 2022
proxen as a static file server
This feature will allow you to statically serve files from any directory
Not yet implemented. Will be available in version 4.0.0 Expected release date: September 15 2022
proxen as an in-browser file explorer
This feature will allow you to serve an in-browser file explorer on your server or your local machine. Authorized people in your network will be able to upload, download, copy, paste, etc...
Not yet implemented. Will be available in version 5.0.0 Expected release date: December 31 2022