aboutsummaryrefslogtreecommitdiff
path: root/docs/en/admins/05_Backup.md
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-10-31 18:15:47 +0100
committerGravatar GitHub <noreply@github.com> 2019-10-31 18:15:47 +0100
commit3aa66f317b496ccd9a2df914bbc747c52081a7ad (patch)
tree6a3f3f74899801abdca00546e213dfdc141c53cf /docs/en/admins/05_Backup.md
parent82611c9622ed23b0e9fcf5f9f651ddffa1fd7706 (diff)
parentfcae48f313d399050cb15f37a8a73ae52fc67796 (diff)
Merge pull request #2599 from FreshRSS/dev1.15.0
FreshRSS 1.15
Diffstat (limited to 'docs/en/admins/05_Backup.md')
-rw-r--r--docs/en/admins/05_Backup.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/en/admins/05_Backup.md b/docs/en/admins/05_Backup.md
new file mode 100644
index 000000000..f3ead0cca
--- /dev/null
+++ b/docs/en/admins/05_Backup.md
@@ -0,0 +1,55 @@
+# 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.
+
+## Installation Backup
+
+Do this before an upgrade.
+
+### Creating a Backup
+
+First, Enter the directory you wish to save your backup to. Here, for example, we'll save the backup to the user home directory
+```
+cd ~
+```
+
+Next, we'll create a gzipped tar archive of the FreshRSS directory. The following command will archive the entire contents of your FreshRSS installation in it's current state.
+```
+tar -czf FreshRSS-backup.tgz -C /usr/share/FreshRSS/ .
+```
+
+And you're done!
+
+### Restoring from a Backup
+
+First, copy the backup previously made into your FreshRSS directory
+```
+cp ~/FreshRSS-backup.tgz /usr/share/FreshRSS/
+```
+
+Next, change to your FreshRSS directory
+```
+cd /usr/share/FreshRSS/
+```
+
+Extract the backup
+```
+tar -xzf FreshRSS-backup.tgz
+```
+
+And optionally, as cleanup, remove the copy of your backup from the FreshRSS directory
+```
+rm FreshRSS-backup.tgz
+```
+
+## Backing up Feeds
+
+### Feed list Export
+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/master/cli/README.md).
+
+### Saving Articles
+
+To save articles, you can use [phpMyAdmin](https://www.phpmyadmin.net/) or MySQL tools, where `<db_user>` is your database username, `<db_host>` is the hostname of your web server containing your FreshRSS database, and `<freshrss_db>` is the database used by FreshRSS:
+```
+mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db>
+```