mike-jumper commented on code in PR #261: URL: https://github.com/apache/guacamole-manual/pull/261#discussion_r2021902502
########## src/guacamole-native.md: ########## @@ -0,0 +1,771 @@ +Installing Guacamole natively +============================= + +Guacamole is separated into two pieces: guacamole-server, which provides the +guacd proxy and related libraries, and guacamole-client, which provides the +client to be served by your servlet container, usually [Apache +Tomcat](http://tomcat.apache.org/). + +guacamole-client is available in binary form, but guacamole-server must be +built from source. Don't be discouraged: building the components of Guacamole +from source is *not* as difficult as it sounds, and the build process is +automated. You just need to be sure you have the necessary tools installed +ahead of time. With the necessary dependencies in place, building Guacamole +only takes a few minutes. + +(building-guacamole-server)= + +Building guacamole-server +------------------------- + +guacamole-server contains all the native, server-side components required by +Guacamole to connect to remote desktops. It provides a common C library, +libguac, which all other native components depend on, as well as separate +libraries for each supported protocol, and guacd, the heart of Guacamole. + +guacd is the proxy daemon that runs on your Guacamole server, accepts users' +connections that are tunneled through the Guacamole web application, and then +connects to remote desktops on their behalf. Building guacd creates an +executable called {program}`guacd` which can be run manually or, if you wish, +automatically when your computer starts up. + +To build guacamole-server, you will need a C compiler (such as gcc) and the +libraries that guacamole-server depends on. Some dependencies are absolutely +required, while others are optional. The presence of optional dependencies +enables additional features. + +:::{important} +Many Linux distributions separate library packages into binary and +"development" packages; *you will need to install the development packages*. +These will usually end in a "-dev" or "-devel" suffix. +::: + +### Required dependencies + +In order to build guacamole-server, you will need Cairo, libjpeg (or +libjpeg-turbo), libpng, and libuuid (or the OSSP UUID library). These libraries +are strictly required *in all cases* - Guacamole cannot be built without them. + +[Cairo](http://cairographics.org/) +: Cairo is used by libguac for graphics rendering. Guacamole cannot function + without Cairo installed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libcairo2-dev` + * - Fedora / CentOS / RHEL package + - `cairo-devel` + ::: + +[libjpeg-turbo](http://libjpeg-turbo.virtualgl.org/) +: libjpeg-turbo is used by libguac to provide JPEG support. Guacamole will not + build without this library present: + + :::{list-table} + :stub-columns: 1 + * - Debian package + - `libjpeg62-turbo-dev` + * - Ubuntu package + - `libjpeg-turbo8-dev` + * - Fedora / CentOS / RHEL package + - `libjpeg-turbo-devel` + ::: + + If libjpeg-turbo is unavailable on your platform, and you do not wish to + build it from source, [libjpeg](http://www.ijg.org/) will work as well, + though it will not be quite as fast: + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libjpeg62-dev` + * - Fedora / CentOS / RHEL package + - `libjpeg-devel` + ::: + +[libpng](http://www.libpng.org/pub/png/libpng.html) +: libpng is used by libguac to write PNG images, the core image type used by + the Guacamole protocol. Guacamole cannot function without libpng. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libpng-dev` + * - Fedora / CentOS / RHEL package + - `libpng-devel` + ::: + + In some previous versions of Debian such as Debian 8 / Ubuntu 16.04, you need + the `libpng12-dev` package. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libpng12-dev` + ::: + +[libtool](https://www.gnu.org/software/libtool/manual/libtool.html) +: libtool is used during the build process. libtool creates compiled libraries + needed for Guacamole. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libtool-bin` + * - Fedora / CentOS / RHEL package + - `libtool` + ::: + +libuuid (part of [util-linux](https://www.kernel.org/pub/linux/utils/util-linux/)) +: libuuid is used by libguac to assign unique, internal IDs to each Guacamole + user and connection. These unique IDs are the basis for connection sharing + support. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `uuid-dev` + * - Fedora / CentOS / RHEL package + - `libuuid-devel` + ::: + + If libuuid is unavailable, the [OSSP UUID](http://www.ossp.org/pkg/lib/uuid/) + library may also be used: + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libossp-uuid-dev` + * - Fedora / CentOS / RHEL package + - `uuid-devel` + ::: + +### Optional dependencies + +The optional dependencies of Guacamole dictate which parts of guacamole-server +will be built. This includes the support for various remote desktop protocols, +as well as any additional features of those protocols: + +* VNC support depends on the libvncclient library, which is part of + libVNCServer. + +* RDP support depends on a recent version of FreeRDP (2.0.0 or higher, but + please *not a non-release version from git*). + +* SSH support depends on libssh2, OpenSSL and Pango (a font rendering and text + layout library, used by Guacamole's built-in terminal emulator). + +* Telnet depends on libtelnet and Pango. + +* Kubernetes support depends on libwebsockets, OpenSSL, and Pango. + +The `guacenc` utility, provided by guacamole-server to translate screen +recordings into video, depends on FFmpeg, and will only be built if at least +the libavcodec, libavformat, libavutil, and libswscale libraries provided by +FFmpeg are installed. + +:::{important} +If you lack these dependencies, *then the features or protocols which +depend on them will not be enabled*. Please read this section +carefully before deciding not to install an optional dependency. +::: + +[FFmpeg](https://ffmpeg.org/) +: The libavcodec, libavformat, libavutil, and libswscale libraries provided by + FFmpeg are used by `guacenc` to encode video streams when translating + recordings of Guacamole sessions. Without FFmpeg, the `guacenc` utility will + simply not be built. + + If you do not wish to make graphical recordings of Guacamole sessions, or do + not wish to translate such recordings into video, then FFmpeg is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libavcodec-dev`, `libavformat-dev`, `libavutil-dev`, `libswscale-dev` + * - Fedora / CentOS / RHEL package + - `ffmpeg-devel` + ::: + +[FreeRDP](http://www.freerdp.com/) +: FreeRDP 2.0.0 or later is required for RDP support. If you do not wish to + build RDP support, this library is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `freerdp2-dev` or `freerdp3-dev` + * - Fedora / CentOS / RHEL package + - `freerdp-devel` + ::: + +[Pango](http://www.pango.org/) +: Pango is a text layout library which Guacamole uses to render text for + protocols that require a terminal (Kubernetes, SSH, and telnet). If you do + not wish to build any terminal-based protocol support, this library is not + needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libpango1.0-dev` + * - Fedora / CentOS / RHEL package + - `pango-devel` + ::: + +[libssh2](http://www.libssh2.org/) +: libssh2 is required for SSH and SFTP support. If you do not wish to build SSH + or SFTP support, this library is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libssh2-1-dev` + * - Fedora / CentOS / RHEL package + - `libssh2-devel` + ::: + +[libtelnet](https://github.com/seanmiddleditch/libtelnet) +: libtelnet is required for telnet support. If you do not wish to build telnet + support, this library is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libtelnet-dev` + * - Fedora / CentOS / RHEL package + - `libtelnet-devel` + ::: + +[libVNCServer](http://libvnc.github.io/) +: libVNCServer provides libvncclient, which is required for VNC support. If you + do not wish to build VNC support, this library is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libvncserver-dev` + * - Fedora / CentOS / RHEL package + - `libvncserver-devel` + ::: + +[libwebsockets](https://libwebsockets.org/) +: libwebsockets is required for Kubernetes support. If you do not wish to build + Kubernetes support, this library is not needed. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libwebsockets-dev` + * - Fedora / CentOS / RHEL package + - `libwebsockets-devel` + ::: + +[PulseAudio](http://www.freedesktop.org/wiki/Software/PulseAudio/) +: PulseAudio provides libpulse, which is used by Guacamole's VNC support to + provide experimental audio support. If you are not going to be using the + experimental audio support for VNC, you do not need this library. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libpulse-dev` + * - Fedora / CentOS / RHEL package + - `pulseaudio-libs-devel` + ::: + +[OpenSSL](https://www.openssl.org/) +: OpenSSL provides support for SSL and TLS - two common encryption schemes that + make up the majority of encrypted web traffic. + + If you have libssl installed, guacd will be built with SSL support, allowing + communication between the web application and guacd to be encrypted. This + library is also required for SSH support, for manipulating public/private keys, + and for Kubernetes support, for SSL/TLS connections to the Kubernetes server. + + Without SSL support, there will be no option to encrypt communication to + guacd, and support for SSH and Kubernetes cannot be built. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libssl-dev` + * - Fedora / CentOS / RHEL package + - `openssl-devel` + ::: + +[libvorbis](http://xiph.org/vorbis/) +: libvorbis provides support for Ogg Vorbis - a free and open standard for + sound compression. If installed, libguac will be built with support for Ogg + Vorbis, and protocols supporting audio will use Ogg Vorbis compression when + possible. + + Otherwise, sound will only be encoded as WAV (uncompressed), and will only be + available if your browser also supports WAV. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libvorbis-dev` + * - Fedora / CentOS / RHEL package + - `libvorbis-devel` + ::: + +[libwebp](https://developers.google.com/speed/webp/) +: libwebp is used by libguac to write WebP images. Though support for WebP is + not mandated by the Guacamole protocol, WebP images will be used if supported + by both the browser and by libguac. + + Lacking WebP support, Guacamole will simply use JPEG in cases that it would + have preferred WebP. + + :::{list-table} + :stub-columns: 1 + * - Debian / Ubuntu package + - `libwebp-dev` + * - Fedora / CentOS / RHEL package + - `libwebp-devel` + ::: + +(guacamole-server-source)= + +### Obtaining the source code + +You can obtain a copy of the guacamole-server source from the Guacamole project +web site. These releases are stable snapshots of the latest code which have +undergone enough testing that the Guacamole team considers them fit for public +consumption. Source downloaded from the project web site will take the form of +a `.tar.gz` archive which you can extract +from the command line: + +```console +$ tar -xzf guacamole-server-1.6.0.tar.gz +$ cd guacamole-server-1.6.0/ +$ +``` + +If you want the absolute latest code, and don't care that the code hasn't been +as rigorously tested as the code in stable releases, you can also clone the +Guacamole team's git repository on GitHub: + +```console +$ git clone git://github.com/apache/guacamole-server.git +Cloning into 'guacamole-server'... +remote: Counting objects: 6769, done. +remote: Compressing objects: 100% (2244/2244), done. +remote: Total 6769 (delta 3058), reused 6718 (delta 3008) +Receiving objects: 100% (6769/6769), 2.32 MiB | 777 KiB/s, done. +Resolving deltas: 100% (3058/3058), done. +$ +``` + +(guacamole-server-build-process)= + +### The build process + +Once the guacamole-server source has been downloaded and extracted, you need to +run `configure`. This is a shell script automatically generated by GNU +Autotools, a popular build system used by the Guacamole project for +guacamole-server. Running `configure` will determine which libraries are +available on your system and will select the appropriate components for +building depending on what you actually have installed. + +:::{important} +Source downloaded directly from git will not contain this `configure` script, +as autogenerated code is not included in the project's repositories. If you +downloaded the code from the project's git repositories directly, you will need +to generate `configure` manually: + +```console +$ cd guacamole-server/ +$ autoreconf -fi +$ +``` + +Doing this requires GNU Autotools to be installed. + +Source archives downloaded from the project website contain the `configure` +script and all other necessary build files, and thus do not require GNU +Autotools to be installed on the build machine. +::: + +Once you run `configure`, you can see what a listing of what libraries were +found and what it has determined should be built: + +```console +$ ./configure --with-init-dir=/etc/init.d +checking for a BSD-compatible install... /usr/bin/install -c +checking whether build environment is sane... yes +... + +------------------------------------------------ +guacamole-server version 1.6.0 +------------------------------------------------ + + Library status: + + freerdp ............. yes (3.x) + pango ............... yes + libavcodec .......... yes + libavformat ......... yes + libavutil ........... yes + libssh2 ............. yes + libssl .............. yes + libswscale .......... yes + libtelnet ........... yes + libVNCServer ........ yes + libvorbis ........... yes + libpulse ............ yes + libwebsockets ....... yes + libwebp ............. yes + wsock32 ............. no + + Protocol support: + + Kubernetes .... yes + RDP ........... yes + SSH ........... yes + Telnet ........ yes + VNC ........... yes + + Services / tools: + + guacd ...... yes + guacenc .... yes + guaclog .... yes + + FreeRDP plugins: /usr/lib/pkgconfig/../../lib/freerdp3 + Init scripts: /etc/init.d + Systemd units: no + +Type "make" to compile guacamole-server. + +$ +``` + +The `--with-init-dir=/etc/init.d` shown above prepares the build to install a +startup script for guacd into the `/etc/init.d` directory, such that we can +later easily configure guacd to start automatically on boot. If you do not wish +guacd to start automatically at boot, leave off the `--with-init-dir` option. +If the directory containing your distribution's startup scripts differs from +the common `/etc/init.d`, replace `/etc/init.d` with the proper directory here. +You may need to consult your distribution's documentation, or do a little +digging in `/etc`, to determine the proper location. Review Comment: Sure - I've added "systemd" and "Traditional init (SysV)" tabs around these sections. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@guacamole.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
