<type>documentation</type>
<domain>proj</domain>
<id>manual-remote-install</id>
<title>Manually Installing the Remote Agent</title>
<date>$Date: 2010-05-14 11:53:19 -0400 (Fri, 14 May 2010) $</date>
<version>$Revision: 22093 $</version>
<product-version>6+</product-version>
<product>pro+</product>

If for some reason you cannot use Wing's automated installation of the remote agent, for
example if Wing does not recognize the type of the remote system, you can install it
manually as follows.

(1) Find the Debugger Package most closely matching your remote host at
`https://wingware.com/downloads/wing-pro/~~FULL_VERSION~~.~~UPDATE~~/debugger
<https://wingware.com/downloads/wing-pro/~~FULL_VERSION~~.~~UPDATE~~/debugger>`__, copy it
to the remote host, and unpack it. The resulting directory can be renamed if desired.

You can unpack it with ``tar xf wing-debugger-*`` or ``tar xjf wing-debugger-*``.  Note
that using ``tar xzf`` does not work because the package is compressed with bzip2 and not gzip.

(2) Run ``chmod +x wingdb`` in the remote agent install directory to make that file
executable

(3) Set ``Installation Directory`` under the ``Advanced`` tab in your remote host
configuration to match the remote agent install location (this should be the full path of
the directory that contains ``remoteagent.py``)

If you plan to use ``wingdbstub`` to initiate debug from outside of Wing, as described
in `Debugging Externally Launched Remote Code <ref:debug/remote-debugging>`__ you'll also 
need to:

(4) Copy ``wingdbstub.py`` from your Wing installation to the remote host and place it
in the remote agent install directory (same directory as ``remoteagent.py``)

(5) Set ``WINGHOME`` in ``wingdbstub.py`` to the full path of the remote agent install
directory

(6) Set ``kWingHostPort`` in ``wingdbstub.py`` to ``localhost:50050`` (assuming
default debug port settings)
   
Optionally, if want to preauthorize debug connections from the remote host:

(7) Copy the ``wingdebugpw`` file from the `Settings Directory
<ref:install/user-settings-dir>`__ on the host where the IDE is running into the remote
agent install directory on the remote system.

Once this is done, Wing should be able to probe and use the remote host from 
``Remote Hosts`` in the ``Project`` menu.

**Running on Unsupported OSes**

These instructions should work on any system that has Python installed. If the remote host
is not one that Wing fully supports, you will still be able to edit, search, and manage
files, run unit tests, execute version control operations, and run OS commands. 

However, debugging or running a remote Python Shell will not work on unsupported OSes
unless you compile the debugger core yourself (requires `signed NDA
<https://wingware.com/pub/wingide/support/source-non-discl.pdf>`__). Or `contact us
<mailto:support@wingware.com>`__ to request support for your device.
