Skip to content

Commit

Permalink
docs: translate to english some text in dumpsync.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kremilly committed Oct 29, 2024
1 parent f52ec35 commit e106c35
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# DumpSync

---
Title: DumpSync
Category: Crate
Description: A simple tool for dump and restore a MySQL database. It can be used for backup and restore purposes, or for transferring a database from one server to another.
Package: cargo install dumpsync
---
A simple tool for dump and restore a MySQL database. It can be used for backup and restore purposes, or for transferring a database from one server to another.

## Overview

This tool allows for automatic dumps of a MySQL database at configurable time intervals, saving the files in a specified directory. Configuration can be done via environment variables or command-line arguments, providing flexibility for different usage contexts.

## Installation

To install the tool, you can use the following command:
To Install using [crates.io](https://crates.io):

```bash
cargo install dumpsync
```
> [!install] cargo install dumpsync
### Parameters

Expand All @@ -33,15 +33,15 @@ The tool uses three main parameters, which can be configured via arguments or en
- **Command-Line Argument**: `--folder`
- **Environment Variable**: `DS_DUMP_PATH`
- **Behavior**: If the `--folder` argument is provided, it will be used. Otherwise, the `DS_DUMP_PATH` environment variable will be used.
4. **Database Host (`db_host`)**: O endereço do host do banco de dados.
4. **Database Host (`db_host`)**: The address of the database host.

- **Environment Variable**: `DB_HOST`

5. **Database Port (`db_port`)**: O número da porta do banco de dados.
5. **Database Port (`db_port`)**: The port number of the database.

- **Environment Variable**: `DB_PORT`

#### Usage Example
### Usage Example

**Command-Line Arguments**:

Expand All @@ -62,7 +62,7 @@ DS_DUMP_INTERVAL="3600"
DS_DUMP_PATH="/path/to/"
```

#### Notes
### Notes

- The tool requires read and write permissions in the directory set for `backup_path`.
- The MySQL database must be accessible for the dump to proceed.
Expand Down

0 comments on commit e106c35

Please sign in to comment.