Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesmoriarty/forward-proxy
Minimal HTTP(S) forward proxy using 150LOC and only standard libraries.
https://github.com/jamesmoriarty/forward-proxy
forward-proxy forwardproxy http http-connect http-proxy https proxy proxy-server ruby tinycode
Last synced: 7 days ago
JSON representation
Minimal HTTP(S) forward proxy using 150LOC and only standard libraries.
- Host: GitHub
- URL: https://github.com/jamesmoriarty/forward-proxy
- Owner: jamesmoriarty
- License: mit
- Created: 2021-01-13T12:27:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-31T11:05:44.000Z (over 2 years ago)
- Last Synced: 2024-10-15T22:13:52.884Z (22 days ago)
- Topics: forward-proxy, forwardproxy, http, http-connect, http-proxy, https, proxy, proxy-server, ruby, tinycode
- Language: Ruby
- Homepage: http://www.jamesmoriarty.xyz/forward-proxy/
- Size: 163 KB
- Stars: 152
- Watchers: 4
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ForwardProxy
![Gem Version][3] ![Gem][1] ![Build Status][2]
Minimal forward proxy using 150LOC and only standard libraries. Useful for development, testing, and teaching.
```
$ forward-proxy --binding 0.0.0.0 --port 3182 --threads 2
I, [2021-07-04T10:33:32.947653 #1790] INFO -- : Listening 0.0.0.0:3182
I, [2021-07-04T10:33:32.998298 #1790] INFO -- : CONNECT raw.githubusercontent.com:443 HTTP/1.1
```
## Features
- Supports HTTPS `CONNECT` tunneling and HTTP `GET`, `POST`, and `HEAD` proxy request methods.
- Configurable client connection thread pool and timeout.
- `Transfer-Encoding: chunked` and response streaming.
- Automated tests.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'forward-proxy'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install forward-proxy
## Usage
### CLI
```
forward-proxy
```
```
Usage: forward-proxy [options]
-p, --port=PORT Bind to specified port. Default: 9292
-b, --binding=BINDING Bind to the specified ip. Default: 127.0.0.1
-t, --timeout=TIMEOUT Specify the connection timeout in seconds. Default: 300
-c, --threads=THREADS Specify the number of client threads. Default: 128
-h, --help Prints this help.
```
### Library
```ruby
require 'forward_proxy'
proxy = ForwardProxy::Server.new(
bind_address: "127.0.0.1",
bind_port: 3000
)
proxy.start
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jamesmoriarty/forward-proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jamesmoriarty/forward-proxy/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ForwardProxy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jamesmoriarty/forward-proxy/blob/master/CODE_OF_CONDUCT.md).
[1]: https://img.shields.io/gem/dt/forward-proxy
[2]: https://github.com/jamesmoriarty/forward-proxy/workflows/Continuous%20Integration/badge.svg?branch=main
[3]: https://img.shields.io/gem/v/forward-proxy