Browse Source

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
Alexis Degrugillier 5 years ago
parent
commit
5e4c392cf2
2 changed files with 47 additions and 7 deletions
  1. 25 6
      README.fr.md
  2. 22 1
      docs/en/admins/05_Backup.md

+ 25 - 6
README.fr.md

@@ -158,12 +158,31 @@ Créer `/etc/cron.d/FreshRSS` avec :
 # Sauvegarde
 * Il faut conserver vos fichiers `./data/config.php` ainsi que `./data/users/*/config.php`
 * Vous pouvez exporter votre liste de flux au format OPML soit depuis l’interface Web, soit [en ligne de commande](cli/README.md)
-* Pour sauvegarder les articles eux-mêmes, vous pouvez utiliser [phpMyAdmin](https://www.phpmyadmin.net) ou les outils de MySQL :
-
-```bash
-mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db>
-```
-
+* Pour sauvegarder les articles eux-mêmes :
+    * **Dans le cas où vous utilisez MySQL**  
+	Vous pouvez utiliser [phpMyAdmin](https://www.phpmyadmin.net) ou les outils de MySQL :
+		```bash
+		mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db>
+		```
+	* **Pour toutes les bases supportées**  
+	Vous pouvez utiliser la [ligne de commande](cli/README.md) pour exporter votre base de données vers une base de données au format SQLite :
+		```
+		./cli/export-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite>
+		```
+		> Il est impératif que le nom du fichier contenant la base de données ait une extension `sqlite`. Si ce n'est pas le cas, la commande ne fonctionnera pas correctement.
+
+		Vous pouvez encore utiliser la [ligne de commande](cli/README.md) pour importer la base de données au format SQLite dans votre base de données:
+		```
+		./cli/import-sqlite-for-user.php --user <username> --filename </path/to/db.sqlite>
+		```
+		> Encore une fois, il est impératif que le nom du fichier contenant la base de données ait une extension `sqlite`. Si ce n'est pas le cas, la commande ne fonctionnera pas correctement.
+
+		Le processus d'import/export à l'aide d'une base de données SQLite est utile quand vous devez :
+		- exporter complètement les données d'un utilisateur,
+		- sauvegarder votre service,
+		- migrer votre service sur un autre serveur,
+		- changer de type de base de données,
+		- corriger des erreurs de base de données.
 
 # Extensions
 FreshRSS permet l’ajout d’extensions en plus des fonctionnalités natives.

+ 22 - 1
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.