From e92b1d76d46c1af2c0592d9e65bdcce74f7140ae Mon Sep 17 00:00:00 2001 From: Shikiryu Date: Mon, 17 Aug 2015 13:34:15 +0200 Subject: [PATCH] Adding configurations docs --- docs/configuration/backup/files.md | 16 ++++++++++++++++ docs/configuration/backup/mysql.md | 25 +++++++++++++++++++++++++ docs/configuration/transport/email.md | 21 +++++++++++++++++++++ docs/configuration/transport/ftp.md | 21 +++++++++++++++++++++ 4 files changed, 83 insertions(+) create mode 100644 docs/configuration/backup/files.md create mode 100644 docs/configuration/backup/mysql.md create mode 100644 docs/configuration/transport/email.md create mode 100644 docs/configuration/transport/ftp.md diff --git a/docs/configuration/backup/files.md b/docs/configuration/backup/files.md new file mode 100644 index 0000000..9436246 --- /dev/null +++ b/docs/configuration/backup/files.md @@ -0,0 +1,16 @@ +# Files backup configuration + + ## JSON +``` +"Files": { + "files": [ + "/path/to/file1", + "/path/to/file2" + ] +} +``` + ## General +File path should be absolute + + ## Options +files (mandatory) = array of file paths \ No newline at end of file diff --git a/docs/configuration/backup/mysql.md b/docs/configuration/backup/mysql.md new file mode 100644 index 0000000..c249b6b --- /dev/null +++ b/docs/configuration/backup/mysql.md @@ -0,0 +1,25 @@ +# Mysql backup configuration + + ## JSON +``` +"Mysql": { + "host" : "mysql address", + "login" : "mysql login", + "pwd" : "mysql password", + "db" : "mysql database", + "tables": [ + "" + ] +} +``` + ## General +You can indicate "*" or nothing into tables to save every tables in the selected database. + + ## Options +host (mandatory) = mysql host +login (mandatory) = mysql login +pwd (mandatory) = mysql password +db (mandatory) = database where the tables you want to save are in. +tables (mandatory) = array of tables + + diff --git a/docs/configuration/transport/email.md b/docs/configuration/transport/email.md new file mode 100644 index 0000000..051149f --- /dev/null +++ b/docs/configuration/transport/email.md @@ -0,0 +1,21 @@ +# Email transport configuration + + ## JSON +``` +"Email": { + "to" : "recipient@example.net;recipient2@example.net", + "from" : "from@example.net", + "encoding" : "UTF-8", + "subject" : "[Example.net] backup of the day", + "message" : "Hi,\n\nYou can find your backup in this mail.\n\nRegards,\nMyself." +} +``` + ## General +Emails are formated like this "email@domain.com" or like this "email@domain.com" + + ## Options +to (mandatory) = email addresses you want to send the backup to. Separated by semi-colon if more than one +from (mandatory) = person who send the backup by email. +encoding = email text encoding. Should stay with "UTF-8" or removed. +subject (mandatory)= email subject +message (mandatory)= email content sent as txt \ No newline at end of file diff --git a/docs/configuration/transport/ftp.md b/docs/configuration/transport/ftp.md new file mode 100644 index 0000000..eccfc7a --- /dev/null +++ b/docs/configuration/transport/ftp.md @@ -0,0 +1,21 @@ +# FTP transport configuration + + ## JSON +``` +"Ftp": { + "host" : "ftp.domain.com", + "login" : "login", + "password" : "password", + "folder" : "/folder" +}, +``` + ## General +- + + ## Options +host (mandatory) = ftp host without schema ("ftp://") +login = ftp login (mandatory if not anonymous) +password = ftp password (mandatory if not anonymous) +folder = the folder you want to put the backup in. If not set, the backup will be put in the ftp root + +