Skip to content

Commit b2d4b3c

Browse files
author
Phil Pennock
committed
Merge branch 'readme_updates'
Reviewed-In: https://github.com/apcera/gssapi/pull/33
2 parents 0e31b35 + 073a91b commit b2d4b3c

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,29 @@ service ticket, which we verify with a keytab on our authentication server.
1212
When a user logs into Kerberos using `kinit`, they get a Kerberos TGT. During
1313
Kerberos authentication, that TGT is used to retrieve a Service Ticket from the
1414
Domain Controller. GSSAPI lets us authenticate without having to know where or
15-
in what form the TGT is stored.
15+
in what form the TGT is stored. Because each operating system vendor might
16+
move that, this package wraps your system GSSAPI implementation.
1617

1718
What do you use it for? Let us know!
1819

20+
## Building
21+
22+
This library is `go get` compatible. However, it also requires header files
23+
to build against the GSSAPI C library on your platform.
24+
25+
Golang needs to be able to find a gcc compiler (and one which is recent enough
26+
to support gccgo). If the system compiler isn't gcc, then use `CC` in environ
27+
to point the Golang build tools at your gcc. (LLVM's clang does not work and
28+
Golang's diagnostics if it encounters clang are to spew a lot of
29+
apparently-unrelated errors from trying to use it anyway).
30+
31+
On MacOS, the default headers are too old; you can use newer headers for
32+
building but still use the normal system libraries.
33+
34+
* FreeBSD: `export CC=gcc48; go install`
35+
* MacOS: `brew install homebrew/dupes/heimdal --without-x11`
36+
* Ubuntu: see `apt-get` in `test/docker/client/Dockerfile`
37+
1938
## Testing
2039

2140
Tests in the main `gssapi` repository can be run using the built-in `go test`.

0 commit comments

Comments
 (0)