Login | Project | Subscribe to RecentChanges | Add your user script
About MouseHole
MouseHole is a personal web proxy written in Ruby designed to be simple to script. Scripts can rewrite the web as you view it, altering content and behavior as you browse. Basically, it's an alternative to Greasemonkey, which does similar things from inside the Firefox web browser.
MouseHole works wherever Ruby works (Windows, OSX, Linux, BSD) and in any web browser. Many other proxies and browser scripting hosts are listed on OtherProxiesAndSuch.
MouseHole 2.0 Beta can be checked out from Subversion.
svn co http://code.whytheluckystiff.net/svn/mouseHole/trunk mouseHole
The information in this Wiki pertains to the MouseHole first series. Basic information on MouseHole 2.0 Beta can be found on the MouseHoleTwo page.
Getting Started
MouseHole 1.2 is available as:
- a Windows installer: http://rubyforge.org/frs/download.php/6262/mouseHole-1.2-win32.exe
- a source tarball: http://rubyforge.org/frs/download.php/6259/mouseHole-1.2.tar.bz2
- a source zip: http://rubyforge.org/frs/download.php/6260/mouseHole-1.2.zip
If you have any questions about MouseHole please add them to the FrequentlyAskedQuestions page where they will be answered in due course.
Once you've downloaded MouseHole, try out one of our tutorials:
- Quick MouseHole Intro takes a few minutes and covers the essentials.
- Editing MouseHole Scripts gives you the details on writing your own scripts.
If you want to go robust, try running MouseHole under LightTPD or Apache2. Full instructions on RedHanded.
Script Directory
- UserScripts: contains links to user-contributed MouseHole scripts.
- ProxyHacks?: contains patches which can further twist your MouseHole.
- mousehole-scripters: a mailing list for MouseHole news, scripts, bleeding edge code. Archives
Reference Material
MouseHole is based on WEBrick's proxy class, so hacking the proxy itself begins with WEBrick's docs.
For writing user scripts, you will need to know about:
and probably also:
