summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgor Drozdov <idrozdov@gitlab.com>2023-01-04 14:08:08 +0000
committerIgor Drozdov <idrozdov@gitlab.com>2023-01-04 14:08:08 +0000
commitfad8b772cf64a9513528385d6391ceec7b19ac1f (patch)
tree646a9c2e9fe58fde610c35cf7bfc48f5ccd6652e
parent977a7e80f03db2d2e2646abfc6ad9d95bfc71fb9 (diff)
downloadgitlab-shell-igor.drozdov-main-patch-40896.tar.gz
Add a note in the docs about Kerberos implementationigor.drozdov-main-patch-40896
-rw-r--r--doc/beginners_guide.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/beginners_guide.md b/doc/beginners_guide.md
index f75ce73..38d76ad 100644
--- a/doc/beginners_guide.md
+++ b/doc/beginners_guide.md
@@ -6,6 +6,24 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Beginner's guide to GitLab Shell contributions
+In order to build the binaries a single `make` command can be run:
+
+```shell
+make
+```
+
+If the command fails due to an error in `gssapi`, make sure that a `Kerberos` implementation is installed. For MacOS it's:
+
+```shell
+brew install heimdal
+```
+
+It may also require specifying `CGO_CFLAGS`:
+
+```shell
+CGO_CFLAGS="-I/opt/homebrew/opt/heimdal/include" make
+```
+
## Check
Checks if GitLab API access and Redis via internal API can be reached: