Skip to content
This repository was archived by the owner on Apr 10, 2025. It is now read-only.

Commit fcf7c73

Browse files
committed
#2: Add documentation about the file variables
1 parent 009ce0f commit fcf7c73

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,22 @@ To backup a [MySQL](https://hub.docker.com/_/mysql/) or [MariaDB](https://hub.do
1515

1616
## Environment variables
1717

18-
| **Variable** | **Default** | **Mandatory** | **Description** |
19-
|:--------------|:-----------:|:-------------:|:-----------------------------------------------------|
20-
| `DB_HOST` | - | *yes* | The host to connect to |
21-
| `DB_PASS` | - | *yes* | The password for the SQL server |
22-
| `DB_NAME` | - | *no* | If specified, only this database will be backed up |
23-
| `DB_PORT` | `3306` | *no* | The port of the SQL server |
24-
| `DB_USER` | `root` | *no* | The user to connect to the SQL server |
25-
| `MODE` | `BACKUP` | *no* | One of `BACKUP` or `RESTORE` |
26-
| `BASE_DIR` | `/backup` | *no* | Path of the base directory (aka working directory) |
27-
| `RESTORE_DIR` | - | *no* | Name of a backup directory to restore |
28-
| `BACKUP_UID` | `666` | *no* | UID of the backup |
29-
| `BACKUP_GID` | `666` | *no* | GID of the backup |
30-
| `UMASK` | `0022` | *no* | Umask which should be used to write the backup files |
31-
| `OPTIONS` | `-c` / `-o` | *no* | Options passed to `mydumper` / `myloader` |
18+
| **Variable** | **FILE Support** | **Default** | **Mandatory** | **Description** |
19+
|:--------------|:----------------:|:-----------:|:-------------:|:-----------------------------------------------------|
20+
| `DB_HOST` | `DB_HOST__FILE` | - | *yes* | The host to connect to |
21+
| `DB_PASS` | `DB_PASS__FILE` | - | *yes* | The password for the SQL server |
22+
| `DB_NAME` | `DB_NAME__FILE` | - | *no* | If specified, only this database will be backed up |
23+
| `DB_PORT` | N/A | `3306` | *no* | The port of the SQL server |
24+
| `DB_USER` | `DB_USER__FILE` | `root` | *no* | The user to connect to the SQL server |
25+
| `MODE` | N/A | `BACKUP` | *no* | One of `BACKUP` or `RESTORE` |
26+
| `BASE_DIR` | N/A | `/backup` | *no* | Path of the base directory (aka working directory) |
27+
| `RESTORE_DIR` | N/A | - | *no* | Name of a backup directory to restore |
28+
| `BACKUP_UID` | N/A | `666` | *no* | UID of the backup |
29+
| `BACKUP_GID` | N/A | `666` | *no* | GID of the backup |
30+
| `UMASK` | N/A | `0022` | *no* | Umask which should be used to write the backup files |
31+
| `OPTIONS` | N/A | `-c` / `-o` | *no* | Options passed to `mydumper` / `myloader` |
32+
33+
The following environment variables support setting via `*__FILE`, where
3234

3335
Please note the backup will be written to `/backup` by default, so you might want to mount that directory from your host.
3436

0 commit comments

Comments
 (0)