Skip to content

Commit

Permalink
enable TLS build by default (#43)
Browse files Browse the repository at this point in the history
* enable TLS build by default

* move export to src folder

* fix comments
  • Loading branch information
Artem Danilov authored and GitHub Enterprise committed Feb 12, 2022
1 parent a7b7f40 commit ea708fb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Top level makefile, the real shit is at src/Makefile
# Top level makefile, this just calls into src/Makefile where the real work is done. Changes should be made there.

default: all

Expand Down
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,12 @@ Init and clone submodule dependencies:

Install dependencies:

% sudo apt install build-essential nasm autotools-dev autoconf libjemalloc-dev tcl tcl-dev uuid-dev libcurl4-openssl-dev libbz2-dev libzstd-dev liblz4-dev libsnappy-dev
% sudo apt install build-essential nasm autotools-dev autoconf libjemalloc-dev tcl tcl-dev uuid-dev libcurl4-openssl-dev libbz2-dev libzstd-dev liblz4-dev libsnappy-dev libssl-dev

Compiling is as simple as:

% make

To build with TLS support, you'll need OpenSSL development libraries (e.g.
libssl-dev on Debian/Ubuntu) and run:

% make BUILD_TLS=yes

To build with systemd support, you'll need systemd development libraries (such
as libsystemd-dev on Debian/Ubuntu or systemd-devel on CentOS) and run:

Expand All @@ -115,7 +110,7 @@ To append a suffix to KeyDB program names, use:
***Note that the following dependencies may be needed:
% sudo apt-get install autoconf autotools-dev libnuma-dev libtool

If TLS is built, running the tests with TLS enabled (you will need `tcl-tls`
Running the tests with TLS enabled (you will need `tcl-tls`
installed):

% ./utils/gen-test-certs.sh
Expand Down Expand Up @@ -217,11 +212,11 @@ All the options in keydb.conf are also supported as options using the command
line, with exactly the same name.


Running Redis with TLS:
Running KeyDB with TLS:
------------------

Please consult the [TLS.md](TLS.md) file for more information on
how to use Redis with TLS.
how to use KeyDB with TLS.


Playing with KeyDB
Expand Down
5 changes: 1 addition & 4 deletions TLS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ Getting Started

### Building

To build with TLS support you'll need OpenSSL development libraries (e.g.
libssl-dev on Debian/Ubuntu).

Run `make BUILD_TLS=yes`.
TLS support is enabled in the default build. To build without TLS, run `make BUILD_TLS=no`.

### Tests

Expand Down
4 changes: 4 additions & 0 deletions src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
# Dependencies are stored in the Makefile.dep file. To rebuild this file
# Just use 'make dep', but this is only needed by developers.

# we ship KeyDB with TLS by default
# export it here as both this file and deps/Makefile uses it
export BUILD_TLS ?= yes

release_hdr := $(shell sh -c './mkreleasehdr.sh')
uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
uname_M := $(shell sh -c 'uname -m 2>/dev/null || echo not')
Expand Down

0 comments on commit ea708fb

Please sign in to comment.