Skip to content

Commit 4e14f5f

Browse files
committed
Upaded README.md added docker info, added table of contents
1 parent 8b5294e commit 4e14f5f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,27 @@
1515

1616
With a focus on high performance, it utilizes batching heavily and uses C++ extension for faster execution. This tool ensures seamless data integration with support for migrations, schema changes, and correct data management.
1717

18+
## Table of Contents
19+
- [Features](#features)
20+
- [Installation](#installation)
21+
- [Requirements](#requirements)
22+
- [Installation](#installation-1)
23+
- [Docker Installation](#docker-installation)
24+
- [Usage](#usage)
25+
- [Basic Usage](#basic-usage)
26+
- [One Time Data Copy](#one-time-data-copy)
27+
- [Configuration](#configuration)
28+
- [Required settings](#required-settings)
29+
- [Optional settings](#optional-settings)
30+
- [Advanced Features](#advanced-features)
31+
- [Migrations & Schema Changes](#migrations--schema-changes)
32+
- [Recovery Without Downtime](#recovery-without-downtime)
33+
- [Development](#development)
34+
- [Running Tests](#running-tests)
35+
- [Contribution](#contribution)
36+
- [License](#license)
37+
- [Acknowledgements](#acknowledgements)
38+
1839
## Features
1940

2041
- **Real-Time Replication**: Keeps your ClickHouse database in sync with MySQL in real-time.
@@ -40,6 +61,29 @@ pip install mysql_ch_replicator
4061

4162
You may need to also compile C++ components if they're not pre-built for your platform.
4263

64+
### Docker Installation
65+
66+
Alternatively, you can use the pre-built Docker image from DockerHub:
67+
68+
```bash
69+
docker pull fippo/mysql-ch-replicator:latest
70+
```
71+
72+
To run the container:
73+
74+
```bash
75+
docker run -d \
76+
-v /path/to/your/config.yaml:/app/config.yaml \
77+
-v /path/to/your/data:/app/data \
78+
fippo/mysql-ch-replicator:latest \
79+
--config /app/config.yaml run_all
80+
```
81+
82+
Make sure to:
83+
1. Mount your configuration file using the `-v` flag
84+
2. Mount a persistent volume for the data directory
85+
3. Adjust the paths according to your setup
86+
4387
## Usage
4488

4589
### Basic Usage

0 commit comments

Comments
 (0)