We have moved

This page has been moved to ​https://github.com/Xpra-org/xpra/blob/master/docs/Build/README.md

Archived copy:

Building

Platform specific index:

• Fedora, CentOS, RHEL, openSUSE
• Debian and Ubuntu
• Microsoft Windows
• MacOSX
• Other platforms (unofficial): Gentoo, Arch, Raspberry Pi, OrangePI, ..
• FreeBSD, OpenBSD

Overview

Before attempting to build from source, make sure that all the required dependencies are installed.

For running the *nix server, you will need Xvfb or Xdummy (if available for your platform), xauth, keyboard utilities. Then just:

• download the source
• run:

  python3 ./setup.py install
  

Do not mix source installation with packages. Remove one completely before installing the other.
With python2, only the 3.x branch can be used. Newer versions require python3.

Build Switches

There are a number of build switches, which you can see with:

./setup.py --help

These should be auto-detected in most cases.

Many of those switches are related to picture encodings.

Patching

Occasionally, some patches in the source tree may need to be applied to build on some platforms to deal with library or tools compatibility.

---

Building with distutils

For installing into a local ./install directory as a normal user, simply run:

./setup.py install --home=./install

You then have to add the local installation directory to your PYTHONPATH whenever you want to use xpra:

PYTHONPATH=./install/lib*/python xpra ...

To install globally for all users via sudo:

rm -rf build install
sudo ./setup.py install

Uninstall

setuptools/distutils do not provide any uninstallation mechanism, this has nothing to do with Xpra. That said, it is generally enough to remove (but you must ensure that these are the correct files as you may damage your system otherwise!):

/usr/bin/xpra*
/usr/lib*/python*/*-packages/xpra*
/usr/share/xpra