Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

GitHub Backend

lorry was designed with Gitlab as a backend in mind. As such, it is not compiled with GitHub support by default; to use GitHub as your mirroring host, you should compile with the github feature flag set. The GitHub backend has some differences in behaviour to the default Gitlab backend, due to GitHub not behaving the same way as Gitlab and thus being unable to support the same operations.

The first of these is that GitHub does not support arbitrary namespacing. This makes the prefix field somewhat dangeous. Since currently the backend only supports mirroring into the lorry user’s personal namespace, the prefix field should be set to the lorry user’s username. Once the backend supports mirroring into Organisations, prefix should be set to the name of the organisation to mirror into.

Also, GitHub scans commits for leaked secret tokens. This means that repositories containing what looks like a secret token will be rejected, stopping mirroring. If this occurs, you should disable secret scanning on the lorry user account and in the repository you are mirroring into.