Difference between revisions of "BuildingMacOSX"

From Mumble Wiki
Jump to: navigation, search
 
(Added link to new build docs)
 
(108 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Universal or not Universal? ==
+
{{Warning
 +
|message=The build instructions listed here only apply to Mumble v1.3.x or older. If you want to build Mumble starting from v1.4.0, checkout https://github.com/mumble-voip/mumble/tree/master/docs/dev/build-instructions
 +
}}
  
If you want to build Mumble as universal binary you will first have to build all dependencies as universal binary.
+
{{Building}}
 +
 
 +
=== Introduction ===
 +
 
 +
This guide describes the method to get a fully working and redistributable version of Mumble and Murmur that uses the Cocoa version of Qt 4.
  
== Dependencies ==
 
 
To build Mumble you will need:
 
To build Mumble you will need:
* XCode (http://developer.apple.com/tools/xcode/)
+
* Mac OS X 10.8 (Mountain Lion)
* pkg-config (http://pkg-config.freedesktop.org/)
+
* Xcode 4.4
* QT >= 4.3.1 (http://trolltech.com/developer/downloads/qt/mac)
+
 
* Boost (http://www.boost.org/)
+
=== Creating a build environment ===
* Portaudio (http://www.portaudio.com/)
+
 
 +
The git repository at https://github.com/mumble-voip/mumble-releng contains pre-made scripts that build the current canonical Mumble OS X build environment.
 +
 
 +
Simply clone the repo, and cd into it:
 +
 
 +
  $ git clone https://github.com/mumble-voip/mumble-releng
 +
  $ cd mumble-releng/buildenv/1.3.x/osx
 +
 
 +
Create a MumbleBuild directory in your home dir:
 +
 
 +
  $ mkdir -p ~/MumbleBuild
 +
 
 +
Copy the 'env' script to the directory you created in the previous step:
 +
 
 +
  $ cp env ~/MumbleBuild/env
 +
 
 +
Source the env script to set up the proper environment variables for the Mumble build environment:
 +
 
 +
  $ source ~/MumbleBuild/env
 +
 
 +
Build the enviroment:
 +
 
 +
  $ ./build-all.bash
 +
 
 +
Once this is done, you should have a fully functional installation of Mumble's dependencies (tools and libs) in a self-contained MumbleBuild directory in your home directory.
 +
 
 +
=== Building Mumble ===
 +
 
 +
Make sure you've sourced ~/MumbleBuild/env into your current shell session:
 +
 
 +
$ source ~/MumbleBuild/env
 +
 
 +
Fetch the Mumble source from Git into a directory of your choosing:
  
=== Compiling pkg-config ===
+
git clone --recursive https://github.com/mumble-voip/mumble
  
This is just a build tool, so you do not have to build it as universal binary. Download and unpack pkg-config.
+
To build the client, execute:
sudo mkdir /usr/lib/pkgconfig (choose a path you like)
 
export PKG_CONFIG_PATH=/usr/lib/pkgconfig
 
./configure && make && sudo make install
 
  
To make the path permanent add the following line to your ''~/.profile'' file:
+
cd mumble
  export PKG_CONFIG_PATH=/usr/lib/pkgconfig
+
  qmake -recursive -Wall main.pro CONFIG+="release static"
Also add a path entry to the pkg-config binary to this file:
+
  make
  export PATH=$PATH:/usr/local/bin
 
  
=== Compiling QT ===
+
If everything went well, you should now have a Mumble.app application bundle in the release directory of the root of the source tree.
  
Download an unpack QT. Run
+
=== Building Murmur ===
./configure -universal -qt-sql-sqlite -qt-libpng
 
in the QT dir.
 
If configure is successful run
 
make && sudo make install
 
QT will be installed to ''/usr/local/Trolltech/Qt-4.3.X'' or similar.
 
  
To make the QT tools visible add the following line to your ''~/.profile'' file:
+
Make sure you've sourced ~/MumbleBuild/env into your current shell session:
export PATH=$PATH:/usr/local/Trolltech/Qt-4.3.X/bin
 
  
=== Compiling Boost ===
+
$ source ~/MumbleBuild/env
  
As Mumble only uses some Boost headers you do not have to build/install this. Just unpack Boost.
+
Fetch the Mumble and Murmur source from Git into a directory of your choosing:
  
=== Compiling Portaudio ===
+
git clone --recursive https://github.com/mumble-voip/mumble
  
This builds universal by default. So just download, unpack and:
+
To build the server, execute:
./configure && make
 
  
For the Mumble build system to find this you will have to modify the included ''portaudio-2.0.pc.in'', rename it to ''portaudio-2.0.pc'' and put it in you PKG_CONFIG_PATH.
+
cd mumble
My portaudio-2.0.pc file looks like this:
+
qmake -spec unsupported/macx-clang -recursive CONFIG+="release static no-client no-dbus"
 +
make
  
FIXME: include this information
+
If everything went well, you should now have a murmur binary in the release directory of the root of the source tree.
  
== Building Mumble ==
+
=== Distributing Mumble ===
  
Fetch the Mumble source from SVN. First build speex by changing into the ''speexbuild'' subdirectory and running:
+
If you wish to create a proper redistributable Mumble application bundle, please refer to the osxdist.py script in
qmake speexbuild.pro && make
+
the macx/scripts directory. This will help you clean up your application bundle, include the needed dependencies, resources etc., and create a compressed disk image - ready to redistribute!
  
After that change to the ''src/mumble'' subdirectory. Here you might have to change some parameters in ''mumble.pro'', so open it in a text editor.
+
The script expects you to be in the root of the source tree. After executing, it will spit out a .dmg of your Mumble build in the release folder.
Change the path in the line:
 
INCLUDEPATH += /usr/local/include/boost-1_34/
 
to the path where your boost headers are located.
 
  
then run:
+
If you only have a Mumble.app, and have not built Murmur, you should also pass the
qmake -nocache -config release -spec macx-xcode mumble.pro
 
after that you can:
 
open mumble.xcodeproj
 
  
In XCode switch to Release target and press the build button. If this finishes without errors you have done everything right and the finished application is located in the subdir ''src/mumble/build/Release'' of the main mumble sourcedir.
+
--no-server
  
== Distributing Mumble ==
+
parameter to the osxdist.py script. This will not attempt to package Murmur-specific files in the generated .dmg.
  
To include all the needed dependencies in the mumble application bundle you can use the following shell script:
+
The script supports code signing, and among other things, allow you to build a copy of Mumble signed with your Developer ID certificates from Apple.
 +
To build with code signing enabled, use the following three parameters to the osxdist.py script:
  
FIXME: include this information
+
* --developer-id='<Name or Organization>'
 +
* --keychain=<keychain> (optional, defaults to 'login.keychain')
  
You will have to change the locations of the linked libraries with a texteditor and set the QTDIR environment variable.
+
[[Category:Development]]
The output is a nice little .dmg file with you application bundle inside.
 

Latest revision as of 07:40, 12 October 2020

Icons oxygen 48x48 status task-attention.png
Warning: The build instructions listed here only apply to Mumble v1.3.x or older. If you want to build Mumble starting from v1.4.0, checkout https://github.com/mumble-voip/mumble/tree/master/docs/dev/build-instructions


Building Guides

This page is one of a set of Building pages/guides for the different OSes with information on building Mumble/Murmur.

BuildingLinux BuildingFreeBSD BuildingOpenBSD BuildingMacOSX BuildingWindows


Introduction

This guide describes the method to get a fully working and redistributable version of Mumble and Murmur that uses the Cocoa version of Qt 4.

To build Mumble you will need:

  • Mac OS X 10.8 (Mountain Lion)
  • Xcode 4.4

Creating a build environment

The git repository at https://github.com/mumble-voip/mumble-releng contains pre-made scripts that build the current canonical Mumble OS X build environment.

Simply clone the repo, and cd into it:

 $ git clone https://github.com/mumble-voip/mumble-releng
 $ cd mumble-releng/buildenv/1.3.x/osx

Create a MumbleBuild directory in your home dir:

 $ mkdir -p ~/MumbleBuild

Copy the 'env' script to the directory you created in the previous step:

 $ cp env ~/MumbleBuild/env

Source the env script to set up the proper environment variables for the Mumble build environment:

 $ source ~/MumbleBuild/env

Build the enviroment:

 $ ./build-all.bash

Once this is done, you should have a fully functional installation of Mumble's dependencies (tools and libs) in a self-contained MumbleBuild directory in your home directory.

Building Mumble

Make sure you've sourced ~/MumbleBuild/env into your current shell session:

$ source ~/MumbleBuild/env

Fetch the Mumble source from Git into a directory of your choosing:

git clone --recursive https://github.com/mumble-voip/mumble

To build the client, execute:

cd mumble
qmake -recursive -Wall main.pro CONFIG+="release static"
make

If everything went well, you should now have a Mumble.app application bundle in the release directory of the root of the source tree.

Building Murmur

Make sure you've sourced ~/MumbleBuild/env into your current shell session:

$ source ~/MumbleBuild/env

Fetch the Mumble and Murmur source from Git into a directory of your choosing:

git clone --recursive https://github.com/mumble-voip/mumble

To build the server, execute:

cd mumble
qmake -spec unsupported/macx-clang -recursive CONFIG+="release static no-client no-dbus"
make

If everything went well, you should now have a murmur binary in the release directory of the root of the source tree.

Distributing Mumble

If you wish to create a proper redistributable Mumble application bundle, please refer to the osxdist.py script in the macx/scripts directory. This will help you clean up your application bundle, include the needed dependencies, resources etc., and create a compressed disk image - ready to redistribute!

The script expects you to be in the root of the source tree. After executing, it will spit out a .dmg of your Mumble build in the release folder.

If you only have a Mumble.app, and have not built Murmur, you should also pass the

--no-server

parameter to the osxdist.py script. This will not attempt to package Murmur-specific files in the generated .dmg.

The script supports code signing, and among other things, allow you to build a copy of Mumble signed with your Developer ID certificates from Apple. To build with code signing enabled, use the following three parameters to the osxdist.py script:

  • --developer-id='<Name or Organization>'
  • --keychain=<keychain> (optional, defaults to 'login.keychain')