Skip to content

Commit dc85de4

Browse files
Configurable Parameters preface description
1 parent 3c0e0cc commit dc85de4

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

ReadMe.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,23 +78,24 @@ Build from the sources (required go 1.21+):
7878
GO111MODULE=on go install github.com/Altinity/clickhouse-backup/v2/cmd/clickhouse-backup@latest
7979
```
8080

81-
## Brief description how clickhouse-backup works
81+
## Brief description of how clickhouse-backup works
8282

8383
Data files are immutable in the `clickhouse-server`.
8484
During a backup operation, `clickhouse-backup` creates file system hard links to existing `clickhouse-server` data parts via executing the `ALTER TABLE ... FREEZE` query.
8585
During the restore operation, `clickhouse-backup` copies the hard links to the `detached` folder and executes the `ALTER TABLE ... ATTACH PART` query for each data part and each table in the backup.
8686
A more detailed description is available here: https://www.youtube.com/watch?v=megsNh9Q-dw
8787

88-
## Default Config
88+
## Default Config File
8989

9090
By default, the config file is located at `/etc/clickhouse-backup/config.yml`, but it can be redefined via the `CLICKHOUSE_BACKUP_CONFIG` environment variable or via `--config` command line parameter.
9191
All options can be overwritten via environment variables.
92-
Use `clickhouse-backup default-config` to print default config.
92+
Use `clickhouse-backup default-config` to print the default config.
9393

94-
## Explain config parameters
95-
Following values is not default, it just explains which each config parameter actually means
96-
Use `clickhouse-backup print-config` to print current config.
97-
Each config parameter can be overrides via environment variables, environment variable name provides after comment character `#`.
94+
## Configurable Parameters
95+
96+
Use `clickhouse-backup print-config` to print the current config.
97+
Environment variables can override each config parameter defined in the config file. Their names should be UPPERCASE, and exact names are provided after the comment character `#.`
98+
The following values are not defaults; they explain what each config parameter with an example.
9899

99100
```yaml
100101
general:

0 commit comments

Comments
 (0)