Documentation

How to upgrade the supplied python script

Occasionally we publish updates for our python-based client script. They are usually bug fixes.

When sshreach.me detects that your client is running an old client script you will get a small notification icon in the 'Script' tab on your client list page.

If your client script is working for you then there is no need to change it. If the new version fixes some bugs that you have encountered you should then replace it.

Since most of your clients are probably on a remote locations and can only be reached through sshreach.me you should be careful not to close the connection to your client during the replacement of your client script. For security reasons our servers will automatically close the tunnel to your client if your client script is inactive. If you stop the script your tunnel will then be closed and you will not be able to reach your remote computer.

You should therefore always follow the following procedure when doing the upgrade:

  1. Ensure that the Allow clientless connection checkbox is checked. This will prevent our servers from closing the tunnel if the client script is stopped.
  2. Connect to your client and overwrite the old script with the new one.
  3. Restart the client script
  4. When the client script is again active, you can uncheck the Allow clientless connection checkbox.

If you have large number of clients this approach is too slow and we recommend that you use API calls.

  1. Turn on the Allow clientless connection option using the set_allow_clientless call with the allow=true parameter
  2. Open the tunnel using the connect call
  3. Overwrite the old script with the new one and restart the client script
  4. close the tunnel using the disconnect call
  5. Turn off the Allow clientless connection option using the set_allow_clientless call with the allow=false parameter