doc/html/Backup,-restore,-import-and-export/index.html

   1 <!DOCTYPE html>
   2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   4 <head>
   5   <meta charset="utf-8">
   6   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   8
   9
  10   <link rel="shortcut icon" href="../img/favicon.ico">
  11   <title>Backup, restore, import and export - Shaarli Documentation</title>
  12   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  13
  14   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  16   <link rel="stylesheet" href="../css/highlight.css">
  17   <link href="../github-markdown.css" rel="stylesheet">
  18
  19   <script>
  20     // Current page data
  21     var mkdocs_page_name = "Backup, restore, import and export";
  22     var mkdocs_page_input_path = "Backup,-restore,-import-and-export.md";
  23     var mkdocs_page_url = "/Backup,-restore,-import-and-export/";
  24   </script>
  25
  26   <script src="../js/jquery-2.1.1.min.js"></script>
  27   <script src="../js/modernizr-2.8.3.min.js"></script>
  28   <script type="text/javascript" src="../js/highlight.pack.js"></script>
  29
  30 </head>
  31
  32 <body class="wy-body-for-nav" role="document">
  33
  34   <div class="wy-grid-for-nav">
  35
  36
  37     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  38       <div class="wy-side-nav-search">
  39         <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  40         <div role="search">
  41   <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  42     <input type="text" name="q" placeholder="Search docs" />
  43   </form>
  44 </div>
  45       </div>
  46
  47       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  48         <ul class="current">
  49
  50
  51             <li class="toctree-l1">
  52
  53     <a class="" href="..">Home</a>
  54             </li>
  55
  56             <li class="toctree-l1">
  57
  58     <span class="caption-text">Setup</span>
  59     <ul class="subnav">
  60                 <li class="">
  61
  62     <a class="" href="../Download-and-Installation/">Download and Installation</a>
  63                 </li>
  64                 <li class="">
  65
  66     <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  67                 </li>
  68                 <li class="">
  69
  70     <a class="" href="../Server-requirements/">Server requirements</a>
  71                 </li>
  72                 <li class="">
  73
  74     <a class="" href="../Server-configuration/">Server configuration</a>
  75                 </li>
  76                 <li class="">
  77
  78     <a class="" href="../Server-security/">Server security</a>
  79                 </li>
  80                 <li class="">
  81
  82     <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  83                 </li>
  84                 <li class="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../Docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../Shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../Docker-resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class="">
 119
 120     <a class="" href="../Features/">Features</a>
 121                 </li>
 122                 <li class="">
 123
 124     <a class="" href="../Bookmarklet/">Bookmarklet</a>
 125                 </li>
 126                 <li class="">
 127
 128     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 129                 </li>
 130                 <li class="">
 131
 132     <a class="" href="../Firefox-share/">Firefox share</a>
 133                 </li>
 134                 <li class="">
 135
 136     <a class="" href="../RSS-feeds/">RSS feeds</a>
 137                 </li>
 138                 <li class="">
 139
 140     <a class="" href="../REST-API/">REST API</a>
 141                 </li>
 142     </ul>
 143             </li>
 144
 145             <li class="toctree-l1">
 146
 147     <span class="caption-text">How To</span>
 148     <ul class="subnav">
 149                 <li class=" current">
 150
 151     <a class="current" href="./">Backup, restore, import and export</a>
 152     <ul class="subnav">
 153
 154     <li class="toctree-l3"><a href="#backup-and-restore-the-datastore-file">Backup and restore the datastore file</a></li>
 155
 156
 157     <li class="toctree-l3"><a href="#export-links-as">Export links as...</a></li>
 158
 159
 160     <li class="toctree-l3"><a href="#import-links-from">Import links from...</a></li>
 161
 162         <ul>
 163
 164             <li><a class="toctree-l4" href="#diigo">Diigo</a></li>
 165
 166             <li><a class="toctree-l4" href="#mister-wong">Mister Wong</a></li>
 167
 168             <li><a class="toctree-l4" href="#semanticscuttle">SemanticScuttle</a></li>
 169
 170             <li><a class="toctree-l4" href="#scuttle">Scuttle</a></li>
 171
 172         </ul>
 173
 174
 175     <li class="toctree-l3"><a href="#import-shaarli-links-to-firefox">Import Shaarli links to Firefox</a></li>
 176
 177
 178     </ul>
 179                 </li>
 180                 <li class="">
 181
 182     <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
 183                 </li>
 184                 <li class="">
 185
 186     <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
 187                 </li>
 188                 <li class="">
 189
 190     <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
 191                 </li>
 192                 <li class="">
 193
 194     <a class="" href="../Datastore-hacks/">Datastore hacks</a>
 195                 </li>
 196     </ul>
 197             </li>
 198
 199             <li class="toctree-l1">
 200
 201     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 202             </li>
 203
 204             <li class="toctree-l1">
 205
 206     <span class="caption-text">Development</span>
 207     <ul class="subnav">
 208                 <li class="">
 209
 210     <a class="" href="../Development-guidelines/">Development guidelines</a>
 211                 </li>
 212                 <li class="">
 213
 214     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 215                 </li>
 216                 <li class="">
 217
 218     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 219                 </li>
 220                 <li class="">
 221
 222     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 223                 </li>
 224                 <li class="">
 225
 226     <a class="" href="../Directory-structure/">Directory structure</a>
 227                 </li>
 228                 <li class="">
 229
 230     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 231                 </li>
 232                 <li class="">
 233
 234     <a class="" href="../Plugin-System/">Plugin System</a>
 235                 </li>
 236                 <li class="">
 237
 238     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 239                 </li>
 240                 <li class="">
 241
 242     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 243                 </li>
 244                 <li class="">
 245
 246     <a class="" href="../Security/">Security</a>
 247                 </li>
 248                 <li class="">
 249
 250     <a class="" href="../Static-analysis/">Static analysis</a>
 251                 </li>
 252                 <li class="">
 253
 254     <a class="" href="../Theming/">Theming</a>
 255                 </li>
 256                 <li class="">
 257
 258     <a class="" href="../Unit-tests/">Unit tests</a>
 259                 </li>
 260     </ul>
 261             </li>
 262
 263             <li class="toctree-l1">
 264
 265     <span class="caption-text">About</span>
 266     <ul class="subnav">
 267                 <li class="">
 268
 269     <a class="" href="../FAQ/">FAQ</a>
 270                 </li>
 271                 <li class="">
 272
 273     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 274                 </li>
 275     </ul>
 276             </li>
 277
 278         </ul>
 279       </div>
 280       &nbsp;
 281     </nav>
 282
 283     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 284
 285
 286       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 287         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 288         <a href="..">Shaarli Documentation</a>
 289       </nav>
 290
 291
 292       <div class="wy-nav-content">
 293         <div class="rst-content">
 294           <div role="navigation" aria-label="breadcrumbs navigation">
 295   <ul class="wy-breadcrumbs">
 296     <li><a href="..">Docs</a> &raquo;</li>
 297
 298
 299
 300           <li>How To &raquo;</li>
 301
 302
 303
 304     <li>Backup, restore, import and export</li>
 305     <li class="wy-breadcrumbs-aside">
 306
 307         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Backup,-restore,-import-and-export.md"
 308           class="icon icon-github"> Edit on GitHub</a>
 309
 310     </li>
 311   </ul>
 312   <hr/>
 313 </div>
 314           <div role="main">
 315             <div class="section">
 316
 317                 <ul>
 318 <li><a href="#backup-and-restore-the-datastore-file">Backup and restore the datastore file</a></li>
 319 <li><a href="#export-links-as">Export links as...</a></li>
 320 <li><a href="#import-links-from">Import links from...</a></li>
 321 <li><a href="#import-shaarli-links-to-firefox">Import Shaarli links to Firefox</a></li>
 322 </ul>
 323 <hr />
 324 <h2 id="backup-and-restore-the-datastore-file">Backup and restore the datastore file</h2>
 325 <p>Backup the file <code>data/datastore.php</code> (by FTP or SSH). Restore by putting the file back in place.</p>
 326 <p>Example command:</p>
 327 <pre><code class="bash">rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
 328 </code></pre>
 329
 330 <h2 id="export-links-as">Export links as...</h2>
 331 <p>To export links as an HTML file, under <em>Tools &gt; Export</em>, choose:
 332 - <em>Export all</em> to export both public and private links
 333 - <em>Export public</em> to export public links only
 334 - <em>Export private</em> to export private links only</p>
 335 <p>Restore by using the <code>Import</code> feature.
 336 * This can be done using the <a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> tool.</p>
 337 <p>Example command: </p>
 338 <pre><code class="bash">./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
 339 </code></pre>
 340
 341 <h2 id="import-links-from">Import links from...</h2>
 342 <h3 id="diigo">Diigo</h3>
 343 <p>If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)</p>
 344 <h3 id="mister-wong">Mister Wong</h3>
 345 <p>See <a href="https://github.com/sebsauvage/Shaarli/issues/146">this issue</a> for import tweaks.</p>
 346 <h3 id="semanticscuttle">SemanticScuttle</h3>
 347 <p>To correctly import the tags from a <a href="http://semanticscuttle.sourceforge.net/">SemanticScuttle</a> HTML export, edit the HTML file before importing and replace all occurences of <code>tags=</code> (lowercase) to <code>TAGS=</code> (uppercase).</p>
 348 <h3 id="scuttle">Scuttle</h3>
 349 <p>Shaarli cannot import data directly from <a href="https://github.com/scronide/scuttle">Scuttle</a>. However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.</p>
 350 <h2 id="import-shaarli-links-to-firefox">Import Shaarli links to Firefox</h2>
 351 <ul>
 352 <li>Export your Shaarli links as described above.</li>
 353 <li>For compatibility reasons, check <code>Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)</code></li>
 354 <li>In Firefox, open the bookmark manager (not the sidebar! <code>Bookmarks menu &gt; Show all bookmarks</code> or <code>Ctrl+Shift+B</code>)</li>
 355 <li>Select <code>Import and Backup &gt; Import bookmarks in HTML format</code></li>
 356 </ul>
 357 <p>Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.</p>
 358 <p>You may be interested in these Firefox addons to manage links imported from Shaarli</p>
 359 <ul>
 360 <li><a href="https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/">Bookmark Deduplicator</a> - provides an easy way to deduplicate your bookmarks</li>
 361 <li><a href="https://addons.mozilla.org/en-US/firefox/addon/tagsieve/">TagSieve</a> - browse your bookmarks by their tags</li>
 362 </ul>
 363
 364             </div>
 365           </div>
 366           <footer>
 367
 368     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 369
 370         <a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" class="btn btn-neutral float-right" title="Copy an existing installation over SSH and serve it locally">Next <span class="icon icon-circle-arrow-right"></span></a>
 371
 372
 373         <a href="../REST-API/" class="btn btn-neutral" title="REST API"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 374
 375     </div>
 376
 377
 378   <hr/>
 379
 380   <div role="contentinfo">
 381     <!-- Copyright etc -->
 382
 383   </div>
 384
 385   Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 386 </footer>
 387
 388         </div>
 389       </div>
 390
 391     </section>
 392
 393   </div>
 394
 395   <div class="rst-versions" role="note" style="cursor: pointer">
 396     <span class="rst-current-version" data-toggle="rst-current-version">
 397
 398           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 399
 400
 401         <span><a href="../REST-API/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 402
 403
 404         <span style="margin-left: 15px"><a href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/" style="color: #fcfcfc">Next &raquo;</a></span>
 405
 406     </span>
 407 </div>
 408     <script src="../js/theme.js"></script>
 409
 410 </body>
 411 </html>