summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2023-11-01 05:31:25 +0000
committerAndrew Dolgov <[email protected]>2023-11-01 05:31:25 +0000
commit69110f91e6e36c61e0fab95bbaea881d6593130c (patch)
tree85bb08de844256775151d1f137fea2064561c8f3
parent48f8ad7feed95476cc332e829fc57ef0ef97e7a7 (diff)
Update README.md
-rw-r--r--README.md29
1 files changed, 22 insertions, 7 deletions
diff --git a/README.md b/README.md
index a878551..129bb2f 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,27 @@
# Data migration plugin
-Migrates user articles using a neutral format (JSON in a ZIP archive). Can be used
-to transfer articles between different database types (i.e. MySQL to PostgreSQL).
+This plugin exports and imports *all* articles of a specific user using a neutral format (JSON files in a ZIP archive). This way you can migrate your entire article dataset between different tt-rss instances even if they are not sharing a common database backend, i.e. MySQL to PostgreSQL.
-## Installation
+Note that this only migrates articles. You can transfer your tt-rss settings and feed subscriptions via OPML import/export before migrating data with this plugin.
-1. Git clone to ``/plugins.local/data_migration``
-2. Enable in ``PLUGINS`` directive of ``config.php``
-3. Plugin is invoked using command line: ``php ./update.php --help``
+Migrating between different tt-rss versions might work but is not recommended.
-See the [wiki](https://dev.tt-rss.org/fox/ttrss-data-migration/wiki) for more information.
+Plugin is in development, I suggest testing your import first on a separate test user (or database) for the time being.
+
+### Using the plugin
+
+1. Git checkout to ``plugins.local/data_migration``
+2. Enable plugin in ``config.php`` by adding ``data_migration`` to ``PLUGINS`` directive
+3. Plugin-specific options should appear in ``update.php`` help output (``php ./update.php --help``)
+
+#### Exporting data
+
+```
+php ./update.php --data_user test --data_export articles-of-user-test.zip
+```
+
+#### Importing data
+
+```
+php ./update.php --data_user test --data_import articles-of-user-test.zip
+```