HowTo: Teamcity + GitHub

Has anybody successfully configured Teamcity to monitor, extract, and build from GitHub?

I can’t seem to figure how where and how to configure the SSH keys for Teamcity. I have Teamcity running as a system service, under a system account. So where does Teamcity stash its SSH configuration?

  • Passing data between build steps in Jenkins
  • Jenkins builds on tag pushes via gerrit-trigger plugin
  • Gated commits using git branches
  • Setting up Continuous Integration with SVN
  • Should Git be used to store continuous integration builds?
  • Visual Studio Team Services with GitHub
  • EDIT

    To get this to work, I needed to stop the agent from running under a system account.

  • Get user events with Github API and Octokit
  • GitHub Pull Request complex conflicts
  • Is it possible to tell Github that my branch was merged into upstream master?
  • Switching between multiple ssh keys in Git on Windows
  • How to embed only certain lines from a gist?
  • Lost all the files in my git repo, reset didn't work. What happened?
  • 8 Solutions collect form web for “HowTo: Teamcity + GitHub”

    Ok… I got this to start working on my Windows server. Here are the steps I took to configure TeamCity 4.5 Professional:

    1. Downloaded the JetBrains Git VCS Plugin
    2. Copied the downloaded zip file to .BuildServer\plugins
    3. In the Administration > Edit Build Configuration > Edit VCS Root configuration screen, I selected “Git (JetBrains)”
    4. Entered my Clone Url from the GitHub project page
    5. Set for authentication method “Default Private Key” — this is IMPORTANT
      1. The TeamCity BuildAgent should be running as a standard user, with the SSH installation configured properly for that user.
      2. Follow the GitHub SSH directions for SSH configuration
    6. Leave the username blank. This should already be provided for in your GitHub clone URL

    I got “Default Private Key” to work with agents running as the SYSTEM user on Windows. For me, the answer was having the identity file at


    instead of at


    Your question is specific to SSH, but it is certainly easier and quicker to use HTTP over TLS, as GitHub and TeamCity both now support HTTP authentication. Furthermore, GitHub also supports personal api tokens with limited permissions, that you may configure to your liking, or create a new user if you prefer.

    See image below of our TeamCity settings.

    Teamcity configuration

    Since TeamCity 8.1, there is an official support for SSH key management, please read this docs:

    for private key, username must be blank.

    You may need a third party plugin like this

    (This is a up to date answer to an old question)

    I got ssh based builds working with github/gitlab and teamcity 7 like this:

    Log onto the teamcity machine and use puttygen/ssh-keygen to generate a rsa key pair and save the openssh key somewhere sensible.
    (Gotcha – Using puttygen? Make sure the private key is in openssh format – puttygen > conversions > export openssh key)

    I suggest you save the private key in


    Now setup “default private key” in teamcity – create a file


    And in it place this:

    Host * IdentityFile c:\.ssh\id_rsa

    Login to your gitlab/guthub account and paste in the openssh public key for your teamcity private key.

    You should now be able to create a git vcs root in teamcity that can use the default private key to pull your source.

    I don’t know why but choosing Default Private Key failed to me.

    Then I choose to Custom Private Key as screen shot below:
    enter image description here

    The Username field has to be empty.

    The Passphrase field is the password of the your private key

    (Assume you have added the public key of this private key in git already.)

    Hope no one got stuck like me !

    Git Baby is a git and github fan, let's start git clone.