Proxy Plugin

This plugin provides a straightforward API (cli and programatically) to handle BrowserMob Proxy.

It supports management of not only the proxy server, but also the sub-proxies.

You can easily use this plugin in your local development machine, or in a CI/CD pipeline.

How to Install ?

To install it simply run the following command :

$ athena plugins install proxy https://github.com/athena-oss/plugin-proxy.git

On MAC OSX Use Homebrew:

$ brew tap athena-oss/tap
$ brew install plugin-proxy

Read the Documentation on using Athena.

How to Use ?

This plugin provides the following commands :

start - Starts the Proxy Server(s)

$ athena proxy start [--help|--port=<port>] [<docker_options>...]

$ # e.g. start proxy server
$ athena proxy start

$ # e.g. link the proxy server with my selenium grid node
$ athena proxy start --link=my-selenium-grid-node:proxy-server

$ # e.g. start proxy server and publish externally port 5001
$ athena proxy start --port=5001

stop - Stop the Proxy Server(s)

$ athena proxy stop [--help|--all|--port=<port>]

$ # e.g. stop proxy server
$ athena proxy stop

$ # e.g. stop proxy server at port 5001
$ athena proxy stop --port=5001

logs - Shows Proxy Server Logs

$ athena proxy logs [--help|--port=<port>] [-f]

$ # e.g. simple logs print
$ athena proxy logs

$ # e.g. get proxy server at port 5001 logs
$ athena proxy logs --port=5001

terminal - Starts a Shell Inside the Proxy Server Container

$ athena proxy terminal [--help|--port=<port>]

$ # e.g. simple shell
$ athena proxy terminal

$ # e.g. start a shell in the proxy server running at port 5001
$ athena proxy terminal --port=5001

cleanup - Stops and Removes the Proxy Server Container(s) and Image

$ athena proxy cleanup [--help|-y]

$ # e.g. simple cleanup
$ athena proxy cleanup

$ # e.g. with automatic yes to prompts
$ athena proxy cleanup -y

proxy - Manage Proxies

$ athena proxy proxy <sub_command> [--port=<port>]

$ # e.g. list proxies
$ athena proxy proxy list

$ # e.g. list, proxy server at port 5001, proxies
$ athena proxy proxy list --port=5001

Contributing

Checkout our guidelines on how to contribute in CONTRIBUTING.md.

Versioning

Releases are managed using github's release feature. We use Semantic Versioning for all the releases. Every change made to the code base will be referred to in the release notes (except for cleanups and refactorings).

License

Licensed under the Apache License Version 2.0 (APLv2).