Select a topic:

Choose from one of the topics below to browse other articles

Articles & Information.

Using Git Repositories in Scout

Last updated by Ashley Cawley on April 03, 2024 13:11

00:00: This guide will walk you through setting up Git repositories in Scout and integrating them with GitHub. You will learn how to manage repositories, generate public keys, and add deploy keys to streamline your development process. 00:14: When managing a site in Scout we can see there is a dedicated Git tab at the top, lets take a look in there. 00:21: Here we find some useful advice on how to use Git with Scout. On the left we can enter in the Repository address and branch we wish to use and on the right we can specify the path or folder where the repo files will be cloned to. 00:34: Before we begin with connecting a Git Repo I would just like to show you that our website's public_html folder is currently empty 00:42: OK, so lets find the Git Repo address that we need for this form. 00:47: Switching over to, we can see I have setup an example repository for us to connect with the Scout platform. 00:55: On your repository click on the Code button 00:58: We are then shown the repo address. I click on the copy icon just to the right to copy it to my clipboard. 01:05: Then switching back to Scout, I paste in the GitHub Repo address into this box. 01:11: In my case I'm going to leave the default suggested path which is the website's main folder. But if your repo was just maintaining a specific set of files, like for a Theme lets say, then you could specify the path to the theme folder here if you wished. 01:26: Then I click on Add Repo. 01:29: At this stage Scout has added the repo for you, if the repo is publicly accessible on GitHub then Scout will likely be able to clone it, however if your repo is setup to be Private then you will need to continue with some further steps to setup authentication. In our example it is a Private repo we are working with, so we will look into that further: 01:49: Scout presents us with a public key which we can use for this, highlight and copy that entire key to your clipboard. 01:56: Switch back to your repo 01:59: Access the repository settings. 02:02: Navigate to the Deploy keys section. 02:05: Add a new deploy key. 02:08: Enter in a name for this deploy key. 02:11: Paste the public key from your clipboard into this box. 02:15: Click on the "Add the deploy key" button. 02:18: Switching back to Scout, we can see our repository listed here, now that we have added the deploy key over at it will have the authentication details it needs to connect and pull down or clone the repo files. 02:31: So lets click on the "Clone" button. 02:34: The cloning of the repo files will happen quickly. When I check the File Manager in Scout I now see all of the files and folders that were held in our GitHub repo successfully cloned onto the Scout platform. 02:46: At any point in the future you can return to the Git page in Scout and click on the "Pull" button, this updates the files on the Scout platform by pulling in any new changes which may have since been published to the GitHub repository. There is also an Options drop-down menu which contains further things like Web-hook's which we will cover in another video. But in short: Web-hooks allow you to automatically pull-down changes when they are published to the central GitHub repo, so that you do not have to come in here and manually pull, if you do not want to. Depending on your development environment or workflows either a manual or automatic approach may be advantageous which is why we offer both. 03:22: You've just learnt how to connect and use a Git repository with the Scout platform. Hopefully this makes your development and deployment processes faster and easier for you. If you have any questions then please feel free to get in touch with our support team.