These instructions are for installing Goby from source code for developers, users of distributions without a Goby package, and generally ambitious individuals.

Please download or checkout the code using bazaar. Currently, version 2.1 is the preferred stable series for new projects.

• Download the latest release: https://github.com/GobySoft/goby/releases

• Uncompress the tar.gz file:

  tar -xfvz goby*.tgz
  

If you are a Goby developer or want the cutting edge version of Goby, use these instructions here. Please note that this code is likely to contain bugs.

• Install Git version control system.
• Check out a branch of the goby project:

  • Read-only:

      git clone https://github.com/GobySoft/goby.git
    

  • Read / write (developers of goby):

    • Register or login to Github.

    • Contact https://github.com/tsaubergine for access to the goby projec

    • Checkout a copy of goby:

      git clone git@github.com:GobySoft/goby.git
      

Goby uses CMake to configure its build environment. If you are comfortable using cmake, go ahead and use it as normal. If you have never used CMake, you can build Goby using the provided scripts as explained in this section:

• Install DCCL3: See http://libdccl.org/

• Satisfy additional third-party library dependences (boost, etc.):

  • Ubuntu:

    cd goby; sudo ./DEPENDENCIES ubuntu
    

  • Debian:

    cd goby; sudo ./DEPENDENCIES debian
    

  • Everyone else: install Boost and Google Protocol Buffers. If you need more functionality read the DEPENDENCIES to see what packages to install on your system.

• Compile* to goby/bin, goby/lib, and goby/include:

  cd goby; ./build.sh
  

• To install to /usr/local (optional):

  sudo ./build.sh install
  

• To install to some other location (e.g. /home/me/test/usr)

  GOBY_CMAKE_FLAGS="-DCMAKE_INSTALL_PREFIX=/home/me/test/usr" ./build.sh install
  

• To compile with four jobs (make -j4)

  ./build.sh -j4
  

  or

  GOBY_MAKE_FLAGS="-j4" ./build.sh
  

• To compile with debug symbols

  GOBY_CMAKE_FLAGS="-DCMAKE_BUILD_TYPE=Debug" ./build.sh
  

• Display all available CMake flags (to be set with GOBY_CMAKE_FLAGS="-DSOME_FLAG=ON")

  cmake -LAH goby/build
  

• Optionally enable / disable building of components (such as examples and tools) and fine tuning of build system:

  sudo apt-get install cmake-gui
  cmake-gui goby/build
  

• In some versions of Goby, build.sh is named BUILD. This was renamed in later revisions to avoid name conflicts with the directory build on case-insensitive filesystems.