Using Private Git Submodules with Forestry
If your website uses submodules from private repos, you will need to configure your site to allow Forestry to access these submodules. For sites stored on GitHub or GitLab, our quick setup flow will not grant the correct permissions. This flow adds a deploy key to your GitHub or GitLab repo, which only grants access to a single repository and will not allow Forestry to install private submodules.
To use a site containing private submodules with Forestry, you will need to change the way Forestry authenticates with Github/GitLab.
- Remove Forestry.io deploy key from the repository settings, e.g. (
- In your Forestry site, head to Settings > Repository, show and copy the public key
- Add your site’s public key as a user-level key (GitHub/GitLab). This user must have access to these private submodules.
Caught a mistake or want to contribute to the docs? Edit this page on Github!