From d7f888392678d711478ed64f4a52f43021d143af Mon Sep 17 00:00:00 2001 From: Patrick Date: Tue, 22 Oct 2019 05:17:12 -0400 Subject: Docs update (#2164) * Update Readme.conf Add information in Readme.conf to hopefully stop bug reports about intended behavior. * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update Readme * Update Documentation Section * Add main Documentation link near top of Document * Make Documentation header a link * Fix spelling mistake I didn't catch * Apply suggestions from code review Co-Authored-By: pattems * Changes per Frenzie comments * Move non-disclaiming disclaimer * English Admin Documentation Update * Add Backup section * Update wording in Index * Move Footnotes to End * Move Footnote * Add content for todos * Fix typos * Fix a bunch of typos * Remove a duplicated file (forgotten during dev merge) * Improve the documentation a bit --- docs/en/admins/05_Backup.md | 55 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/en/admins/05_Backup.md (limited to 'docs/en/admins/05_Backup.md') 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 `` is your database username, `` is the hostname of your web server containing your FreshRSS database, and `` is the database used by FreshRSS: +``` +mysqldump --skip-comments --disable-keys --user= --password --host --result-file=freshrss.dump.sql --databases +``` -- cgit v1.2.3