mirror of
https://github.com/Chouchen/Shikiryu_Backup.git
synced 2021-06-30 16:02:14 +02:00
Adding configurations docs
This commit is contained in:
parent
9c74a9601b
commit
e92b1d76d4
16
docs/configuration/backup/files.md
Normal file
16
docs/configuration/backup/files.md
Normal 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
docs/configuration/backup/mysql.md
Normal file
25
docs/configuration/backup/mysql.md
Normal 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
docs/configuration/transport/email.md
Normal file
21
docs/configuration/transport/email.md
Normal 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
docs/configuration/transport/ftp.md
Normal file
21
docs/configuration/transport/ftp.md
Normal 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…
Reference in New Issue
Block a user