Update README

djjudas21 · Mar 27, 2023 · 4b6b7bc · 4b6b7bc
1 parent 7e88b59
commit 4b6b7bc
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,17 @@
 Universal database backup script for MySQL/MariaDB and PostgreSQL.
 
 This is intended to be run in Kubernetes via the [Helm chart](https://github.com/djjudas21/charts)
+
+dbdump accepts the following arguments, set as environment variables.
+
+| Argument          | Meaning                      | Example                              |
+|-------------------|------------------------------|--------------------------------------|
+| `DBDUMP_DEBUG`    | Enable debug output          | `true` or `false`                    |
+| `DBDUMP_TYPE`     | Database engine              | `mysql` or `postgresql`              |
+| `DBDUMP_HOST`     | Hostname of database server  | `mysql.example.com` or `192.168.1.1` |
+| `DBDUMP_DB`       | Database schema to back up   | `mydata`                             |
+| `DBDUMP_ALL_DB`   | Enable backup of all schemas | `true` or `false`                    |
+| `DBDUMP_PORT`     | TCP port of database server  | `3306` or `5432`                     |
+| `DBDUMP_USER`     | Username for database server | `root` or `postgres`                 |
+| `DBDUMP_PASSWORD` | Password for database server | `pAsSwOrD`                           |
+| `DBDUMP_OPTS`     | Extra options for dump       |                                      |