Difference between revisions of "Building Zimbra using Git"

(Initial Setup)
(Obtaining the source to Zimbra Collaboration Suite)
Line 51: Line 51:
 
   mkdir -p ~/git
 
   mkdir -p ~/git
 
   cd ~/git
 
   cd ~/git
   git clone git@zimbra-git:REPOSITORY
+
   git clone git@zimbra-git:zimbra-foss
 
  </nowiki>
 
  </nowiki>
Replace <tt>REPOSITORY</tt> as described below.
+
 
  
 
===Source for the "main" branch===
 
===Source for the "main" branch===
 
* main is the development branch.
 
* main is the development branch.
* The primary git respository for main is: '''main-foss'''
 
 
To obtain the source: <tt>git clone git@zimbra-git:main-foss</tt>
 
  
 
The 'main' branch, (often referred to as mainline) contains the latest code - if your interested in seeing pre-release software check it out.
 
The 'main' branch, (often referred to as mainline) contains the latest code - if your interested in seeing pre-release software check it out.
Line 65: Line 62:
 
It is constantly in flux (for instance we might stagger spec files to avoid the need to always rebuild ThirdParty), if you're hitting a error in the Zimbra build side the first thing to do is re-sync, as we typically resolve these fast.
 
It is constantly in flux (for instance we might stagger spec files to avoid the need to always rebuild ThirdParty), if you're hitting a error in the Zimbra build side the first thing to do is re-sync, as we typically resolve these fast.
  
===Source for the JudasPriest "8.5" branch===
+
It is the default branch in use after doing a checkout of '''zimbra-foss'''
* JudasPriest is the upcoming 8.5 series release.
 
* It can still be found in the '''main-foss''' branch as of now.
 
  
===Source for the IronMaiden "8.0" branch===
+
=== Listing available branches ===
* IronMaiden is the 8.0 series release.
 
