{"_id":"590a04f3ed80861900cbc753","__v":0,"category":{"_id":"590a04f3ed80861900cbc738","__v":0,"version":"590a04f2ed80861900cbc737","project":"55b2d5baa74a380d00e290c4","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-25T00:29:31.009Z","from_sync":false,"order":0,"slug":"quickstart","title":"Get Started"},"version":{"_id":"590a04f2ed80861900cbc737","project":"55b2d5baa74a380d00e290c4","__v":4,"createdAt":"2017-05-03T16:27:30.085Z","releaseDate":"2017-05-03T16:27:30.085Z","categories":["590a04f3ed80861900cbc738","590a04f3ed80861900cbc739","590a04f3ed80861900cbc73a","590a04f3ed80861900cbc73b","590a04f3ed80861900cbc73c","590a04f3ed80861900cbc73d","590a04f3ed80861900cbc73e","590a04f3ed80861900cbc73f","590a04f3ed80861900cbc740","590a04f3ed80861900cbc741","590a04f3ed80861900cbc742","590a04f3ed80861900cbc743","590a04f3ed80861900cbc744","590a04f3ed80861900cbc745","590a04f3ed80861900cbc746","590a04f3ed80861900cbc747","590a04f3ed80861900cbc748","590a04f3ed80861900cbc749","590a04f3ed80861900cbc74a","590a04f3ed80861900cbc74b","590a04f3ed80861900cbc74c","590a04f3ed80861900cbc74d","59124949de13f61900336a7a","5914b04e7c2c552d008b7104","5914b47242c6a22300b9dc20"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"7.0.0","version":"7"},"user":"55b2d5626862a10d00887af9","parentDoc":null,"project":"55b2d5baa74a380d00e290c4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-07T05:44:25.503Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"Connecting with GitHub Enterprise grants buddybuild access to your repository so that it can build your app when you push code to your repository. Connecting also grants buddybuild API access to manage webhooks for you, generate commit status, integrate with the GitHub issue tracker, enables the pull request flow, synchronizes access control for team management and more.\n\nEach member of your team that uses buddybuild should go through this guide to connect with GitHub Enterprise. This is encouraged so that you can take advantage of team management features. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Prerequisite\"\n}\n[/block]\nFirst make sure you have created an account with buddybuild by signing up with [GitHub](http://docs.buddybuild.com/docs/signing-up-with-github), [Bitbucket](http://docs.buddybuild.com/docs/signing-up-with-bitbucket), [GitLab](http://docs.buddybuild.com/docs/signing-up-with-gitlab) or by [email](http://docs.buddybuild.com/docs/signing-up-with-ssh#section-step-1-sign-up-with-email).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Connect your GitHub Enterprise account\"\n}\n[/block]\nTo connect your GitHub Enterprise account follow this URL:\nhttps://dashboard.buddybuild.com/apps/wizard/build/select-repo/github-enterprise\n\nYou will see a dialog with two input fields. If you already know your GitHub Enterprise endpoint and have a personal access token, then enter those now. Otherwise continue reading the next sections to learn how to get the endpoint name and generate a personal access token.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/63c80c3-Github_Enterprise-2.png\",\n        \"Github Enterprise-2.png\",\n        1500,\n        877,\n        \"#2c8cc3\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Configure your GitHub Enterprise endpoint\"\n}\n[/block]\nYour GitHub Enterprise endpoint is the hostname part of the URL when you visit your repositories in GitHub Enterprise. Copy the hostname part of your GitHub Enterprise server URL, which often looks something like `git.mycompany.com`. If your server uses a non-default HTTPS port, then please also copy the port part of the URL. For example, `git.mycompany.com:1234`.\n\n#### Do you have a private DNS?\nYour GitHub Enterprise hostname must be publicly addressable on the internet. If you use private DNS for your GitHub Enterprise installation, then you can use the IP address of the server instead.\n\n#### Do you have a firewall configured?\nIf your network infrastructure restricts inbound access over HTTPS from a set of IP addresses, then you may need to whitelist the IP addresses used by the buddybuild fleet. Please contact us for the latest CIDR range used by buddybuild.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Create a personal access token\"\n}\n[/block]\nNavigate to your GitHub Enterprise instance and sign in with your individual account credentials. You do not need to sign in with the GitHub Enterprise admin account.\n\nChoose **Settings** from the top right menu under your profile picture.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a96125f-Github_Enterprise-4.png\",\n        \"Github Enterprise-4.png\",\n        1500,\n        640,\n        \"#e5e6e6\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nYou will see a list of menu items of the left side of the page. Click on **Personal access tokens**. Then create a new token by clicking on **Generate new token**. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cacb522-Github_Enterprise-5.png\",\n        \"Github Enterprise-5.png\",\n        1500,\n        786,\n        \"#dee0e1\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nEnter *buddybuild* as the **Token description**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6d1783f-Github_Enterprise-6.png\",\n        \"Github Enterprise-6.png\",\n        1500,\n        500,\n        \"#e0e2e3\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nCarefully select the `repo`, `write:repo_hook` and `user` scopes. When you are done it should look like this.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e460a48-Github_Enterprise-7.png\",\n        \"Github Enterprise-7.png\",\n        1500,\n        1388,\n        \"#dde0d8\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The `repo` scope is required so that buddybuild can read from your repositories when building your app, post issues to the GitHub issue tracker and automatically install the buddybuild SDK if you choose to enable those features later.\\n\\nThe `write:repo_hook` scope is required to automatically configure your webhook, so that buddybuild knows when to build your app.\\n\\nThe `user` scope if required so that buddybuild can access your GitHub username for team management features.\",\n  \"title\": \"What are these scopes used for?\"\n}\n[/block]\nCopy the personal access token, a 40 character hexadecimal string.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/82dd2b2-Github_Enterprise-8.png\",\n        \"Github Enterprise-8.png\",\n        1500,\n        615,\n        \"#33373b\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nIn buddybuild, paste the personal access token into the **Enter your Personal Access Token** field. Then click **Connect Your GitHub Enterprise Repositories**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a94c634-Github_Enterprise-3.png\",\n        \"Github Enterprise-3.png\",\n        1500,\n        877,\n        \"#2a89bf\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nThe dialog should close and display a list of your repositories. At this point you have successfully completed connecting buddybuild with GitHub Enterprise!","excerpt":"","slug":"connect-with-github-enterprise","type":"basic","title":"Connect with GitHub Enterprise"}

Connect with GitHub Enterprise


Connecting with GitHub Enterprise grants buddybuild access to your repository so that it can build your app when you push code to your repository. Connecting also grants buddybuild API access to manage webhooks for you, generate commit status, integrate with the GitHub issue tracker, enables the pull request flow, synchronizes access control for team management and more. Each member of your team that uses buddybuild should go through this guide to connect with GitHub Enterprise. This is encouraged so that you can take advantage of team management features. [block:api-header] { "type": "basic", "title": "Prerequisite" } [/block] First make sure you have created an account with buddybuild by signing up with [GitHub](http://docs.buddybuild.com/docs/signing-up-with-github), [Bitbucket](http://docs.buddybuild.com/docs/signing-up-with-bitbucket), [GitLab](http://docs.buddybuild.com/docs/signing-up-with-gitlab) or by [email](http://docs.buddybuild.com/docs/signing-up-with-ssh#section-step-1-sign-up-with-email). [block:api-header] { "type": "basic", "title": "Connect your GitHub Enterprise account" } [/block] To connect your GitHub Enterprise account follow this URL: https://dashboard.buddybuild.com/apps/wizard/build/select-repo/github-enterprise You will see a dialog with two input fields. If you already know your GitHub Enterprise endpoint and have a personal access token, then enter those now. Otherwise continue reading the next sections to learn how to get the endpoint name and generate a personal access token. [block:image] { "images": [ { "image": [ "https://files.readme.io/63c80c3-Github_Enterprise-2.png", "Github Enterprise-2.png", 1500, 877, "#2c8cc3" ], "sizing": "full" } ] } [/block] [block:api-header] { "type": "basic", "title": "Configure your GitHub Enterprise endpoint" } [/block] Your GitHub Enterprise endpoint is the hostname part of the URL when you visit your repositories in GitHub Enterprise. Copy the hostname part of your GitHub Enterprise server URL, which often looks something like `git.mycompany.com`. If your server uses a non-default HTTPS port, then please also copy the port part of the URL. For example, `git.mycompany.com:1234`. #### Do you have a private DNS? Your GitHub Enterprise hostname must be publicly addressable on the internet. If you use private DNS for your GitHub Enterprise installation, then you can use the IP address of the server instead. #### Do you have a firewall configured? If your network infrastructure restricts inbound access over HTTPS from a set of IP addresses, then you may need to whitelist the IP addresses used by the buddybuild fleet. Please contact us for the latest CIDR range used by buddybuild. [block:api-header] { "type": "basic", "title": "Create a personal access token" } [/block] Navigate to your GitHub Enterprise instance and sign in with your individual account credentials. You do not need to sign in with the GitHub Enterprise admin account. Choose **Settings** from the top right menu under your profile picture. [block:image] { "images": [ { "image": [ "https://files.readme.io/a96125f-Github_Enterprise-4.png", "Github Enterprise-4.png", 1500, 640, "#e5e6e6" ], "sizing": "full" } ] } [/block] You will see a list of menu items of the left side of the page. Click on **Personal access tokens**. Then create a new token by clicking on **Generate new token**. [block:image] { "images": [ { "image": [ "https://files.readme.io/cacb522-Github_Enterprise-5.png", "Github Enterprise-5.png", 1500, 786, "#dee0e1" ], "sizing": "full" } ] } [/block] Enter *buddybuild* as the **Token description**. [block:image] { "images": [ { "image": [ "https://files.readme.io/6d1783f-Github_Enterprise-6.png", "Github Enterprise-6.png", 1500, 500, "#e0e2e3" ], "sizing": "full" } ] } [/block] Carefully select the `repo`, `write:repo_hook` and `user` scopes. When you are done it should look like this. [block:image] { "images": [ { "image": [ "https://files.readme.io/e460a48-Github_Enterprise-7.png", "Github Enterprise-7.png", 1500, 1388, "#dde0d8" ], "sizing": "full" } ] } [/block] [block:callout] { "type": "info", "body": "The `repo` scope is required so that buddybuild can read from your repositories when building your app, post issues to the GitHub issue tracker and automatically install the buddybuild SDK if you choose to enable those features later.\n\nThe `write:repo_hook` scope is required to automatically configure your webhook, so that buddybuild knows when to build your app.\n\nThe `user` scope if required so that buddybuild can access your GitHub username for team management features.", "title": "What are these scopes used for?" } [/block] Copy the personal access token, a 40 character hexadecimal string. [block:image] { "images": [ { "image": [ "https://files.readme.io/82dd2b2-Github_Enterprise-8.png", "Github Enterprise-8.png", 1500, 615, "#33373b" ], "sizing": "full" } ] } [/block] In buddybuild, paste the personal access token into the **Enter your Personal Access Token** field. Then click **Connect Your GitHub Enterprise Repositories**. [block:image] { "images": [ { "image": [ "https://files.readme.io/a94c634-Github_Enterprise-3.png", "Github Enterprise-3.png", 1500, 877, "#2a89bf" ], "sizing": "full" } ] } [/block] The dialog should close and display a list of your repositories. At this point you have successfully completed connecting buddybuild with GitHub Enterprise!