Here are some reasons you might want to send the staff client's network traffic through an SSH proxy:
You will need a server that allows you to log in via SSH and has network access to the Evergreen server you want to reach. You will use your username and password for that SSH server to set up a tunnel.
For Windows users, one good solution is PuTTY: a free telnet/ssh client. When setting up a PuTTY session:
9999
in the "Source port".For other client operating systems, How to set up SSH (for the beginner) has excellent advice.
In order to tell the Evergreen Staff Client that all traffic should be sent through the SSH tunnel you just configured you have three options.
If you can log in without the proxy temporarily, use about:config to configure the proxy. You will want to set the following options:
Restart the client and you should be using the proxy.
If you need the proxy to log in you can edit your local preferences. This is per-user. You will need to run the staff client at least once first.
In your profile folder you should have an AppData or Application Data folder, possibly with a Roaming folder. Inside of that should be a folder like this:
OpenILS\open_ils_staff_client\Profiles\bf8bsk0o.default
The last component will vary. Edit the prefs.js file to add the following lines, probably at the end of the file:
pref("network.proxy.type",1); pref("network.proxy.socks","localhost"); pref("network.proxy.socks_port",9999);
If you want a system-wide proxy, regardless of user, you can change the Evergreen defaults. Create a new file named proxy.js in the "defaults/preferences" folder for your client install:
// Proxy configuration pref("network.proxy.type",1); // 5 is system, 4 is auto-detect. pref("network.proxy.socks","localhost"); pref("network.proxy.socks_port",9999);
Start and/or restart your client and it should be using the proxy.
AVOID THIS METHOD AT ALL COSTS
This method breaks upon upgrades of XulRunner itself and may cause automatic updates to fail on later versions of Evergreen.
I am leaving it here for reference purposes of how not to do this.
In order to tell the Evergreen Staff Client that all traffic should be sent through the SSH tunnel you just configured, edit the all.js
file, usually located at C:\Program Files\Evergreen Staff Client\greprefs\all.js
. Search this file for the word socks
.
Make the following changes:
network.proxy.socks
from ""
to "localhost"
.network.proxy.socks_port
from 0
to 9999
.
Save the all.js
file.
If everything is working correctly, you should now be able to run the Evergreen Staff Client and all its data will be sent encrypted through the SSH tunnel you have just configured.