Page tree

  1. Configure Gerrit server:

    • Login to console on Gerrit server and install SubGit tool according to the Installation guide.

    • Download SubGit plugin for Gerrit server.

      MD5 checksum: 3902cf714c856524e8f4815ad70c00f3

      wget example
      $ wget
          --2017-05-11 18:15:37--
          Resolving (
          Connecting to (||:443... connected.
          HTTP request sent, awaiting response... 200 OK
          Length: 9709051 (9.3M) [application/java-archive]
          Saving to: ‘subgit-gerrit-plugin-1.0.0-EAP4.jar’
          100%[============================================================================================================>] 9,709,051    814KB/s   in 10s    
          2017-05-11 18:15:48 (938 KB/s) - ‘subgit-gerrit-plugin-1.0.0-EAP4.jar’ saved [9709051/9709051]
    • Move the downloaded file into plugins directory:

      $ mv ./subgit-gerrit-plugin-1.0.0-EAP4.jar GERRIT_SITE/plugins


      • GERRIT_SITE – the directory that was used as $sitepath during Gerrit installation.

    • Open Gerrit configuration file residing by the following path:



      • GERRIT_SITE – the directory that was used as $sitepath during Gerrit installation.

      Locate receive.timeout parameter and set it to 0:

         timeout = 0

      if you have Git installed on this machine, it can be done by the following command:

      $ git config -f GERRIT_SITE/etc/gerrit.config receive.timeout 0
    • Restart Gerrit daemon:

      $ GERRIT_SITE/bin/ restart


      • GERRIT_SITE – the directory that was used as $sitepath during the Gerrit installation.
      Restart Gerrit daemon
      $ /gerrit/bin/ restart
        Stopping Gerrit Code Review: OK
        Starting Gerrit Code Review: OK
    • Check SubGit plugin is showed in Gerrit:

  2. Configure the repository

    • Create empty Git repository:

    • Open Gerrit server console and step into git directory within GERRIT_SITE:

      CD to git directory
      $ cd GERRIT_SITE/git


      • GERRIT_SITE – the directory that was used as $sitepath during Gerrit installation.

      the newly created project directory should be present here and named <given project name>.git

      Git directory contain
      $ ls -l
         drwxr-xr-x. 7 root root 100 May 10 12:00 All-Projects.git
         drwxr-xr-x. 7 root root 100 May 10 12:00 All-Users.git
         drwxr-xr-x. 7 root root 100 May 11 19:26 project.git
    • Run this command to configure SubGit import:

      $ subgit configure --layout auto --trunk TRUNK SVN_URL GIT_REPO


      • SVN_URL   – SVN project URL.
      • GIT_REPO  – a path to a new Git repository.
      • TRUNK     – a path, relative to SVN_URL, that leads to an SVN directory that plays the role of the main line of development.
      subgit configure
      $ subgit configure --layout auto --trunk trunk /gerrit/site/project.git
                  SubGit version 3.2.4 ('Bobique') build #3670
                  Configuring writable Git mirror of remote Subversion repository:
                      Subversion repository URL :
                      Git repository location   : ./repo.git
                  Detecting peg location... 
                  Authentication realm: <> Subversion Repository
                  Username [user]: user
                  Password [user]:
                  Peg location detected: r10248 project/trunk
                  Fetching SVN history... Done.
                  Growing trees... Done.
                  Project origin detected: r1 project/trunk
                  Building branches layouts... Done.
                  Combing beards... Done.
                  Generating SVN to Git mapping... Done.
                  To complete SubGit installation do the following:
                  1) Adjust Subversion to Git branches mapping if necessary:
                  2) Define at least one Subversion credentials in default SubGit passwd file at:
                     OR configure SSH or SSL credentials in the [auth] section of:
                  3) Optionally, add custom authors mapping to the authors.txt file(s) at:
                  4) Run SubGit 'install' command:
                      subgit install ./repo.git
    • Specify authors mapping

      Configure authors mapping in default authors mapping file:


      Or change core.authors option so that it points to the global authors mapping file.

      Find more details about authors mapping in the Authors mapping article.

    • Specify a username and password that are used by SubGit to access the SCN repository. Edit passwd file:


      By default, there's only subgit secret credential pair. Replace it with a username and its corresponding password.

      SVN authentication

      There are several methods to configure authentication to access SVN server, but we use a plain text password file here to simplify the guide. See more authentication methods in SVN Authentication if this method does not fit your needs.


  3. Establish a two-way mirror between SVN and Gerrit by the following command:

    $ subgit install GIT_REPO 


        GIT_REPO – a path to the Git repository.

    subgit import
    $ subgit-3.2.4/bin/subgit install ./project.git
       SubGit version 3.2.4 ('Bobique') build #3670
       Translating Subversion revisions to Git commits...
       Subversion revisions translated: 10248.
       Total time: 2 hours 15 minutes 24 seconds.
  4. When the command completed, the mirror is established and data from SVN is translated to Gerrit, so you can clone your new Git repository and start to work with it:

    $ git clone GERRIT_URL WORK_TREE


    • GERRIT_URL – the new Gerrit project URL.
    • WORK_TREE  – a path to your working copy.
    git clone example
    $ git clone /home/user/project.git
      Cloning into '/home/user//project.git'...
      Password for '': 
      remote: Counting objects: 99, done.
      remote: Compressing objects: 100% (39/39), done.
      remote: Total 99 (delta 50), reused 99 (delta 50)
      Unpacking objects: 100% (99/99), done.

    Empty working tree case

    If Git warns you that you are cloning an empty repository and you don't see your files in the working tree, most probably automatic branches and tags mapping didn't work correctly. In this case, mapping has to be set manually, see details on mapping in Branches and tags mapping.

  5. Try and buy.

    Trial period

    Note: the trial period for SubGit mirror is 30 days, after that period you should buy a license key at

    Once you receive an email with a license key, upload this license key to your server and run the following command:

    $ sudo subgit register --key subgit.key GIT_REPO


         GIT_REPO – a path to your newly created Git repository.

    subgit register
    $ sudo subgit register --key subgit.key /gerrit/site/project.git
       SubGit version 3.2.4 ('Bobique') build #3670
       Registration information:
         Registered for:       Example company
         Purchase ID:          OS-111111111111111
         Expiration date:      April 23, 2028
         You may use this key to register 9 more repositories (out of 10).
       Thank you for registering SubGit!
       Visit in case you have any questions and for more information on SubGit.
  6. Get support:

    If you have encountered any problems, see the following guides for more details:

Should you need assistance, don't hesitate to contact us at