Skip to content

Commit 4c8c14b

Browse files
committed
add features section
1 parent 7a30fef commit 4c8c14b

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Welcome to the **`Backhaul`** project! This project provides a high-performance
77
## Table of Contents
88

99
1. [Introduction](#introduction)
10-
2. [Installation](#installation)
11-
3. [Usage](#usage)
10+
2. [Features](#features)
11+
3. [Installation](#installation)
12+
4. [Usage](#usage)
1213
- [Configuration Options](#configuration-options)
1314
- [Detailed Configuration](#detailed-configuration)
1415
- [TCP Configuration](#tcp-configuration)
@@ -17,19 +18,34 @@ Welcome to the **`Backhaul`** project! This project provides a high-performance
1718
- [Secure WebSocket Configuration](#secure-websocket-configuration)
1819
- [WS Multiplexing Configuration](#ws-multiplexing-configuration)
1920
- [WSS Multiplexing Configuration](#wss-multiplexing-configuration)
20-
4. [Generating a Self-Signed TLS Certificate with OpenSSL](#generating-a-self-signed-tls-certificate-with-openssl)
21-
5. [Running backhaul as a service](#running-backhaul-as-a-service)
22-
6. [FAQ](#faq)
23-
7. [Benchmark](#benchmark)
24-
8. [License](#license)
25-
9. [Donation](#donation)
21+
5. [Generating a Self-Signed TLS Certificate with OpenSSL](#generating-a-self-signed-tls-certificate-with-openssl)
22+
6. [Running backhaul as a service](#running-backhaul-as-a-service)
23+
7. [FAQ](#faq)
24+
8. [Benchmark](#benchmark)
25+
9. [License](#license)
26+
10. [Donation](#donation)
2627

2728
---
2829

2930
## Introduction
3031

3132
This project offers a robust reverse tunneling solution to overcome NAT and firewall restrictions, supporting various transport protocols. It’s engineered for high efficiency and concurrency.
3233

34+
35+
## Features
36+
37+
* **High Performance**: Optimized for handling massive concurrent connections efficiently.
38+
* **Protocol Flexibility**: Supports TCP, WebSocket (WS), and Secure WebSocket (WSS) transports.
39+
* **UDP over TCP**: Implements UDP traffic encapsulation and forwarding over a TCP connection for reliable delivery with built-in congestion control.
40+
* **Multiplexing**: Enables multiple connections over a single transport with SMUX.
41+
* **NAT & Firewall Bypass**: Overcomes restrictions with reverse tunneling.
42+
* **Traffic Sniffing**: Optional network traffic monitoring with logging support.
43+
* **Configurable Keepalive**: Adjustable keep-alive and heartbeat intervals for stable connections.
44+
* **TLS Encryption**: Secure connections via WSS with support for custom TLS certificates.
45+
* **Web Interface**: Real-time monitoring through a lightweight web interface.
46+
* **Hot Reload Configuration**: Supports dynamic configuration reloading without server restarts.
47+
48+
3349
## Installation
3450

3551
1. **Download** the latest release from the [GitHub releases page](https://github.com/musixal/backhaul/releases).

0 commit comments

Comments
 (0)