This guide assumes you already have an existing GitHub account and repository with a Jekyll or Hugo project. If you don’t have an existing project, check out our Quick start guide, which contains guides and resources for building your first static site.
Forestry allows you to import your static site through public and private GitHub repositories. This allows Forestry to sync any changes made by editors in Forestry to be committed back to GitHub. This also allows developers to work on your website on their local machine, and have all changes synced back to Forestry.
Importing from GitHub
To import a site with GitHub, login to Forestry and follow these instructions:
From the dashboard, click “Add Site”. In the modal that opens, choose the static site generator your site is built with from the dropdown menu, and then press “Next”.
Now, choose “GitHub” from the list of options.
This will redirect you to GitHub, and prompt you to enter your login credentials if you are not already logged in.
Give Forestry access to your GitHub repositories by clicking “Authorize application”. You can also request access to any GitHub organizations you are a member of.
In order to import a site from GitHub, you will need admin permissions for the repository. This is because Forestry needs to add a webhook to your repository in order to watch for changes.
Once authorized, you will be redirected back to Forestry to choose the repository you wish to import. From the dropdowns, choose your repository and the branch you would like to import.
If you’re importing a Hugo or Jekyll site, Forestry will attempt to locate your site configuration. If Forestry can’t locate the config file inside of the root of your project, you’ll be prompted to provide the directory it is located in.
In the final step, you can invite up to 3 Guest users to edit content on your project with you. Learn more about user roles. When you’re done just click on “Import Site” and let us get your site ready.
Importing from a GitHub organization
GitHub organizations may be set up to restrict access to third-party applications like Forestry without permission from an organization’s administrator. In this scenario, if you are not an administrator of your organization, you will need to request access on behalf of Forestry.
If you are an administrator of your application and have enabled third-party application restrictions, you will need to authorize Forestry to have access to your organization’s repositories.
To do so, go to the Settings page of your organization, and then navigate to the Third-party access tab.
To the right of “Forestry”, click the “Edit” button.
Then, click “Grant access” to allow your organization’s members to import your sites in Forestry.
Caught a mistake or want to contribute to the docs? Edit this page on Github!