Improve backup docs by clarifying requirements to create a fully functional backup

[schnerring]

The Backup docs state:

Remark42 by default makes daily backup files under ${BACKUP_PATH}

I was under the impression that by downloading the contents of the ${BACKUP_PATH}, I have a series of fully functional backups of my Remark42 server. After playing around with moving Remark42 hosts and restoring those backups, I found that avatars of existing comments were broken, however. At first I thought I had to somehow re-generate / re-cache avatars, but I think that isn't possible.

Under Technical Details of the Backend Docs it's stated that:

To migrate/move Remark42 to another host, boltdb files and avatars directory AVATAR_FS_PATH should be transferred. Optionally, boltdb can be used to store avatars as well.

Looking over the CLI parameters docs, I think that IMAGE_FS_PATH (or IMAGE_BOLT_FILE if IMAGE_TYPE is bolt) also has to be considered (I think this is where inline comment images are stored?).

What about IMAGE_FS_STAGING?

---

I think the backup docs aren't crystal clear on what else needs to be backed up besides automatic/manual backups. We should at least mention the relevant paths to backup when running Remark with the default configuration:

• AVATAR_FS_PATH, i.e., ./var/avatars
• IMAGE_FS_PATH, i.e., ./var/pictures

Anything I missed?

If you agree on this issue, I can open a PR to extend the docs.

[paskal]

IMAGE_FS_STAGING - you don't need to care about it, on the instance restart these images should be moved to IMAGE_FS_PATH storage, if I'm not mistaken.

Can you please send the PR with an update? I'll test the text after your updates to make sure it works properly.

[paskal]

@schnerring I'm still very keen on receiving a PR from you.

[schnerring]

I haven't forgotten about this issue: it's still a TODO on my long list of GitHub notifications. I'll get to it eventually 😉