Menu

Tree [3786fe] master /
 History

Read Only access


File Date Author Commit
 docker 2017-05-27 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [3786fe] fix pyvenv for python 3.6
 wormhole 2016-05-25 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [90902e] bump version to v2.0.2
 .docker-repository.yml 2016-03-24 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [00f608] Add bitbucket dockerhub plugin
 .gitignore 2013-02-26 Hong Minhee Hong Minhee [87b6e1] Ignore Vim swap files
 .hgtags 2016-05-25 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [f59ec5] Added tag v2.0.2 for changeset 90902eaba03e
 README.rst 2016-07-13 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [cf7094] cleanup README
 setup.py 2016-05-12 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [a8edd7] Remove README.md, use only README.rst now.
 wormhole.passwd 2016-04-29 Chaiwat Suttipongsakul Chaiwat Suttipongsakul [c7b7c7] limit wormhole process

Read Me

Wormhole

Wormhole is a forward proxy without caching. You may use it for:

  • Modifying requests to look like they are originated from the IP address that Wormhole is running on.
  • Adding an authentication layer to the internet users in your organization.
  • Logging internet activities to your syslog server.

Dependency

  • Python >= 3.5.0
  • uvloop (optional)

Docker Image Usage

Run without authentication

$ docker pull bashell/wormhole
$ docker run -d -p 8800:8800 bashell/wormhole

Run with authentication

  • Create an empty directory on your docker host
  • Create an authentication file that contains username and password in this format username:password
  • Link that directory to the container via option -v and also run wormhole container with option -a /path/to/authentication_file

Example:

$ docker pull bashell/wormhole
$ mkdir -p /path/to/dir
$ echo "user1:password1" > /path/to/dir/wormhole.passwd
$ docker run -d -v /path/to/dir:/opt/wormhole \
  -p 8800:8800 bashell/wormhole \
  -a /opt/wormhole/wormhole.passwd

How to install

Stable Version

Please install the stable version using pip command:

$ pip install wormhole-proxy

Development Snapshot

You can install the development snapshot using pip with mercurial:

$ pip install hg+https://bitbucket.org/bashell-com/wormhole

Or install from your local clone:

$ hg clone https://bitbucket.org/bashell-com/wormhole
$ cd wormhole/
$ pip install -e .

You can also install the latest default snapshot using the following command:

$ pip install https://bitbucket.org/bashell-com/wormhole/get/default.tar.gz

How to use

  1. Run wormhole command

    $ wormhole
    
  2. Set browser's proxy setting to

    host: 127.0.0.1
    port: 8800
    

Command help

$ wormhole --help

License

MIT License (included in license.py)

Notice

  • This project is forked and converted to Mercurial from WARP on GitHub.
  • Authentication file contains username and password in plain text, keep it secret! (I will try to encrypt/encode it soon.)
  • Wormhole may not work in:
    • some ISPs
    • some firewalls
    • some browers
    • some web sites
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.