diff --git a/README.md b/README.md index ed18486..f827a93 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ To run a one time backup, bind your local volume to `/backup` in the container a docker run --rm --network your_network_name \ -v $PWD/backup:/backup/ \ -e "DB_HOST=dbhost" \ + -e "DB_PORT=3306" \ -e "DB_USERNAME=username" \ -e "DB_PASSWORD=password" \ jkaninda/mysql-bkup backup -d database_name @@ -87,7 +88,19 @@ Alternatively, pass a `--env-file` in order to use a full config as described be -v $PWD/backup:/backup/ \ jkaninda/mysql-bkup backup -d database_name ``` +### Simple restore using Docker CLI +To restore a database, bind your local volume to `/backup` in the container and run the `restore` command: + +```shell + docker run --rm --network your_network_name \ + -v $PWD/backup:/backup/ \ + -e "DB_HOST=dbhost" \ + -e "DB_PORT=3306" \ + -e "DB_USERNAME=username" \ + -e "DB_PASSWORD=password" \ + jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz +``` ### Simple backup in docker compose file ```yaml diff --git a/docs/quickstart/index.md b/docs/quickstart/index.md index 92393b8..6437152 100644 --- a/docs/quickstart/index.md +++ b/docs/quickstart/index.md @@ -18,6 +18,7 @@ To run a one-time backup, bind your local volume to `/backup` in the container a docker run --rm --network your_network_name \ -v $PWD/backup:/backup/ \ -e "DB_HOST=dbhost" \ + -e "DB_PORT=3306" \ -e "DB_USERNAME=username" \ -e "DB_PASSWORD=password" \ jkaninda/mysql-bkup backup -d database_name @@ -34,6 +35,19 @@ docker run --rm --network your_network_name \ jkaninda/mysql-bkup backup -d database_name ``` +### Simple restore using Docker CLI + +To restore a database, bind your local volume to `/backup` in the container and run the `restore` command: + +```shell + docker run --rm --network your_network_name \ + -v $PWD/backup:/backup/ \ + -e "DB_HOST=dbhost" \ + -e "DB_PORT=3306" \ + -e "DB_USERNAME=username" \ + -e "DB_PASSWORD=password" \ + jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz +``` --- ## Simple Backup Using Docker Compose diff --git a/pkg/config.go b/pkg/config.go index 6026daf..726a9b6 100644 --- a/pkg/config.go +++ b/pkg/config.go @@ -114,7 +114,7 @@ func initDbConfig(cmd *cobra.Command) *dbConfig { utils.GetEnv(cmd, "dbname", "DB_NAME") dConf := dbConfig{} dConf.dbHost = os.Getenv("DB_HOST") - dConf.dbPort = os.Getenv("DB_PORT") + dConf.dbPort = utils.EnvWithDefault("DB_PORT", "3306") dConf.dbName = os.Getenv("DB_NAME") dConf.dbUserName = os.Getenv("DB_USERNAME") dConf.dbPassword = os.Getenv("DB_PASSWORD")