This guide assumes you already have an existing GitLab 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’s allows you to import your static site through public and private GitLab repositories. This allows Forestry to sync any changes made by editors in Forestry to be comitted back to GitLab. This also allows developers to work on your website on their local machine, and have all changes by synced back to Forestry.
Importing from GitLab
To import a site with GitLab, login to Forestry and follow these instructions:
From the dashboard, click “Add Site”. In the modal the opens, choose “Import existing site”.
Choose the static site generator your site is built with from the dropdown, and then press “Next”.
Now, choose “GitLab” from the list of options.
This will redirect you to GitLab, and prompt you to enter your login credentials if you are not already logged in.
Give Forestry access to your GitLab repositories by clicking “Authorize”. You can also request access to any GitLab Groups you are a member of.
In order to import a site from GitLab, you will need master 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, and then press “Next”.
If Forestry can’t locate your site’s config file inside of the root of your project, you’ll be prompted to provide the directory it is located in. Tell us what your site should be named inside of Forestry, as well as an optionally provide a URL to the public location of your website, and then click Next.
In the final step, you’ll be prompted to choose a hosting provider. Choose “Commit to source repo only” to have Forestry commit all changes back to your repository, or click Skip this step.
Importing from GitLab Groups
If you are trying to import a repository from a GitLab Group you are a member of, you will need master permissions on the actual repository you are trying to import.
Applying master permissions to a group does not effect its members when importing. Members must be given master access on a per-repository basis.
Caught a mistake or want to contribute to the docs? Edit this page on Github!