aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Alexis Degrugillier <aledeg@users.noreply.github.com> 2021-01-08 19:45:36 -0500
committerGravatar GitHub <noreply@github.com> 2021-01-09 01:45:36 +0100
commit5e4c392cf23fbfd2198ad93a163d982fc84b0e52 (patch)
tree704e8e2650b68b2cecbd7c2f8021bf5a971f8d56 /docs
parent69060cda334fb8e8b6e08d71665c63e13cfdc095 (diff)
Document the SQLite utilities usage (#3344)
There is a CLI command to export from any database to a SQLite database and also a CLI command to import a SQLite database to any database than need to be documented. See #961
Diffstat (limited to 'docs')
-rw-r--r--docs/en/admins/05_Backup.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/en/admins/05_Backup.md b/docs/en/admins/05_Backup.md
index f3ead0cca..03fb8a7d1 100644
--- a/docs/en/admins/05_Backup.md
+++ b/docs/en/admins/05_Backup.md
@@ -49,7 +49,28 @@ You can export your feed list in OPML format either from the web interface, or f
### 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:
+**If you are using MySQL**
+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>
```
+
+**From any database**
+You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md) to export your database to a SQLite database file:
+```
+./cli/export-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite>
+```
+> Note that the database filename needs the `sqlite` extension in order to work properly.
+
+You can use the [Command-Line Interface](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md) again to import the SQLite database file into your database:
+```
+./cli/import-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite>
+```
+> Again, note that the database filename needs the `sqlite` extension in order to work properly.
+
+The SQLite process is useful when you need to:
+- export a user fully,
+- backup your service,
+- migrate the service to another server,
+- change database type,
+- fix database corruptions.