From 578a05e0e325d61d0c38a6e4aa11a7ba9de14736 Mon Sep 17 00:00:00 2001 From: maTh Date: Mon, 11 Apr 2022 22:56:52 +0200 Subject: Docs: improve backup section (#4290) * Update 05_Backup.md * Update 05_Backup.md * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge Co-authored-by: Frans de Jonge --- docs/en/admins/05_Backup.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/en/admins/05_Backup.md b/docs/en/admins/05_Backup.md index ccc7810aa..c4ad11cd0 100644 --- a/docs/en/admins/05_Backup.md +++ b/docs/en/admins/05_Backup.md @@ -1,12 +1,16 @@ # Backup -This tutorial demonstrates commands for backing up FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you’ve installed it somewhere else, substitute your path as necessary. +FreshRSS global settings are in `./data/config.php` and users' settings are in `./data/users/*/config.php`. You can also back up the whole `./data/` directory but exclude the things you do not want. -## Installation Backup +If you use extensions, then each directory in `./extensions` the folder `static` contains the user's extension settings. + +## Full-Installation Backup Do this before an upgrade. -### Creating a Backup +This following tutorial demonstrates commands for backing up FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`. If you’ve installed it somewhere else, substitute your path as necessary. + +### Creating a Backup of all Files First, Enter the directory you wish to save your backup to. Here, for example, we’ll save the backup to the user home directory @@ -22,7 +26,7 @@ tar -czf FreshRSS-backup.tgz -C /usr/share/FreshRSS/ . And you’re done! -### Restoring from a Backup +### Restoring Files from a Backup First, copy the backup previously made into your FreshRSS directory @@ -54,6 +58,10 @@ rm FreshRSS-backup.tgz You can export your feed list in OPML format either from the web interface, or from the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/README.md). +The OPML export only exports the standard OPML parameters and does not export things such as desired refresh frequency, custom attributes such as passwords, user agent, XPath Web scraping, etc. + +To export all that, use a full back-up with export-to-sqlite, as described in the following section. + ### Saving Articles **If you are using MySQL** -- cgit v1.2.3