mirror of
https://github.com/yrutschle/sslh.git
synced 2025-04-18 17:57:39 +03:00
Enhance documentation about compiling;
make disabling landlock in Makefile possible, as single point of configuration
This commit is contained in:
parent
316e9a1863
commit
72a4376248
@ -3,7 +3,9 @@ VERSION=$(shell ./genver.sh -r)
|
|||||||
|
|
||||||
# Configuration -- you probably need to `make clean` if you
|
# Configuration -- you probably need to `make clean` if you
|
||||||
# change any of these
|
# change any of these
|
||||||
# landlock is checked by `configure` and set in config.h
|
|
||||||
|
# uncomment the following line to disable landlock
|
||||||
|
# override undefine HAVE_LANDLOCK
|
||||||
ENABLE_SANITIZER= # Enable ASAN/LSAN/UBSAN
|
ENABLE_SANITIZER= # Enable ASAN/LSAN/UBSAN
|
||||||
ENABLE_REGEX=1 # Enable regex probes
|
ENABLE_REGEX=1 # Enable regex probes
|
||||||
USELIBCONFIG=1 # Use libconfig? (necessary to use configuration files)
|
USELIBCONFIG=1 # Use libconfig? (necessary to use configuration files)
|
||||||
|
@ -30,6 +30,8 @@ Dependencies
|
|||||||
* [libcap](http://packages.debian.org/source/unstable/libcap-dev), in package `libcap-dev`.
|
* [libcap](http://packages.debian.org/source/unstable/libcap-dev), in package `libcap-dev`.
|
||||||
You can compile with or without it using USELIBCAP in the Makefile
|
You can compile with or without it using USELIBCAP in the Makefile
|
||||||
|
|
||||||
|
* [libconfig++-dev](https://packages.debian.org/bookworm/libconfig++-dev), in package `lìbconfig++-dev`
|
||||||
|
|
||||||
* libbsd, to enable to change the process name (as shown in `ps`,
|
* libbsd, to enable to change the process name (as shown in `ps`,
|
||||||
so each forked process shows what protocol and what connection it is serving),
|
so each forked process shows what protocol and what connection it is serving),
|
||||||
which requires `libbsd` at runtime, and `libbsd-dev` at compile-time.
|
which requires `libbsd` at runtime, and `libbsd-dev` at compile-time.
|
||||||
@ -59,13 +61,16 @@ The test scripts are written in Perl, and will require
|
|||||||
|
|
||||||
Compilation
|
Compilation
|
||||||
-----------
|
-----------
|
||||||
|
First you have to run `./configure` in the _**./sslh**_ directory. After this,
|
||||||
After this, the Makefile should work:
|
the Makefile is created, and you can do your configuration changes in the Makefile.
|
||||||
|
After each run of ./configure, those changes are gone and the Makefile is recreated.
|
||||||
make install
|
|
||||||
|
|
||||||
There are a couple of configuration options at the beginning of the Makefile:
|
There are a couple of configuration options at the beginning of the Makefile:
|
||||||
|
|
||||||
|
* `# override undefine HAVE_LANDLOCK` if you uncomment this line, sslh will be compiled
|
||||||
|
without landlock. As an alternative ./configure creates a config.h file,
|
||||||
|
which gives also the possibility, to comment that out.
|
||||||
|
|
||||||
* `USELIBWRAP` compiles support for host access control (see `hosts_access(3)`),
|
* `USELIBWRAP` compiles support for host access control (see `hosts_access(3)`),
|
||||||
you will need `libwrap` headers and library to compile (`libwrap0-dev` in Debian).
|
you will need `libwrap` headers and library to compile (`libwrap0-dev` in Debian).
|
||||||
|
|
||||||
@ -77,6 +82,9 @@ There are a couple of configuration options at the beginning of the Makefile:
|
|||||||
|
|
||||||
* `USELIBBSD` compiles support for updating the process name (as shown by `ps`).
|
* `USELIBBSD` compiles support for updating the process name (as shown by `ps`).
|
||||||
|
|
||||||
|
Now you can do either a plain `make` to create the binaries, or you can do an
|
||||||
|
`make install` to create the binaries and install them.
|
||||||
|
|
||||||
|
|
||||||
Generating the configuration parser
|
Generating the configuration parser
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
@ -76,10 +76,10 @@ Configuration goes like this on the server side, using `stunnel3`:
|
|||||||
Capabilities support
|
Capabilities support
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
On Linux (only?), you can compile sslh with `USELIBCAP=1` to
|
On Linux (only?), you can compile sslh with `USELIBCAP=1` set
|
||||||
make use of POSIX capabilities; this will save the required
|
in the Makefile to make use of POSIX capabilities; this will
|
||||||
capabilities needed for transparent proxying for unprivileged
|
save the required capabilities needed for transparent proxying
|
||||||
processes.
|
for unprivileged processes.
|
||||||
|
|
||||||
Alternatively, you may use filesystem capabilities instead
|
Alternatively, you may use filesystem capabilities instead
|
||||||
of starting sslh as root and asking it to drop privileges.
|
of starting sslh as root and asking it to drop privileges.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user