* Current version & changelist can be found on [http://pm.zimbra.com/pm_release.php?rel=8.0 Pmweb]
 
* The primary git respository for IRONMAIDEN development is: '''ironmaiden-foss'''
 
* The current release repository is '''ironmaiden-807-foss'''
 
  
To obtain the source:
+
The '''zimbra-foss''' repo contains all the available release branches.  You can obtain a list of the branches via:
 +
<nowiki
 +
git branch -a
 +
</nowiki>
 +
 
 +
Example output (abbreviated)
 
  <nowiki>
 
  <nowiki>
  git clone git@zimbra-git:ironmaiden-foss
+
* main-foss
 +
  remotes/origin/HEAD -> origin/main-foss
 +
  remotes/origin/frank-foss
 +
  remotes/origin/franklin-5010-foss
 +
  remotes/origin/franklin-5011-foss
 +
  remotes/origin/franklin-5012-foss
 +
  remotes/origin/franklin-5013-foss
 +
  remotes/origin/franklin-5014-foss
 +
  remotes/origin/franklin-5015-foss
 +
  remotes/origin/franklin-5016-foss
 +
  remotes/origin/franklin-5017-foss
 +
  remotes/origin/franklin-5018-foss
 +
  remotes/origin/franklin-5019-foss
 +
  remotes/origin/franklin-5020-foss
 
  </nowiki>
 
  </nowiki>
  
===Source for the Helix "7.x" branch===
+
The branch with a '''*''' in front of it is your active checkout.
* Helix is the 7.0, 7.1, and 7.2 series release.
+
 
* Current version & changelist can be found on [http://pm.zimbra.com/pm_release.php?rel=7.0 Pmweb]
+
=== Changing the active checkout ===
* The primary git respository for HELIX development is: '''helix-foss'''.
+
 
* The current release repository is '''helix-727-foss'''
+
To change the active branch, you use the '''git checkout''' command, and supply the release you are interested in.
  
To obtain the source:
+
For example, to switch to the IRONMAIDEN 8.0.7 release branch, one would execute:
 
  <nowiki>
 
  <nowiki>
  git clone git@zimbra-git:helix-foss
+
git checkout ironmaiden-807-foss
 
  </nowiki>
 
  </nowiki>
  
Line 94: Line 103:
 
To update an already existing clone:
 
To update an already existing clone:
 
  <nowiki>
 
  <nowiki>
   cd ~/git/REPOSITORY
+
   cd ~/git/zimbra-foss
  git checkout REPOSITORY
 
  git pull
 
</nowiki>
 
 
 
For example:
 
To update an already existing clone:
 
<nowiki>
 
  cd ~/git/main-foss
 
  git checkout main-foss
 
 
   git pull
 
   git pull
 
  </nowiki>
 
  </nowiki>

Revision as of 19:01, 7 July 2014

General Information

The git fusion server gives users access to download and build/modify Zimbra source code for Open Source products. Building Zimbra Collaboration Suite from Zimbra's git fusion server requires advanced knowledge of troubleshooting. It is not available for Network Edition components. Changes cannot be committed to the git fusion server.

By building Zimbra, you agree to Zimbra's licensing terms. Building from source is not covered under the ZEUL, unlike pre-compiled binaries, but rather the Open Source licenses as descrived on the licensing page. Please read the page on contributing if you plan to submit back any patches.

Technical support for source building can be found in the Zimbra Developers forum.

By default, you will only be able to build "out of the box" with supported operating systems (see list on site or files in ZimbraBuild/defs). However, you may be able to modify the source to get Zimbra to build on your OS of choice.

Initial Setup

At it's simplest, to obtain the source you need to essentially:

  • Install git
    • yum install git (RHEL, SLES, etc)
    • aptitude install git (Ubuntu, etc)
  • Obtain the git ssh access keys
  mkdir -p /tmp/zimbra-git
  cd /tmp/zimbra-git
  wget http://files2.zimbra.com/downloads/git-fusion/zimbra-git-ssh.tgz
  tar xfz zimbra-git-ssh.tgz
 
  • Add the access keys to your own user account:
  cd ~/.ssh
  cp /tmp/zimbra-git/id_rsa_git* .
 
  • Add the following ~/.ssh/config. Create the file if it doesn't exist:
Host zimbra-git
  User public
  Hostname git.zimbra.com
  IdentityFile ~/.ssh/id_rsa_git
  IdentitiesOnly yes
  Port 1067
 
  • Ensure the permissions on the config file are correct
  chmod 600 ~/.ssh/config
 

Obtaining the source to Zimbra Collaboration Suite

The source code for ZCS is retrieved from git.zimbra.com as described above.

To obtain the source:

  mkdir -p ~/git
  cd ~/git
  git clone git@zimbra-git:zimbra-foss
 


Source for the "main" branch

  • main is the development branch.

The 'main' branch, (often referred to as mainline) contains the latest code - if your interested in seeing pre-release software check it out.

It is constantly in flux (for instance we might stagger spec files to avoid the need to always rebuild ThirdParty), if you're hitting a error in the Zimbra build side the first thing to do is re-sync, as we typically resolve these fast.

It is the default branch in use after doing a checkout of zimbra-foss

Listing available branches

The zimbra-foss repo contains all the available release branches. You can obtain a list of the branches via:


Example output (abbreviated)
 <nowiki>
 * main-foss
   remotes/origin/HEAD -> origin/main-foss
   remotes/origin/frank-foss
   remotes/origin/franklin-5010-foss
   remotes/origin/franklin-5011-foss
   remotes/origin/franklin-5012-foss
   remotes/origin/franklin-5013-foss
   remotes/origin/franklin-5014-foss
   remotes/origin/franklin-5015-foss
   remotes/origin/franklin-5016-foss
   remotes/origin/franklin-5017-foss
   remotes/origin/franklin-5018-foss
   remotes/origin/franklin-5019-foss
   remotes/origin/franklin-5020-foss
 

The branch with a * in front of it is your active checkout.

Changing the active checkout

To change the active branch, you use the git checkout command, and supply the release you are interested in.

For example, to switch to the IRONMAIDEN 8.0.7 release branch, one would execute:

 git checkout ironmaiden-807-foss
 

Updating an existing source clone

To update an already existing clone:

  cd ~/git/zimbra-foss
  git pull
 

Building Zimbra Collaboration Server

IMPORTANT: NOT YET UPDATED FOR GIT

New master script for (5.0.14+):

~/git/REPOSITORY/ZimbraBuild/buildZCS.sh -t 

(This will help you through adding Ant & JDK, check dependencies, build ThridParty using a public CPAN mirror for Perl, then start the ZCS build process.)

Building Zimbra Desktop

Buiding Zimbra Mobile Edition

ZME (J2ME) Client: Building ZimbraME

Troubleshooting

Search the forums for any recent reports or create a new thread letting us know and we'll get right on it.


Third Party Component Failures | Perl Components fail to build configure: error: User zimbra (and/or group zimbra) doesn't exist.


Verified Against: unknown Date Created: 1/29/2014
Article ID: https://wiki.zimbra.com/index.php?title=Building_Zimbra_using_Git Date Modified: 2014-07-07



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search