Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions to build Babelfish with kerberos authentication enabled #1554

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions INSTALLING.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ sudo apt-get update && sudo apt install -y --no-install-recommends \
gnupg unixodbc-dev net-tools unzip
```

If you would like to work with Kerberos authentication then additional dependency is required on `libkrb5-dev` package.

Many of the Babelfish prerequisites are part of a typical Linux distribution. You may find that the packages on your distribution use a similar (but not identical) name.

To build Babelfish, you will need access to a user with root privileges, so you can convey privileges with `sudo`. You'll also need a non-root user to initialize the database; PostgreSQL does not allow a root user to own the `data` directory or start the server.
Expand Down Expand Up @@ -108,6 +110,7 @@ make DESTDIR=${BABELFISH_HOME}/ -j $JOBS 2>error.txt

sudo make install
```
> NOTE: To build Babelfish with Kerberos authentication support, use the option `--with-gssapi` during configuration.

> WARNING: Using the --with-extra-version option during the configuration phase can break the sys.get_host_os() output; we do not recommend including it.

Expand Down
8 changes: 8 additions & 0 deletions contrib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,3 +235,11 @@ For detailed instructions on how to write, add, and run tests in JDBC test frame
babelfish_db=> CREATE EXTENSION tds_fdw;
CREATE EXTENSION
```


# How to build the Babelfish server with Kerberos authentication enabled

Please note that Kerberos authentication feature is available on Babelfish server with version 3.1.0 or higher.

1. To build the Babelfish server with Kerberos authentication enabled, you will need to install `build-essential` and `libkrb5-dev` packages.
2. Build the Babelfish server according to the instructions mentioned [here](https://github.com/babelfish-for-postgresql/babelfish_extensions/blob/BABEL_3_X_DEV/contrib/README.md#build-the-postgres-engine) and use --with-gssapi flag to configure Babelfish in order to enable the GSSAPI APIs.