README.md in pg_export-0.7.7 vs README.md in pg_export-1.0.0.rc1

- old
+ new

@@ -24,11 +24,11 @@ - uses ruby tempfiles, so local dumps are garbage collected automatically - easy restoring dumps through interactive mode ## Dependencies - * Ruby >= 2.3.0 + * Ruby >= 2.4 (works with Ruby 3.0) * $ pg_dump * $ pg_restore ## Installation @@ -49,48 +49,51 @@ ## CLI $ pg_export -h Usage: pg_export [options] + -g, --gateway GATEWAY [Optional] ssh or ftp (default: ftp) -d, --database DATABASE [Required] Name of the database to export -k, --keep [KEEP] [Optional] Number of dump files to keep on FTP (default: 10) -t, --timestamped [Optional] Enables log messages with timestamps -m, --muted [Optional] Mutes log messages (overrides -t option) -i, --interactive [Optional] Interactive command line mode - for restoring dumps into databases + -v, --version Show version -h, --help Show this message - + Setting can be verified by running following commands: -c, --configuration Prints the configuration - -f, --ftp Tries connecting to FTP to verify the connection + -w, --welcome Tries connecting to the gateway (FTP or SSH) to verify the connection + ## How to start __Step 1.__ Prepare ENV variables. /* FTP storage for database dumps. */ - BACKUP_FTP_HOST=yourftp.example.com - BACKUP_FTP_USER=user - BACKUP_FTP_PASSWORD=password + PG_EXPORT_GATEWAY_HOST=yourftp.example.com + PG_EXPORT_GATEWAY_USER=user + PG_EXPORT_GATEWAY_PASSWORD=password /* Encryption key shoul have exactly 16 characters. */ /* Dumps will be SSL(AES-128-CBC) encrypted using this key. */ - DUMP_ENCRYPTION_KEY=1234567890abcdef + PG_EXPORT_ENCRYPTION_KEY=1234567890abcdef /* Dumps to be kept on FTP */ /* Optional, defaults to 10 */ KEEP_DUMPS=5 Note, that variables cannot include `#` sign, [more info](http://serverfault.com/questions/539730/environment-variable-in-etc-environment-with-pound-hash-sign-in-the-value). __Step 2.__ Print the configuration to verify if env variables has been loaded properly. $ pg_export --configuration - => {:dump_encryption_key=>"k4***", :ftp_host=>"yourftp.example.com", :ftp_user=>"your_ftp_user", - :ftp_password=>"pass***", :logger_format=>"plain", :keep_dumps=>2} + => {:dump_encryption_key=>"k4***", :gateway_host=>"yourftp.example.com", :gateway_user=>"your_gateway_user", + :gateway_password=>"pass***", :logger_format=>"plain", :keep_dumps=>2} __Step 3.__ Try connecting to FTP to verify the connection. - $ pg_export --ftp + $ pg_export --gateway ftp --welcome => 230 User your_ftp_user logged in __Step 4.__ Perform database export. $ pg_export -d your_database [-k 5]