Skip to content

Setting up a GitHub Application

Joshua S Brown edited this page Jun 1, 2021 · 30 revisions

These steps are very general, you do not actual need any code to setup a github application. What is needed is the url's where the application will be hosted.

  1. First step, click on your profile, and choose settings, then click Developer Settings.

image1 image3

  1. Three different options should then be available to you, you want to be sure the GitHub Application option is selected. Go ahead and select the create New GitHub App button at the top right side of the screen.

image5

  1. You will need to provide your password at this point.

image6

  1. At this point you will be provided with a form. I will call this the Application Settings Page, there are a few items that are required in order to register the application with GitHub.

image7

The required items are:

  • GitHub App name - it is what it says the name you want to call your application
  • Homepage URL - a link to the GitHub repository or the homepage of the application
  • Webhook URL - a way to communicate between GitHub and a server you are hosting
  1. We can get an appropriate webhook url fromm smee.io. I won't get into the details on how to receive payloads from GitHub using a server it is enough to simply have the url and copy it into the Webhook URL field on the Applications Settings Page.

image8

Click Start a New Channel button.

  1. A screen will appear giving you some advice on how to get a server running, but all you need is the url.

image9

  1. The next step on the Application Settings Page is to define the permission that your app needs in order to execute. For instance, if my app only interacts with the settings I may only need to ensure the application has permission to make changes there.

image10

  1. There are a few more options, but that covers the essentials. On the bottom of the Application Settings Page you can click the Create App button.

image12

 image13  image14  image15  image16  image17

Clone this wiki locally