docs: update ssh and ftp deployment example

jkaninda · Oct 2, 2024 · 34ad549 · 34ad549
1 parent 82d27f6
commit 34ad549
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/how-tos/backup-to-ftp.md b/docs/how-tos/backup-to-ftp.md
@@ -30,7 +30,7 @@ services:
       - DB_USERNAME=username
       - DB_PASSWORD=password
       ## FTP config
-      - FTP_HOST_NAME="hostname"
+      - FTP_HOST="hostname"
       - FTP_PORT=21
       - FTP_USER=user
       - FTP_PASSWORD=password

diff --git a/docs/how-tos/backup-to-ssh.md b/docs/how-tos/backup-to-ssh.md
@@ -33,7 +33,7 @@ services:
       - DB_USERNAME=username
       - DB_PASSWORD=password
       ## SSH config
-      - SSH_HOST_NAME="hostname"
+      - SSH_HOST="hostname"
       - SSH_PORT=22
       - SSH_USER=user
       - REMOTE_PATH=/home/jkaninda/backups
@@ -73,7 +73,7 @@ services:
       - DB_USERNAME=username
       - DB_PASSWORD=password
       ## SSH config
-      - SSH_HOST_NAME="hostname"
+      - SSH_HOST="hostname"
       - SSH_PORT=22
       - SSH_USER=user
       - REMOTE_PATH=/home/jkaninda/backups
@@ -124,7 +124,7 @@ spec:
               # Please use secret!
               - name: DB_PASSWORD
                 value: ""
-              - name: SSH_HOST_NAME
+              - name: SSH_HOST
                 value: ""
               - name: SSH_PORT
                 value: "22"

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -47,16 +47,17 @@ Backup, restore and migrate targets, schedule and retention are configured using
 | AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                   |
 | AWS_REGION             | Optional, required for S3 storage                             | AWS Region                                           |
 | AWS_DISABLE_SSL        | Optional, required for S3 storage                             | Disable SSL                                          |
+| AWS_FORCE_PATH_STYLE   | Optional, required for S3 storage                             | Force path style                                     |
 | FILE_NAME              | Optional if it was provided from the --file flag              | Database file to restore (extensions: .sql, .sql.gz) |
 | GPG_PASSPHRASE         | Optional, required to encrypt and restore backup              | GPG passphrase                                       |
 | BACKUP_CRON_EXPRESSION | Optional if it was provided from the `--cron-expression` flag | Backup cron expression for docker in scheduled mode  |
-| SSH_HOST_NAME          | Optional, required for SSH storage                            | ssh remote hostname or ip                            |
+| SSH_HOST               | Optional, required for SSH storage                            | ssh remote hostname or ip                            |
 | SSH_USER               | Optional, required for SSH storage                            | ssh remote user                                      |
 | SSH_PASSWORD           | Optional, required for SSH storage                            | ssh remote user's password                           |
 | SSH_IDENTIFY_FILE      | Optional, required for SSH storage                            | ssh remote user's private key                        |
 | SSH_PORT               | Optional, required for SSH storage                            | ssh remote server port                               |
 | REMOTE_PATH            | Optional, required for SSH or FTP storage                     | remote path (/home/toto/backup)                      |
-| FTP_HOST_NAME          | Optional, required for FTP storage                            | FTP host name                                        |
+| FTP_HOST               | Optional, required for FTP storage                            | FTP host name                                        |
 | FTP_PORT               | Optional, required for FTP storage                            | FTP server port number                               |
 | FTP_USER               | Optional, required for FTP storage                            | FTP user                                             |
 | FTP_PASSWORD           | Optional, required for FTP storage                            | FTP user password                                    |