README.md
1sslh -- A ssl/ssh multiplexer
2=============================
3
4`sslh` accepts connections on specified ports, and forwards
5them further based on tests performed on the first data
6packet sent by the remote client.
7
8Probes for HTTP, TLS/SSL (including SNI and ALPN), SSH,
9OpenVPN, tinc, XMPP, SOCKS5, are implemented, and any other
10protocol that can be tested using a regular expression, can
11be recognised. A typical use case is to allow serving
12several services on port 443 (e.g. to connect to SSH from
13inside a corporate firewall, which almost never block port
14443) while still serving HTTPS on that port.
15
16Hence `sslh` acts as a protocol demultiplexer, or a
17switchboard. With the SNI and ALPN probe, it makes a good
18front-end to a virtual host farm hosted behind a single IP
19address.
20
21`sslh` has the bells and whistles expected from a mature
22daemon: privilege and capabilities dropping, inetd support,
23systemd support, transparent proxying,
24chroot, logging, IPv4 and IPv6, a fork-based and a
25select-based model, and more.
26
27Install
28=======
29
30Please refer to the [install guide](doc/INSTALL.md).
31
32
33Configuration
34=============
35
36Please refer to the [configuration guide](doc/config.md).
37
38
39
40Comments? Questions?
41====================
42
43You can subscribe to the `sslh` mailing list here:
44<http://rutschle.net/cgi-bin/mailman/listinfo/sslh>
45
46This mailing list should be used for discussion, feature
47requests, and will be the preferred channel for announcements.
48
49Of course, check the [FAQ](doc/FAQ.md) first!
50
51