docs(#566): add docs for GHES

Signed-off-by: Andy Augustin <[email protected]>

README.md

@@ -569,6 +569,22 @@ This feature will force delete files if those are deelted within the source repo
 :warning: it is highly related to the `git_remote_pull_params` config parameter and won't work with the default.
 You need to change the default one e.g. to `git_remote_pull_params: --allow-unrelated-histories --strategy=recursive --no-edit`.
 
+## GHES and custom runners
+
+Some notes if you use GitHub Enterprise Server (GHES) and/or custom runners.
+The action script is based on bash. That means your runner must be able to run bash scripts.
+Furthermore you need to have the following command line tools installed:
+
+* ssh
+* [GitHub cli][gh-cli]
+* git
+* optional (dependent on the )
+  * [git lfs][git-lfs] if you are using the lfs functionality
+  * [yq][yq] if you are using the hook functionality
+  * gpg if you are using the git signing functionality
+
+Furthermore most likely you have a custom domain name. Therefore you should configure the `hostname` GitHub action parameter.
+
 ## Troubleshooting
 
 * refusing to allow a GitHub App to create or update workflow `.github/workflows/******.yml` without `workflows` permission
@@ -762,3 +778,6 @@ specification. Contributions of any kind are welcome!
 [github-create-secret]: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository
 [github-create-gpg-key]: https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key
 [github-gh-cli-pr-edit]: https://cli.github.com/manual/gh_pr_edit
+[gh-cli]: https://github.com/cli/cli
+[yq]: https://github.com/mikefarah/yq
+[git-lfs]: https://github.com/git-lfs/git-lfs