add description of backup file format

2018-06-01 00:15:12 -05:00
parent d2fd46a4c2
commit aa997d5ca0
1 changed files with 6 additions and 0 deletions
@@ -127,6 +127,12 @@ In addition to automatic backups user can make a backup manually. This command m

 `docker-compose exec remark42 /srv/create-backup.sh {your site id}`

+##### Backup format
+
+Backup file is a text file with all exported comments separated by EOL. Each backup record is a valid json with all key/value
+unmarshaled from `Comment` struct (see below). 
+
+
 #### Admin users

 Admins/moderators should be defined in `docker-compose.yml` as a list of user IDs or passed in the command line.