Merge pull request #85 from jkaninda/docs

Docs

README.md

@@ -1,5 +1,5 @@
 # MySQL Backup
-MySQL Backup is a Docker container image that can be used to backup and restore MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
+MySQL Backup is a Docker container image that can be used to backup, restore and migrate MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
 It also supports __encrypting__ your backups using GPG.
 
 The [jkaninda/mysql-bkup](https://hub.docker.com/r/jkaninda/mysql-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes.

cmd/root.go

@@ -33,7 +33,6 @@ func Execute() {
 
 func init() {
 	rootCmd.PersistentFlags().StringP("dbname", "d", "", "Database name")
-	rootCmd.PersistentFlags().StringVarP(&operation, "operation", "o", "", "Set operation, for old version only")
 	rootCmd.AddCommand(VersionCmd)
 	rootCmd.AddCommand(BackupCmd)
 	rootCmd.AddCommand(RestoreCmd)

docker/Dockerfile

@@ -38,6 +38,8 @@ ENV TARGET_DB_PASSWORD=""
 ARG DEBIAN_FRONTEND=noninteractive
 ENV VERSION="v1.2.5"
 ENV BACKUP_CRON_EXPRESSION=""
+ENV TG_TOKEN=""
+ENV TG_CHAT_ID=""
 ARG WORKDIR="/config"
 ARG BACKUPDIR="/backup"
 ARG BACKUP_TMP_DIR="/tmp/backup"

docs/Dockerfile

@@ -1,12 +0,0 @@
-FROM ruby:3.3.4
-
-ENV LC_ALL C.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US.UTF-8
-
-WORKDIR /usr/src/app
-
-COPY . ./
-RUN gem install bundler && bundle install
-
-EXPOSE 4000

docs/docker-compose.yml

@@ -1,13 +0,0 @@
-services:
-  jekyll:
-    build:
-      context: ./
-    ports:
-      - 4000:4000
-    environment:
-      - JEKYLL_ENV=development
-    volumes:
-      - .:/usr/src/app
-    stdin_open: true
-    tty: true
-    command: bundle exec jekyll serve -H 0.0.0.0 -t

pkg/backup.go

@@ -19,7 +19,7 @@ import (
 )
 
 func StartBackup(cmd *cobra.Command) {
-	utils.Welcome()
+	intro()
 	//Set env
 	utils.SetEnv("STORAGE_PATH", storagePath)
 	utils.GetEnv(cmd, "period", "BACKUP_CRON_EXPRESSION")
@@ -116,6 +116,10 @@ func scheduledMode(db *dbConfig, storage string) {
 		fmt.Println(line.Text)
 	}
 }
+func intro() {
+	utils.Info("Starting MySQL Backup...")
+	utils.Info("Copyright © 2024 Jonas Kaninda ")
+}
 
 // BackupDatabase backup database
 func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool) {
@@ -243,6 +247,8 @@ func s3Backup(db *dbConfig, backupFileName string, disableCompression bool, prun
 	//Delete temp
 	deleteTemp()
 }
+
+// sshBackup backup database to SSH remote server
 func sshBackup(db *dbConfig, backupFileName, remotePath string, disableCompression bool, prune bool, backupRetention int, encrypt bool) {
 	utils.Info("Backup database to Remote server")
 	//Backup database
@@ -278,6 +284,8 @@ func sshBackup(db *dbConfig, backupFileName, remotePath string, disableCompressi
 	//Delete temp
 	deleteTemp()
 }
+
+// encryptBackup encrypt backup
 func encryptBackup(backupFileName string) {
 	gpgPassphrase := os.Getenv("GPG_PASSPHRASE")
 	err := Encrypt(filepath.Join(tmpPath, backupFileName), gpgPassphrase)

pkg/helper.go

@@ -118,8 +118,7 @@ func testDatabaseConnection(db *dbConfig) {
 	cmd.Stderr = &out
 	err := cmd.Run()
 	if err != nil {
-		utils.Error("Error testing database connection: %v\nOutput: %s", err, out.String())
+		utils.Fatal("Error testing database connection: %v\nOutput: %s", err, out.String())
-		os.Exit(1)
 
 	}
 	utils.Info("Successfully connected to %s database", db.dbName)

pkg/migrate.go

@@ -14,7 +14,7 @@ import (
 )
 
 func StartMigration(cmd *cobra.Command) {
-	utils.Welcome()
+	intro()
 	utils.Info("Starting database migration...")
 	//Get DB config
 	dbConf = getDbConfig(cmd)

pkg/restore.go

@@ -16,7 +16,7 @@ import (
 )
 
 func StartRestore(cmd *cobra.Command) {
-	utils.Welcome()
+	intro()
 	//Set env
 	utils.SetEnv("STORAGE_PATH", storagePath)
 

utils/notification.go

@@ -1,75 +0,0 @@
-package utils
-
-import (
-	"bytes"
-	"encoding/json"
-	"fmt"
-	"io/ioutil"
-	"net/http"
-	"os"
-)
-
-func sendMessage(msg string) {
-
-	Info("Sending notification... ")
-	chatId := os.Getenv("TG_CHAT_ID")
-	body, _ := json.Marshal(map[string]string{
-		"chat_id": chatId,
-		"text":    msg,
-	})
-	url := fmt.Sprintf("%s/sendMessage", getTgUrl())
-	// Create an HTTP post request
-	request, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
-	if err != nil {
-		panic(err)
-	}
-	request.Header.Add("Content-Type", "application/json")
-	client := &http.Client{}
-	response, err := client.Do(request)
-	if err != nil {
-		panic(err)
-	}
-	code := response.StatusCode
-	if code == 200 {
-		Info("Notification has been sent")
-	} else {
-		body, _ := ioutil.ReadAll(response.Body)
-		Error("Message not sent, error: %s", string(body))
-	}
-
-}
-func NotifySuccess(fileName string) {
-	var vars = []string{
-		"TG_TOKEN",
-		"TG_CHAT_ID",
-	}
-
-	//Telegram notification
-	err := CheckEnvVars(vars)
-	if err == nil {
-		message := "PostgreSQL Backup \n" +
-			"Database has been backed up \n" +
-			"Backup name is " + fileName
-		sendMessage(message)
-	}
-}
-func NotifyError(error string) {
-	var vars = []string{
-		"TG_TOKEN",
-		"TG_CHAT_ID",
-	}
-
-	//Telegram notification
-	err := CheckEnvVars(vars)
-	if err == nil {
-		message := "PostgreSQL Backup \n" +
-			"An error occurred during database backup \n" +
-			"Error: " + error
-		sendMessage(message)
-	}
-}
-
-func getTgUrl() string {
-	return fmt.Sprintf("https://api.telegram.org/bot%s", os.Getenv("TG_TOKEN"))
-
-}

utils/utils.go

@@ -7,10 +7,14 @@
 package utils
 
 import (
+	"bytes"
+	"encoding/json"
 	"fmt"
 	"github.com/spf13/cobra"
 	"io"
 	"io/fs"
+	"io/ioutil"
+	"net/http"
 	"os"
 	"strconv"
 )
@@ -153,13 +157,6 @@ func CheckEnvVars(vars []string) error {
 
 	return nil
 }
-func Welcome() {
-	fmt.Println()
-	fmt.Println("**********************************")
-	fmt.Println("            MySQL Backup          ")
-	fmt.Println("     @Copyright © 2024 jkaninda    ")
-	fmt.Println("***********************************")
-}
 
 // MakeDir create directory
 func MakeDir(dirPath string) error {
@@ -189,3 +186,67 @@ func GetIntEnv(envName string) int {
 	}
 	return ret
 }
+func sendMessage(msg string) {
+
+	Info("Sending notification... ")
+	chatId := os.Getenv("TG_CHAT_ID")
+	body, _ := json.Marshal(map[string]string{
+		"chat_id": chatId,
+		"text":    msg,
+	})
+	url := fmt.Sprintf("%s/sendMessage", getTgUrl())
+	// Create an HTTP post request
+	request, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
+	if err != nil {
+		panic(err)
+	}
+	request.Header.Add("Content-Type", "application/json")
+	client := &http.Client{}
+	response, err := client.Do(request)
+	if err != nil {
+		panic(err)
+	}
+	code := response.StatusCode
+	if code == 200 {
+		Info("Notification has been sent")
+	} else {
+		body, _ := ioutil.ReadAll(response.Body)
+		Error("Message not sent, error: %s", string(body))
+	}
+
+}
+func NotifySuccess(fileName string) {
+	var vars = []string{
+		"TG_TOKEN",
+		"TG_CHAT_ID",
+	}
+
+	//Telegram notification
+	err := CheckEnvVars(vars)
+	if err == nil {
+		message := "PostgreSQL Backup \n" +
+			"Database has been backed up \n" +
+			"Backup name is " + fileName
+		sendMessage(message)
+	}
+}
+func NotifyError(error string) {
+	var vars = []string{
+		"TG_TOKEN",
+		"TG_CHAT_ID",
+	}
+
+	//Telegram notification
+	err := CheckEnvVars(vars)
+	if err == nil {
+		message := "PostgreSQL Backup \n" +
+			"An error occurred during database backup \n" +
+			"Error: " + error
+		sendMessage(message)
+	}
+}
+
+func getTgUrl() string {
+	return fmt.Sprintf("https://api.telegram.org/bot%s", os.Getenv("TG_TOKEN"))
+
+}