Webhooks allow a website to be linked to a git-based repository so that its various features such as versioning, multiple branches, etc. can be leveraged. We suggest the use of the University Code Repository; however, these should work just as well with Github, etc.
URL
This is the webhook itself. It’s a URL that will trigger a git pull to update the website with any changes currently waiting in the git repository. You will need to go into your git repository setup and configure this URL in its webhooks section along with what types of updates will trigger it. Webhook instructions for the UCR can be found here.
Repo URL
This is the SSH-based URL for the repository itself so the website account knows where and how to retrieve it. UCR, Github, etc. provide these for you so you should only need to cut & paste it in. Only SSH-based pulls are supported at this time.
Repository Path
This is the path where git stores its local copy of the repository. The path is relative to your website directory. (where you’re initially placed when you SFTP in) For example, a website is usually under /htdocs, data files or an external module in /php-data, etc.
Repository Remote
This is the remote to use in the local clone. If you don’t know what it is then it’s probably ‘origin’.
Repository Branch
This is the branch of the repository currently shown. If you don’t know what it is then it’s probably ‘master’.
Key Path
This is the path (relative to the website directory) that contains the SSH key pair used to access the remote repository. More on using SSH keys with UCR can be found here. It should be a dedicated deploy key and NOT a personal developer one.
Need More Information?
Is OSU Web Hosting right for you? Check your eligibility.
More questions? Check the support section or contact us.
Ready to get started? Request hosting now!