Skip to content

Commit 3a4fa6a

Browse files
committed
Update README.md
1 parent 3e6240c commit 3a4fa6a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@ For detailed information, please consult [TCPCopy](https://github.com/session-re
77
## Installation
88

99
### Installing `intercept` on the Assistant Server
10+
1011
1. git clone git://github.com/session-replay-tools/intercept.git
1112
2. cd intercept
1213
3. ./configure --with-resp-payload
1314
4. make
1415
5. make install
1516

16-
1717
### Installing `tcpcopy` on the Online Server
18+
1819
1. git clone git://github.com/session-replay-tools/tcpcopy.git
1920
2. cd tcpcopy
2021
3. git clone git://github.com/session-replay-tools/mysql-replay-module.git
2122
4. ./configure --set-protocol-module=mysql-replay-module
2223
5. make
2324
6. make install
2425

25-
2626
## Usage Guide
27-
27+
2828
### 1. **On the Target Server Running MySQL Applications:**
2929

3030
Configure the route commands to direct response packets to the assistant server. For example, assuming `10.110.12.18` is the IP address of the assistant server and `10.110.12.15` is the MySQL client IP address, use the following route command to direct all responses from `10.110.12.15` to the assistant server:
@@ -35,12 +35,14 @@ Configure the route commands to direct response packets to the assistant server.
3535

3636
`./intercept -F <filter> -i <device>`
3737

38-
Note that the filter format is the same as the pcap filter. For example:
38+
Note that the filter format is the same as the pcap filter. For example:
3939

4040
`./intercept -i eth0 -F 'tcp and src port 3306' -d`
4141

42-
In this example, `intercept` will capture response packets from a TCP-based application listening on port 3306, using the eth0 network device.
43-
42+
In this example, `intercept` will capture response packets from a TCP-based application listening on port 3306, using the eth0 network device.
43+
44+
Please note that `ip_forward` is not enabled on the assistant server.
45+
4446
### 3. **On the Online Source Server (Root Privilege or CAP_NET_RAW Capability Required):**
4547

4648
a) Configure user password pairs in `conf/plugin.conf` within the installation directory.
@@ -52,7 +54,7 @@ Format:
5254
For example:
5355

5456
`user root@123456;`
55-
57+
5658
b) To start `tcpcopy`, use the following command:
5759

5860
`./tcpcopy -x localServerPort-targetServerIP:targetServerPort -s <intercept server> [-c <ip range>]`
@@ -63,25 +65,23 @@ For example (assuming 10.110.12.17 is the IP address of the target server):
6365

6466
`tcpcopy` captures MySQL packets (assuming MySQL listens on port 3306) on the current server, modifies them as needed, and forwards them to port 3306 on `10.110.12.17` (the target MySQL server). It also connects to `10.110.12.18` to request that `intercept` forwards the response packets to it.
6567

66-
67-
6868
## Note
69+
6970
1. User Accounts and Privileges: Both MySQL instances on the target and online servers must have identical user accounts and privileges, though passwords can differ.
7071
2. Session Replay: Only complete sessions can be replayed.
7172
3. OpenSSL Support: OpenSSL 1.1.0+ is not currently supported.
7273
4. Password Plugin Compatibility: MySQL 8.0’s caching_sha2_password is not supported. To test MySQL 8.0 using MySQL 5.7 production flows, use mysql_native_password and ensure that all users involved in the test are configured with the mysql_native_password plugin.
7374
5. For additional assistance, visit [tcpcopy](https://github.com/session-replay-tools/tcpcopy).
7475

7576
## Release History
77+
7678
+ 2017.03 v1.0 mysql-replay-module released
7779
+ 2024.09 v1.0 Open source fully uses English
7880

7981
## Bugs and Feature Requests
80-
Have a bug or a feature request? [Please open a new issue](https://github.com/session-replay-tools/mysql-replay-module/issues). Before opening any issue, please search for existing issues.
8182

83+
Have a bug or a feature request? [Please open a new issue](https://github.com/session-replay-tools/mysql-replay-module/issues). Before opening any issue, please search for existing issues.
8284

8385
## Copyright and License
8486

8587
Copyright 2024 under [the BSD license](LICENSE).
86-
87-

0 commit comments

Comments
 (0)