[github/shaarli/Shaarli.git] / doc / md / Backup,-restore,-import-and-export.md

## Backup and restore the datastore file

Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place.

Example command:
```bash
rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
```

## Export links as...

To export links as an HTML file, under _Tools > Export_, choose:

- _Export all_ to export both public and private links
- _Export public_ to export public links only
- _Export private_ to export private links only

Restore by using the `Import` feature.

- This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool.

Example command: 
```bash
./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
```

## Import links from...

### Diigo

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.)

### Mister Wong

See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks.

### SemanticScuttle

To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase).

### Scuttle

Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle).

However, you can use the third-party [scuttle-to-shaarli](https://github.com/q2apro/scuttle-to-shaarli)
tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.

## Import Shaarli links to Firefox

- Export your Shaarli links as described above.
    - For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)`
- In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`)
- Select `Import and Backup > Import bookmarks in HTML format`

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.

You may be interested in these Firefox addons to manage links imported from Shaarli

- [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks
- [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags
Commit	Line	Data
	1	## Backup and restore the datastore file
	2
	3	Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place.
	4
	5	Example command:
	6	```bash
	7	rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
	8	```
	9
	10	## Export links as...
	11
	12	To export links as an HTML file, under _Tools > Export_, choose:
	13
	14	- _Export all_ to export both public and private links
	15	- _Export public_ to export public links only
	16	- _Export private_ to export private links only
	17
	18	Restore by using the `Import` feature.
	19
	20	- This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool.
	21
	22	Example command:
	23	```bash
	24	./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
	25	```
	26
	27	## Import links from...
	28
	29	### Diigo
	30
	31	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.)
	32
	33	### Mister Wong
	34
	35	See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks.
	36
	37	### SemanticScuttle
	38
	39	To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase).
	40
	41	### Scuttle
	42
	43	Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle).
	44
	45	However, you can use the third-party [scuttle-to-shaarli](https://github.com/q2apro/scuttle-to-shaarli)
	46	tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.
	47
	48	## Import Shaarli links to Firefox
	49
	50	- Export your Shaarli links as described above.
	51	- For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)`
	52	- In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`)
	53	- Select `Import and Backup > Import bookmarks in HTML format`
	54
	55	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.
	56
	57	You may be interested in these Firefox addons to manage links imported from Shaarli
	58
	59	- [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks
	60	- [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags