Browse Source

Adding configurations docs

master
Shikiryu 6 years ago
parent
commit
e92b1d76d4
4 changed files with 83 additions and 0 deletions
  1. +16
    -0
      docs/configuration/backup/files.md
  2. +25
    -0
      docs/configuration/backup/mysql.md
  3. +21
    -0
      docs/configuration/transport/email.md
  4. +21
    -0
      docs/configuration/transport/ftp.md

+ 16
- 0
docs/configuration/backup/files.md View File

@ -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

+ 25
- 0
docs/configuration/backup/mysql.md View File

@ -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

+ 21
- 0
docs/configuration/transport/email.md View File

@ -0,0 +1,21 @@
# Email transport configuration
## JSON
```
"Email": {
"to" : "recipient@example.net;recipient2@example.net",
"from" : "<name>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 "<name>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

+ 21
- 0
docs/configuration/transport/ftp.md View File

@ -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

Loading…
Cancel
Save