Skip to content

Latest commit

 

History

History
189 lines (125 loc) · 6.16 KB

BUILDING.md

File metadata and controls

189 lines (125 loc) · 6.16 KB
Raw

Building the collab-vm-server

Compiling the server is fairly easy. The server is confirmed to work on the i386 (32-bit), amd64 (64-bit), and armhf architectures on both Windows and Linux.

It should also work on Aarch64, PowerPC, and MIPS machines, but note that this isn't tested.

CollabVM Server is confirmed to build and work in the following environments:

  • Ubuntu, Debian, Raspbian, Arch Linux, CentOS, etc.
  • Windows XP Professional, Windows 7, and Windows 10, and their server counterparts.
  • FreeBSD and OpenBSD
  • Haiku
  • Android OS (using Termux)

Make flags for the Makeconfig-based build system (soon to be replaced) (To enable, set these using FLAG=1):

  • JPEG - Controls/enables the JPEG support. This flag should be enabled for a server facing the internet.
  • DEBUG - Enables debug symbols and doesn't build a optimized binary. Also possibly includes some debug assert code.
  • ASAN - Enables the instrumentation of the binary with AddressSanitizer. Needs DEBUG=1 beforehand.
  • TSAN - Enables the instrumentation of the binary with ThreadSanitizer. Needs DEBUG=1 beforehand, and is not compatiable with ASAN=1.
  • V - Displays compile command lines, useful for debugging errors
  • EXECINFO - Includes libexecinfo into the library list, which is used for the backtrace symbol(s) on some *nix. (Example: Alpine Linux)
  • UPNP - Enables UPnP support via miniupnpc, enabling collab-vm-server to automatically port forward itself on some networks.

All Required Dependencies

First and foremost, your version of GCC or clang should be able to compile C++17 programs. If it cannot, you need to install a newer compiler.

  • Boost 1.67 or above (1.67 is untested, 1.71 onwards works fine though. 1.75+ recommended)
  • libvncserver
  • libpng
  • libturbojpeg
  • libsqlite3-dev
  • cairo

These dependencies compile with the collab-vm-server source code and are shipped with it.

  • RapidJSON

There is a Git submodule that you must clone in the vendor directory.

  • Sqlite-ORM

To grab this, run:

git submodule init
git submodule update

Optional Dependencies for Optional Features

To use some build features, you require additional libraries:

  • For UPnP, miniupnpc

Windows

On Windows, you have the following options:

  • MSYS2 with MinGW
  • Cygwin

MSYS2 with MinGW

To build the server with MSYS2 with MinGW, do the following:

pacman -Syu

# Restart MSYS for the arch you want to compile (e.g on win32 MSYS MinGW 32bit, or on Win64 MSYS MinGW x86_64)

# Install the Win32 compiler
pacman -S --noconf mingw-w64-i686-toolchain git

# Restart MSYS again.

# Install the Win64 compiler
pacman -S --noconf mingw-w64-x86_64-toolchain git

# Restart MSYS again.

# Get all of the CollabVM Server dependencies (for Win64).
./scripts/grab_deps_mw64.sh

# Get all of the CollabVM Server dependencies (for Win32).
./scripts/grab_deps_mw32.sh

# clang32 and clang64 are supported, for those use for 64-bit
./scripts/grab_deps_mwclang64.sh

# and for 32-bit
./scripts/grab_deps_mwclang32.sh

# If you get a Permission Denied error, go into the scripts directory and type chmod +x *.sh.

# Before building, you may need to patch your rfbproto.h file to work with boost
# To do this:
./scripts/msys_autopatcher.sh

# As it says, you should be able to run make now.

make

# For a Win32 build, do:
make WARCH=w32

and then everything should be good.

Cygwin

Cygwin is currently not working correctly as it will build but it cannot start any virtual machines. There is also a bug that prevents it from being connected from IPv4, which is currently being investigated.

Regardless, to build the server with Cygwin, obviously install Cygwin with GCC and then run the following commands:

# Grab the dependencies 
./scripts/grab_deps_cyg.sh

# Build the server 
make

Visual Studio

Visual Studio is currently unsupported, however it may be supported later once stuff is completed.

Linux

On Linux, compiling with both clang and gcc seem to work fine. It is recommended to use clang.

Run the following commands:

# on Arch Linux:
sudo pacman -S base-devel

# on Debian/Ubuntu:
sudo apt install -y build-essential

# on Fedora/Red Hat/CentOS/Etc:
sudo yum groupinstall 'Development Tools'

# Get all of the CollabVM Server dependencies for Linux.
./scripts/grab_deps_linux.sh

# build the server 
make

To build with the Clang compiler (and, also possibly instrument the binary with ASAN/such), do make CC=clang CXX=clang++.

macOS / MacOS X

NOTE: This is untested, and is not guaranteed to work.

On MacOS X, there is a development kit called "XCode". I have no idea at all if it would be compatible with this, so instead, this will use Homebrew to build the server.

  • Open a Terminal and a web browser. Go to https://brew.sh.
  • Copy the command from the home page.
  • Enter your password if it asks and start the installation.
  • Once it is finished installing, run the following command: brew install boost cairo sqlite3 llvm jpeg-turbo libvncserver
  • Set your exports to as such mentioned during the post-install notes, this is to allow the new libraries to be used.
  • Verify all the dependencies have been successfully installed and build the solution.

BSD

The FreeBSD port has been tested to function correctly,

# You can instal the required dependencies as such
pkg install libvncserver libjpeg-turbo boost-all cairo jpeg-turbo sqlite3

# Then build with GNU make (gmake).
# PREFIX is required to be set on *BSD because 
# of the ports system installing to a different location.

gmake PREFIX=/usr/local

Other BSDs such as OpenBSD and NetBSD may require extra work.

Others?

It's possible that CollabVM Server may run on other operating systems such as GNU/Hurd, OpenIndiana, etc.

Its possible it might run on MINIX, but these platforms are unsupported and are NOT tested.

Let me know what crazy operating systems you get it to run on, though!

And if you've managed to get a port building constantly, Consider contributing to either the repo or the wiki.

Caveats, Gotya's and Errata

As of writing, there are no known compiler issues that are affect all platforms.

For windows users, libvncserver's conflicting definitions still are an issue, yet can be fixed using the included autopatcher script.