@@ -5,7 +5,7 @@ FlareSync is a lightweight Rust application that automatically updates your Clou
55## Features
66- Periodically checks your current public IP address.
77- Updates your Cloudflare DNS records only when necessary.
8- - Asynchronous operation powered by Tokio for efficiency.
8+ - Asynchronous operation powered by ` tokio ` for efficiency.
99- Detailed and structured logging with ` log4rs ` .
1010- Dockerised for easy deployment.
1111- Backup of DNS records before updates.
@@ -30,7 +30,7 @@ FlareSync is a lightweight Rust application that automatically updates your Clou
3030#### Local Build
31311 . Clone the repository:
3232 ``` bash
33- git clone https://github.com/your-username/flaresync .git
33+ git clone https://github.com/BattermanZ/FlareSync .git
3434 cd flaresync
3535 ```
36362 . Build the project:
@@ -58,7 +58,11 @@ FlareSync is a lightweight Rust application that automatically updates your Clou
5858 ```
5959
6060#### Using Docker Compose
61- Create a ` docker-compose.yml ` file in the project root with the following content:
61+ 1 . Build the Docker image:
62+ ``` bash
63+ docker build -t flaresync:latest .
64+ ```
65+ 2 . Create a ` docker-compose.yml ` file in the project root with the following content:
6266
6367``` yaml
6468version : ' 3.8'
@@ -112,9 +116,9 @@ The following diagram shows the overall system architecture of FlareSync:
112116+-------------------+ +------------------+ +-------------------+
113117| Public IP API | <---> | FlareSync | <---> | Cloudflare API |
114118+-------------------+ +------------------+ +-------------------+
115- | | |
116- | | |
117- [Check IP] [Update DNS Record] [Update Confirmed]
119+ | | |
120+ | | |
121+ [Check IP] [Update DNS Record] [Update Confirmed]
118122` ` `
119123This diagram helps illustrate how FlareSync interacts with public IP services and Cloudflare to maintain updated DNS records.
120124
@@ -130,4 +134,4 @@ Contributions are welcome! Please open an issue or submit a pull request.
130134- Thanks to [Cloudflare](https://www.cloudflare.com/) for their powerful API.
131135
132136# # Contact
133- For any questions or issues, feel free to open an issue on this repository or reach out via email at [your-email@example.com] .
137+ For any questions or issues, feel free to open an issue on this repository.
0 commit comments