aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--application/HttpUtils.php60
-rw-r--r--application/LinkFilter.php2
-rw-r--r--application/LinkUtils.php6
-rw-r--r--application/NetscapeBookmarkUtils.php47
-rw-r--r--application/Url.php42
-rw-r--r--composer.json2
-rw-r--r--doc/3rd-party-libraries.html15
-rw-r--r--doc/Backup,-restore,-import-and-export.html63
-rw-r--r--doc/Browsing-and-searching.html84
-rw-r--r--doc/Browsing-and-searching.md28
-rw-r--r--doc/Coding-guidelines.html15
-rw-r--r--doc/Community-&-Related-software.html21
-rw-r--r--doc/Community-&-Related-software.md6
-rw-r--r--doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html67
-rw-r--r--doc/Create-and-serve-multiple-Shaarlis-(farm).html160
-rw-r--r--doc/Create-and-serve-multiple-Shaarlis-(farm).md58
-rw-r--r--doc/Datastore-hacks.html67
-rw-r--r--doc/Datastore-hacks.md7
-rw-r--r--doc/Development.html17
-rw-r--r--doc/Directory-structure.html63
-rw-r--r--doc/Docker.html245
-rw-r--r--doc/Docker.md157
-rw-r--r--doc/Download-CSS-styles-from-an-OPML-list.html63
-rw-r--r--doc/Download.html71
-rw-r--r--doc/Example-patch---add-new-via-field-for-links.html15
-rw-r--r--doc/FAQ.html15
-rw-r--r--doc/Firefox-share.html30
-rw-r--r--doc/GnuPG-signature.html143
-rw-r--r--doc/GnuPG-signature.md70
-rw-r--r--doc/Home.html17
-rw-r--r--doc/Home.md2
-rw-r--r--doc/Plugin-System.html222
-rw-r--r--doc/Plugin-System.md78
-rw-r--r--doc/Plugin-installation-&-configuration.html154
-rw-r--r--doc/Plugin-installation-&-configuration.md69
-rw-r--r--doc/Plugin-list.html87
-rw-r--r--doc/Plugin-list.md18
-rw-r--r--doc/RSS-feeds.html29
-rw-r--r--doc/RSS-feeds.md12
-rw-r--r--doc/Release-Shaarli.html171
-rw-r--r--doc/Release-Shaarli.md72
-rw-r--r--doc/Security.html63
-rw-r--r--doc/Server-configuration.html100
-rw-r--r--doc/Server-configuration.md28
-rw-r--r--doc/Server-requirements.html68
-rw-r--r--doc/Server-requirements.md11
-rw-r--r--doc/Server-security.html166
-rw-r--r--doc/Server-security.md60
-rw-r--r--doc/Shaarli-configuration.html84
-rw-r--r--doc/Shaarli-configuration.md24
-rw-r--r--doc/Shaarli-installation.html73
-rw-r--r--doc/Shaarli-installation.md6
-rw-r--r--doc/Sharing-button.html23
-rw-r--r--doc/Sharing-button.md12
-rw-r--r--doc/Static-analysis.html15
-rw-r--r--doc/TODO.html15
-rw-r--r--doc/Theming.html73
-rw-r--r--doc/Troubleshooting.html70
-rw-r--r--doc/Unit-tests.html81
-rw-r--r--doc/Upgrade-from-original-sebsauvage-Shaarli.html75
-rw-r--r--doc/Upgrade-from-original-sebsauvage-Shaarli.md4
-rw-r--r--doc/Usage.html15
-rw-r--r--doc/_Footer.html18
-rw-r--r--doc/_Sidebar.html24
-rw-r--r--doc/_Sidebar.md9
-rw-r--r--doc/images/doc-logo.svg522
-rw-r--r--doc/sidebar.html9
-rw-r--r--inc/awesomplete-multiple-tags.js4
-rw-r--r--index.php65
-rw-r--r--tests/HttpUtils/GetHttpUrlTest.php27
-rw-r--r--tests/NetscapeBookmarkUtilsTest.php104
-rw-r--r--tests/Url/UrlTest.php15
-rw-r--r--tpl/export.bookmarks.html10
-rw-r--r--tpl/export.html26
74 files changed, 3781 insertions, 688 deletions
diff --git a/application/HttpUtils.php b/application/HttpUtils.php
index af7cb371..0e1ce879 100644
--- a/application/HttpUtils.php
+++ b/application/HttpUtils.php
@@ -27,7 +27,9 @@
27function get_http_response($url, $timeout = 30, $maxBytes = 4194304) 27function get_http_response($url, $timeout = 30, $maxBytes = 4194304)
28{ 28{
29 $urlObj = new Url($url); 29 $urlObj = new Url($url);
30 if (! filter_var($url, FILTER_VALIDATE_URL) || ! $urlObj->isHttp()) { 30 $cleanUrl = $urlObj->indToAscii();
31
32 if (! filter_var($cleanUrl, FILTER_VALIDATE_URL) || ! $urlObj->isHttp()) {
31 return array(array(0 => 'Invalid HTTP Url'), false); 33 return array(array(0 => 'Invalid HTTP Url'), false);
32 } 34 }
33 35
@@ -35,22 +37,27 @@ function get_http_response($url, $timeout = 30, $maxBytes = 4194304)
35 'http' => array( 37 'http' => array(
36 'method' => 'GET', 38 'method' => 'GET',
37 'timeout' => $timeout, 39 'timeout' => $timeout,
38 'user_agent' => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:23.0)' 40 'user_agent' => 'Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:45.0)'
39 .' Gecko/20100101 Firefox/23.0', 41 .' Gecko/20100101 Firefox/45.0',
40 'request_fulluri' => true, 42 'accept_language' => substr(setlocale(LC_COLLATE, 0), 0, 2) . ',en-US;q=0.7,en;q=0.3',
41 ) 43 )
42 ); 44 );
43 45
44 $context = stream_context_create($options);
45 stream_context_set_default($options); 46 stream_context_set_default($options);
47 list($headers, $finalUrl) = get_redirected_headers($cleanUrl);
48 if (! $headers || strpos($headers[0], '200 OK') === false) {
49 $options['http']['request_fulluri'] = true;
50 stream_context_set_default($options);
51 list($headers, $finalUrl) = get_redirected_headers($cleanUrl);
52 }
46 53
47 list($headers, $finalUrl) = get_redirected_headers($urlObj->cleanup());
48 if (! $headers || strpos($headers[0], '200 OK') === false) { 54 if (! $headers || strpos($headers[0], '200 OK') === false) {
49 return array($headers, false); 55 return array($headers, false);
50 } 56 }
51 57
52 try { 58 try {
53 // TODO: catch Exception in calling code (thumbnailer) 59 // TODO: catch Exception in calling code (thumbnailer)
60 $context = stream_context_create($options);
54 $content = file_get_contents($finalUrl, false, $context, -1, $maxBytes); 61 $content = file_get_contents($finalUrl, false, $context, -1, $maxBytes);
55 } catch (Exception $exc) { 62 } catch (Exception $exc) {
56 return array(array(0 => 'HTTP Error'), $exc->getMessage()); 63 return array(array(0 => 'HTTP Error'), $exc->getMessage());
@@ -60,16 +67,19 @@ function get_http_response($url, $timeout = 30, $maxBytes = 4194304)
60} 67}
61 68
62/** 69/**
63 * Retrieve HTTP headers, following n redirections (temporary and permanent). 70 * Retrieve HTTP headers, following n redirections (temporary and permanent ones).
64 * 71 *
65 * @param string $url initial URL to reach. 72 * @param string $url initial URL to reach.
66 * @param int $redirectionLimit max redirection follow.. 73 * @param int $redirectionLimit max redirection follow..
67 * 74 *
68 * @return array 75 * @return array HTTP headers, or false if it failed.
69 */ 76 */
70function get_redirected_headers($url, $redirectionLimit = 3) 77function get_redirected_headers($url, $redirectionLimit = 3)
71{ 78{
72 $headers = get_headers($url, 1); 79 $headers = get_headers($url, 1);
80 if (!empty($headers['location']) && empty($headers['Location'])) {
81 $headers['Location'] = $headers['location'];
82 }
73 83
74 // Headers found, redirection found, and limit not reached. 84 // Headers found, redirection found, and limit not reached.
75 if ($redirectionLimit-- > 0 85 if ($redirectionLimit-- > 0
@@ -79,6 +89,7 @@ function get_redirected_headers($url, $redirectionLimit = 3)
79 89
80 $redirection = is_array($headers['Location']) ? end($headers['Location']) : $headers['Location']; 90 $redirection = is_array($headers['Location']) ? end($headers['Location']) : $headers['Location'];
81 if ($redirection != $url) { 91 if ($redirection != $url) {
92 $redirection = getAbsoluteUrl($url, $redirection);
82 return get_redirected_headers($redirection, $redirectionLimit); 93 return get_redirected_headers($redirection, $redirectionLimit);
83 } 94 }
84 } 95 }
@@ -87,6 +98,35 @@ function get_redirected_headers($url, $redirectionLimit = 3)
87} 98}
88 99
89/** 100/**
101 * Get an absolute URL from a complete one, and another absolute/relative URL.
102 *
103 * @param string $originalUrl The original complete URL.
104 * @param string $newUrl The new one, absolute or relative.
105 *
106 * @return string Final URL:
107 * - $newUrl if it was already an absolute URL.
108 * - if it was relative, absolute URL from $originalUrl path.
109 */
110function getAbsoluteUrl($originalUrl, $newUrl)
111{
112 $newScheme = parse_url($newUrl, PHP_URL_SCHEME);
113 // Already an absolute URL.
114 if (!empty($newScheme)) {
115 return $newUrl;
116 }
117
118 $parts = parse_url($originalUrl);
119 $final = $parts['scheme'] .'://'. $parts['host'];
120 $final .= (!empty($parts['port'])) ? $parts['port'] : '';
121 $final .= '/';
122 if ($newUrl[0] != '/') {
123 $final .= substr(ltrim($parts['path'], '/'), 0, strrpos($parts['path'], '/'));
124 }
125 $final .= ltrim($newUrl, '/');
126 return $final;
127}
128
129/**
90 * Returns the server's base URL: scheme://domain.tld[:port] 130 * Returns the server's base URL: scheme://domain.tld[:port]
91 * 131 *
92 * @param array $server the $_SERVER array 132 * @param array $server the $_SERVER array
diff --git a/application/LinkFilter.php b/application/LinkFilter.php
index 5e0d8015..e693b284 100644
--- a/application/LinkFilter.php
+++ b/application/LinkFilter.php
@@ -322,7 +322,7 @@ class LinkFilter
322 $tagsOut = $casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER, 'UTF-8'); 322 $tagsOut = $casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER, 'UTF-8');
323 $tagsOut = str_replace(',', ' ', $tagsOut); 323 $tagsOut = str_replace(',', ' ', $tagsOut);
324 324
325 return array_filter(explode(' ', trim($tagsOut)), 'strlen'); 325 return array_values(array_filter(explode(' ', trim($tagsOut)), 'strlen'));
326 } 326 }
327} 327}
328 328
diff --git a/application/LinkUtils.php b/application/LinkUtils.php
index d8dc8b5e..2df76ba8 100644
--- a/application/LinkUtils.php
+++ b/application/LinkUtils.php
@@ -9,8 +9,8 @@
9 */ 9 */
10function html_extract_title($html) 10function html_extract_title($html)
11{ 11{
12 if (preg_match('!<title>(.*?)</title>!is', $html, $matches)) { 12 if (preg_match('!<title.*?>(.*?)</title>!is', $html, $matches)) {
13 return trim(str_replace("\n", ' ', $matches[1])); 13 return trim(str_replace("\n", '', $matches[1]));
14 } 14 }
15 return false; 15 return false;
16} 16}
@@ -70,7 +70,7 @@ function headers_extract_charset($headers)
70function html_extract_charset($html) 70function html_extract_charset($html)
71{ 71{
72 // Get encoding specified in HTML header. 72 // Get encoding specified in HTML header.
73 preg_match('#<meta .*charset="?([^">/]+)"? */?>#Usi', $html, $enc); 73 preg_match('#<meta .*charset=["\']?([^";\'>/]+)["\']? */?>#Usi', $html, $enc);
74 if (!empty($enc[1])) { 74 if (!empty($enc[1])) {
75 return strtolower($enc[1]); 75 return strtolower($enc[1]);
76 } 76 }
diff --git a/application/NetscapeBookmarkUtils.php b/application/NetscapeBookmarkUtils.php
new file mode 100644
index 00000000..8a296705
--- /dev/null
+++ b/application/NetscapeBookmarkUtils.php
@@ -0,0 +1,47 @@
1<?php
2
3/**
4 * Utilities to import and export bookmarks using the Netscape format
5 */
6class NetscapeBookmarkUtils
7{
8
9 /**
10 * Filters links and adds Netscape-formatted fields
11 *
12 * Added fields:
13 * - timestamp link addition date, using the Unix epoch format
14 * - taglist comma-separated tag list
15 *
16 * @param LinkDB $linkDb The link datastore
17 * @param string $selection Which links to export: (all|private|public)
18 *
19 * @throws Exception Invalid export selection
20 *
21 * @return array The links to be exported, with additional fields
22 */
23 public static function filterAndFormat($linkDb, $selection)
24 {
25 // see tpl/export.html for possible values
26 if (! in_array($selection, array('all','public','private'))) {
27 throw new Exception('Invalid export selection: "'.$selection.'"');
28 }
29
30 $bookmarkLinks = array();
31
32 foreach ($linkDb as $link) {
33 if ($link['private'] != 0 && $selection == 'public') {
34 continue;
35 }
36 if ($link['private'] == 0 && $selection == 'private') {
37 continue;
38 }
39 $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
40 $link['timestamp'] = $date->getTimestamp();
41 $link['taglist'] = str_replace(' ', ',', $link['tags']);
42 $bookmarkLinks[] = $link;
43 }
44
45 return $bookmarkLinks;
46 }
47}
diff --git a/application/Url.php b/application/Url.php
index af38c4d9..61a30a78 100644
--- a/application/Url.php
+++ b/application/Url.php
@@ -62,7 +62,21 @@ function add_trailing_slash($url)
62{ 62{
63 return $url . (!endsWith($url, '/') ? '/' : ''); 63 return $url . (!endsWith($url, '/') ? '/' : '');
64} 64}
65/**
66 * Converts an URL with an IDN host to a ASCII one.
67 *
68 * @param string $url Input URL.
69 *
70 * @return string converted URL.
71 */
72function url_with_idn_to_ascii($url)
73{
74 $parts = parse_url($url);
75 $parts['host'] = idn_to_ascii($parts['host']);
65 76
77 $httpUrl = new \http\Url($parts);
78 return $httpUrl->toString();
79}
66/** 80/**
67 * URL representation and cleanup utilities 81 * URL representation and cleanup utilities
68 * 82 *
@@ -221,6 +235,22 @@ class Url
221 } 235 }
222 236
223 /** 237 /**
238 * Converts an URL with an International Domain Name host to a ASCII one.
239 * This requires PHP-intl. If it's not available, just returns this->cleanup().
240 *
241 * @return string converted cleaned up URL.
242 */
243 public function indToAscii()
244 {
245 $out = $this->cleanup();
246 if (! function_exists('idn_to_ascii') || ! isset($this->parts['host'])) {
247 return $out;
248 }
249 $asciiHost = idn_to_ascii($this->parts['host']);
250 return str_replace($this->parts['host'], $asciiHost, $out);
251 }
252
253 /**
224 * Get URL scheme. 254 * Get URL scheme.
225 * 255 *
226 * @return string the URL scheme or false if none is provided. 256 * @return string the URL scheme or false if none is provided.
@@ -233,6 +263,18 @@ class Url
233 } 263 }
234 264
235 /** 265 /**
266 * Get URL host.
267 *
268 * @return string the URL host or false if none is provided.
269 */
270 public function getHost() {
271 if (empty($this->parts['host'])) {
272 return false;
273 }
274 return $this->parts['host'];
275 }
276
277 /**
236 * Test if the Url is an HTTP one. 278 * Test if the Url is an HTTP one.
237 * 279 *
238 * @return true is HTTP, false otherwise. 280 * @return true is HTTP, false otherwise.
diff --git a/composer.json b/composer.json
index f6d92c92..2ded0920 100644
--- a/composer.json
+++ b/composer.json
@@ -8,7 +8,7 @@
8 "require": {}, 8 "require": {},
9 "require-dev": { 9 "require-dev": {
10 "phpmd/phpmd" : "@stable", 10 "phpmd/phpmd" : "@stable",
11 "phpunit/phpunit": "4.6.*", 11 "phpunit/phpunit": "4.8.*",
12 "sebastian/phpcpd": "*", 12 "sebastian/phpcpd": "*",
13 "squizlabs/php_codesniffer": "2.*" 13 "squizlabs/php_codesniffer": "2.*"
14 } 14 }
diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html
index 21fa20aa..0da63f22 100644
--- a/doc/3rd-party-libraries.html
+++ b/doc/3rd-party-libraries.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - 3rd party libraries</title> 7 <title>Shaarli 3rd party libraries</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/Backup,-restore,-import-and-export.html b/doc/Backup,-restore,-import-and-export.html
index 5724b689..f5414efb 100644
--- a/doc/Backup,-restore,-import-and-export.html
+++ b/doc/Backup,-restore,-import-and-export.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Backup, restore, import and export</title> 7 <title>Shaarli Backup, restore, import and export</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -79,7 +106,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
79<h2 id="backup-and-restore-the-datastore-file">Backup and restore the datastore file</h2> 106<h2 id="backup-and-restore-the-datastore-file">Backup and restore the datastore file</h2>
80<p>Backup the file <code>data/datastore.php</code> (by FTP or SSH). Restore by putting the file back in place.</p> 107<p>Backup the file <code>data/datastore.php</code> (by FTP or SSH). Restore by putting the file back in place.</p>
81<p>Example command:</p> 108<p>Example command:</p>
82<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">rsync</span> -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-<span class="ot">$(</span><span class="kw">date</span> +%Y-%m-%d_%H%M<span class="ot">)</span>.php</code></pre> 109<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">rsync</span> -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-<span class="ot">$(</span><span class="kw">date</span> +%Y-%m-%d_%H%M<span class="ot">)</span>.php</code></pre></div>
83<h2 id="export-links-as...">Export links as...</h2> 110<h2 id="export-links-as...">Export links as...</h2>
84<p>To export links as an HTML file, under <em>Tools &gt; Export</em>, choose:</p> 111<p>To export links as an HTML file, under <em>Tools &gt; Export</em>, choose:</p>
85<ul> 112<ul>
@@ -92,7 +119,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
92<li>This can be done using the <a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> tool.<a href=".html"></a></li> 119<li>This can be done using the <a href="https://github.com/nodiscc/shaarchiver">shaarchiver</a> tool.<a href=".html"></a></li>
93</ul> 120</ul>
94<p>Example command:</p> 121<p>Example command:</p>
95<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">./export-bookmarks.py</span> --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all</code></pre> 122<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">./export-bookmarks.py</span> --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all</code></pre></div>
96<h2 id="import-links-from...">Import links from...</h2> 123<h2 id="import-links-from...">Import links from...</h2>
97<h3 id="diigo">Diigo</h3> 124<h3 id="diigo">Diigo</h3>
98<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> 125<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>
diff --git a/doc/Browsing-and-searching.html b/doc/Browsing-and-searching.html
new file mode 100644
index 00000000..a0887850
--- /dev/null
+++ b/doc/Browsing-and-searching.html
@@ -0,0 +1,84 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Browsing and searching</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Installation
19<ul>
20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
30<li><a href="Usage.html">Usage</a>
31<ul>
32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
34<li><a href="Firefox-share.html">Firefox share</a></li>
35<li><a href="RSS-feeds.html">RSS feeds</a></li>
36</ul></li>
37<li>How To
38<ul>
39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
45</ul></li>
46<li><a href="Troubleshooting.html">Troubleshooting</a></li>
47<li><a href="Development.html">Development</a>
48<ul>
49<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
50<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
51<li><a href="Directory-structure.html">Directory structure</a></li>
52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
55<li><a href="Security.html">Security</a></li>
56<li><a href="Static-analysis.html">Static analysis</a></li>
57<li><a href="Theming.html">Theming</a></li>
58<li><a href="Unit-tests.html">Unit tests</a></li>
59</ul></li>
60<li>About
61<ul>
62<li><a href="FAQ.html">FAQ</a></li>
63<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
64<li><a href="TODO.html">TODO</a></li>
65</ul></li>
66</ul>
67</div>
68<h1 id="browsing-and-searching">Browsing and searching</h1>
69<h1 id="browsing-and-searching-1">Browsing and Searching</h1>
70<p>Status: DRAFT</p>
71<p><embed src="(http://pix.toile-libre.org/upload/original/1455571378.png).html" /></p>
72<h2 id="plain-text-search">Plain text search</h2>
73<p>Use the <code>Search text</code> field to search in <em>any</em> of the fields of all links (Title, URL, Description...)</p>
74<p><strong>Exclude text/tags:</strong> Use the <code>-</code> operator before a word or tag (example <code>-uninteresting</code>) to prevent entries containing (or tagged) <code>uninteresting</code> from showing up in the search results.</p>
75<p><strong>Exact text search:</strong> Use double-quotes (example <code>&quot;exact search&quot;</code>) to search for the exact expression.</p>
76<p>Both exclude patterns and exact searches can be combined with normal searches (example <code>&quot;exact search&quot; term otherterm -notthis &quot;very exact&quot; stuff -notagain</code>)</p>
77<h2 id="tags-search">Tags search</h2>
78<p>Use the <code>Filter by tags</code> field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).</p>
79<p><strong>Hidden tags:</strong> Tags starting with a dot <code>.</code> (example <code>.secret</code>) are private. They can only be seen and searched when logged in.</p>
80<p>Alternatively you can use the <code>Tag cloud</code> to discover all tags and click on any of them to display related links.</p>
81<h2 id="filtering-rss-feedspicture-wall">Filtering RSS feeds/Picture wall</h2>
82<p>RSS feeds can also be restricted to only return items matching a text/tag search: see <a href="RSS-feeds.html">RSS feeds</a>.</p>
83</body>
84</html>
diff --git a/doc/Browsing-and-searching.md b/doc/Browsing-and-searching.md
new file mode 100644
index 00000000..187fe447
--- /dev/null
+++ b/doc/Browsing-and-searching.md
@@ -0,0 +1,28 @@
1#Browsing and searching
2# Browsing and Searching
3
4Status: DRAFT
5
6![(http://pix.toile-libre.org/upload/original/1455571378.png)]((http://pix.toile-libre.org/upload/original/1455571378.png).html)
7
8## Plain text search
9
10Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...)
11
12**Exclude text/tags:** Use the `-` operator before a word or tag (example `-uninteresting`) to prevent entries containing (or tagged) `uninteresting` from showing up in the search results.
13
14**Exact text search:** Use double-quotes (example `"exact search"`) to search for the exact expression.
15
16Both exclude patterns and exact searches can be combined with normal searches (example `"exact search" term otherterm -notthis "very exact" stuff -notagain`)
17
18## Tags search
19
20Use the `Filter by tags` field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).
21
22**Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in.
23
24Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links.
25
26## Filtering RSS feeds/Picture wall
27
28RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds.html).
diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html
index 40d17912..8dbf3bce 100644
--- a/doc/Coding-guidelines.html
+++ b/doc/Coding-guidelines.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Coding guidelines</title> 7 <title>Shaarli Coding guidelines</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html
index 34bc6157..8dd0e430 100644
--- a/doc/Community-&-Related-software.html
+++ b/doc/Community-&-Related-software.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Community & Related software</title> 7 <title>Shaarli Community & Related software</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -72,6 +81,10 @@
72<li><a href="https://www.shaarli.fr/my.php">Shaarli.fr/my</a> - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of <a href="https://github.com/DMeloni">DMeloni</a><a href=".html"></a></li> 81<li><a href="https://www.shaarli.fr/my.php">Shaarli.fr/my</a> - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of <a href="https://github.com/DMeloni">DMeloni</a><a href=".html"></a></li>
73<li><a href="http://shaarferme.etudiant-libre.fr.nf/index.php">Shaarli Community</a> - Unknown Shaarli hoster (unsupported, old fork)<a href=".html"></a></li> 82<li><a href="http://shaarferme.etudiant-libre.fr.nf/index.php">Shaarli Community</a> - Unknown Shaarli hoster (unsupported, old fork)<a href=".html"></a></li>
74</ul> 83</ul>
84<h3 id="third-party-plugins">Third party plugins</h3>
85<ul>
86<li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> - periodically saves contents of the <em>Edit link/Save link</em> dialog to your browser's LocalStorage to avoid data loss when typing a long entry.<a href=".html"></a></li>
87</ul>
75<h3 id="themes">Themes</h3> 88<h3 id="themes">Themes</h3>
76<p>See <a href="Theming.html">Theming</a> for the list of community-contributed themes, and an installation guide.</p> 89<p>See <a href="Theming.html">Theming</a> for the list of community-contributed themes, and an installation guide.</p>
77<h3 id="server-apps">Server apps</h3> 90<h3 id="server-apps">Server apps</h3>
@@ -85,7 +98,7 @@
85</ul> 98</ul>
86<h3 id="mobile-apps">Mobile Apps</h3> 99<h3 id="mobile-apps">Mobile Apps</h3>
87<ul> 100<ul>
88<li><a href="https://github.com/mro/ShaarliOS#the-missing-ios-8-share-extension-to-shaarli">github.com/mro/ShaarliOS</a> iOS share extension - see <a href="https://github.com/shaarli/Shaarli/issues/308#issuecomment-132303709">#308</a> for some promo codes,<a href=".html"></a></li> 101<li><a href="http://app.mro.name/Shaarli💫">Shaarli💫</a> iOS share extension - see <a href="https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070">#308</a> for some promo codes,<a href=".html"></a></li>
89<li><a href="http://sebsauvage.net/links/?ZAyDzg">Shaarli for Android</a> - Android application that adds Shaarli as a sharing provider<a href=".html"></a></li> 102<li><a href="http://sebsauvage.net/links/?ZAyDzg">Shaarli for Android</a> - Android application that adds Shaarli as a sharing provider<a href=".html"></a></li>
90<li><a href="https://github.com/dimtion/Shaarlier">Shaarlier for Android</a> - Android application to simply add links directly into your Shaarli<a href=".html"></a></li> 103<li><a href="https://github.com/dimtion/Shaarlier">Shaarlier for Android</a> - Android application to simply add links directly into your Shaarli<a href=".html"></a></li>
91</ul> 104</ul>
diff --git a/doc/Community-&-Related-software.md b/doc/Community-&-Related-software.md
index 77ea2420..27da45d8 100644
--- a/doc/Community-&-Related-software.md
+++ b/doc/Community-&-Related-software.md
@@ -15,6 +15,10 @@ _TODO: contact repos owners to see if they'd like to standardize their work with
15- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni)[](.html) 15- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni)[](.html)
16- [Shaarli Community](http://shaarferme.etudiant-libre.fr.nf/index.php) - Unknown Shaarli hoster (unsupported, old fork)[](.html) 16- [Shaarli Community](http://shaarferme.etudiant-libre.fr.nf/index.php) - Unknown Shaarli hoster (unsupported, old fork)[](.html)
17 17
18### Third party plugins
19
20 * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) - periodically saves contents of the _Edit link/Save link_ dialog to your browser's LocalStorage to avoid data loss when typing a long entry.[](.html)
21
18### Themes 22### Themes
19See [Theming](Theming.html) for the list of community-contributed themes, and an installation guide. 23See [Theming](Theming.html) for the list of community-contributed themes, and an installation guide.
20 24
@@ -27,7 +31,7 @@ See [Theming](Theming.html) for the list of community-contributed themes, and an
27- [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. An [another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for others shaarli (but use most ressources).[](.html) 31- [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. An [another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for others shaarli (but use most ressources).[](.html)
28 32
29### Mobile Apps 33### Mobile Apps
30- [github.com/mro/ShaarliOS](https://github.com/mro/ShaarliOS#the-missing-ios-8-share-extension-to-shaarli) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-132303709) for some promo codes,[](.html) 34- [Shaarli💫](http://app.mro.name/Shaarli💫) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes,[](.html)
31- [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider[](.html) 35- [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider[](.html)
32- [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli[](.html) 36- [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli[](.html)
33 37
diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html
index e27b1134..067c6828 100644
--- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html
+++ b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Copy an existing installation over SSH and serve it locally</title> 7 <title>Shaarli Copy an existing installation over SSH and serve it locally</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -77,7 +104,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
77</div> 104</div>
78<h1 id="copy-an-existing-installation-over-ssh-and-serve-it-locally">Copy an existing installation over SSH and serve it locally</h1> 105<h1 id="copy-an-existing-installation-over-ssh-and-serve-it-locally">Copy an existing installation over SSH and serve it locally</h1>
79<p>Example bash script:</p> 106<p>Example bash script:</p>
80<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span> 107<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span>
81<span class="co">#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli</span> 108<span class="co">#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli</span>
82<span class="co">#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.</span> 109<span class="co">#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.</span>
83<span class="co">#Will NOT download linked pages. It&#39;s just a directly usable backup/copy/mirror of your Shaarli</span> 110<span class="co">#Will NOT download linked pages. It&#39;s just a directly usable backup/copy/mirror of your Shaarli</span>
@@ -124,9 +151,9 @@ code > span.er { color: #ff0000; font-weight: bold; }
124 151
125<span class="co">##### MAIN #################</span> 152<span class="co">##### MAIN #################</span>
126 153
127<span class="kw">_main</span></code></pre> 154<span class="kw">_main</span></code></pre></div>
128<p>This outputs:</p> 155<p>This outputs:</p>
129<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">./local-shaarli.sh</span> 156<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">./local-shaarli.sh</span>
130<span class="kw">PHP</span> 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 157<span class="kw">PHP</span> 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014
131<span class="kw">Listening</span> on http://localhost:7431 158<span class="kw">Listening</span> on http://localhost:7431
132<span class="kw">Document</span> root is /home/user/local-shaarli/shaarli 159<span class="kw">Document</span> root is /home/user/local-shaarli/shaarli
@@ -134,6 +161,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
134 161
135[<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html) 162[<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html)
136[<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html) 163[<span class="kw">Mon</span> Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html)
137[<span class="kw">Mon</span> Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)</code></pre> 164[<span class="kw">Mon</span> Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)</code></pre></div>
138</body> 165</body>
139</html> 166</html>
diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).html b/doc/Create-and-serve-multiple-Shaarlis-(farm).html
new file mode 100644
index 00000000..d3da1a2e
--- /dev/null
+++ b/doc/Create-and-serve-multiple-Shaarlis-(farm).html
@@ -0,0 +1,160 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Create and serve multiple Shaarlis (farm)</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="create-and-serve-multiple-shaarlis-farm">Create and serve multiple Shaarlis (farm)</h1>
106<p>Example bash script (creates multiple shaarli instances and generates an HTML index of them)</p>
107<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co">#!/bin/bash</span>
108<span class="kw">set</span> <span class="kw">-o</span> errexit
109<span class="kw">set</span> <span class="kw">-o</span> nounset
110
111<span class="co">#config</span>
112<span class="ot">shaarli_base_dir=</span><span class="st">&#39;/var/www/shaarli&#39;</span>
113<span class="ot">accounts=</span><span class="st">&#39;bob john whatever username&#39;</span>
114<span class="ot">shaarli_repo_url=</span><span class="st">&#39;https://github.com/shaarli/Shaarli&#39;</span>
115<span class="ot">ref=</span><span class="st">&quot;master&quot;</span>
116
117<span class="co">#clone multiple shaarli instances</span>
118<span class="kw">if [</span> <span class="ot">!</span> <span class="ot">-d</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">&quot;</span><span class="kw"> ]</span>; <span class="kw">then</span> <span class="kw">mkdir</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">&quot;</span><span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(.html)</span>
119
120<span class="kw">for</span> <span class="kw">account</span> in <span class="ot">$accounts</span><span class="kw">;</span> <span class="kw">do</span>
121 <span class="kw">if [</span> <span class="ot">-d</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">/</span><span class="ot">$account</span><span class="st">&quot;</span><span class="kw"> ]</span>;[]<span class="kw">(.html)</span>
122 <span class="kw">then</span> <span class="kw">echo</span> <span class="st">&quot;[info] account </span><span class="ot">$account</span><span class="st"> already exists, skipping&quot;</span><span class="kw">;</span>[]<span class="kw">(.html)</span>
123 <span class="kw">else</span> <span class="kw">echo</span> <span class="st">&quot;[info] creating new account </span><span class="ot">$account</span><span class="st"> ...&quot;</span><span class="kw">;</span> <span class="kw">git</span> clone --quiet <span class="st">&quot;</span><span class="ot">$shaarli_repo_url</span><span class="st">&quot;</span> -b <span class="st">&quot;</span><span class="ot">$ref</span><span class="st">&quot;</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">/</span><span class="ot">$account</span><span class="st">&quot;</span><span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(.html)</span>
124<span class="kw">done</span>
125
126<span class="co">#generate html index of shaarlis</span>
127<span class="ot">htmlhead=</span><span class="st">&#39;&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD HTML 4.01//EN&quot; &quot;http://www.w3.org/TR/html4/strict.dtd&quot;&gt;</span>
128<span class="st">&lt;!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ --&gt;</span>
129<span class="st">&lt;html lang=&quot;en&quot;&gt;</span>
130<span class="st"> &lt;head&gt;</span>
131<span class="st"> &lt;meta http-equiv=&quot;content-type&quot; content=&quot;text/html; charset=utf-8&quot;&gt;</span>
132<span class="st"> &lt;title&gt;My Shaarli farm&lt;/title&gt;</span>
133<span class="st"> &lt;style&gt;body {font-family: &quot;Open Sans&quot;}&lt;/style&gt;</span>
134<span class="st"> &lt;/head&gt;</span>
135<span class="st"> &lt;body&gt;</span>
136<span class="st"> &lt;div&gt;</span>
137<span class="st"> &lt;h1&gt;My Shaarli farm&lt;/h1&gt;</span>
138<span class="st"> &lt;ul style=&quot;list-style-type: none;&quot;&gt;&#39;</span>
139
140<span class="ot">accountlinks=</span><span class="st">&#39;&#39;</span>
141
142<span class="ot">htmlfooter=</span><span class="st">&#39;</span>
143<span class="st"> &lt;/ul&gt;</span>
144<span class="st"> &lt;/div&gt;</span>
145<span class="st"> &lt;/body&gt;</span>
146<span class="st">&lt;/html&gt;&#39;</span>
147
148
149
150<span class="kw">for</span> <span class="kw">account</span> in <span class="ot">$accounts</span><span class="kw">;</span> <span class="kw">do</span> <span class="ot">accountlinks=</span><span class="st">&quot;</span><span class="ot">$accountlinks</span><span class="st">\n&lt;li&gt;&lt;a href=</span><span class="dt">\&quot;</span><span class="ot">$account</span><span class="dt">\&quot;</span><span class="st">&gt;</span><span class="ot">$account</span><span class="st">&lt;/a&gt;&lt;/li&gt;&quot;</span>; <span class="kw">done</span>
151<span class="kw">if [</span> <span class="ot">-d</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">/index.html&quot;</span><span class="kw"> ]</span>; <span class="kw">then</span> <span class="kw">echo</span> <span class="st">&quot;[removing old index.html]&quot;</span><span class="kw">;</span> <span class="kw">rm</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">/index.html&quot;</span> ]<span class="kw">;</span> <span class="kw">fi</span>[]<span class="kw">(.html)</span>
152<span class="kw">echo</span> <span class="st">&quot;[info] generating new index of shaarlis&quot;</span>[](.html)
153<span class="kw">echo</span> -e <span class="st">&quot;</span><span class="ot">$htmlhead</span><span class="st"> </span><span class="ot">$accountlinks</span><span class="st"> </span><span class="ot">$htmlfooter</span><span class="st">&quot;</span> <span class="kw">&gt;</span> <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">/index.html&quot;</span>
154<span class="kw">echo</span> <span class="st">&#39;[info] done.&#39;</span>[](.html)
155<span class="kw">echo</span> <span class="st">&quot;[info] list of accounts: </span><span class="ot">$accounts</span><span class="st">&quot;</span>[](.html)
156<span class="kw">echo</span> <span class="st">&quot;[info] contents of </span><span class="ot">$shaarli_base_dir</span><span class="st">:&quot;</span>[](.html)
157<span class="kw">tree</span> -a -L 1 <span class="st">&quot;</span><span class="ot">$shaarli_base_dir</span><span class="st">&quot;</span></code></pre></div>
158<p>This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like <a href="https://www.ansible.com/">Ansible</a><a href=".html"></a></p>
159</body>
160</html>
diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/Create-and-serve-multiple-Shaarlis-(farm).md
new file mode 100644
index 00000000..a71f6520
--- /dev/null
+++ b/doc/Create-and-serve-multiple-Shaarlis-(farm).md
@@ -0,0 +1,58 @@
1#Create and serve multiple Shaarlis (farm)
2Example bash script (creates multiple shaarli instances and generates an HTML index of them)
3
4```bash
5#!/bin/bash
6set -o errexit
7set -o nounset
8
9#config
10shaarli_base_dir='/var/www/shaarli'
11accounts='bob john whatever username'
12shaarli_repo_url='https://github.com/shaarli/Shaarli'
13ref="master"
14
15#clone multiple shaarli instances
16if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi[](.html)
17
18for account in $accounts; do
19 if [ -d "$shaarli_base_dir/$account" ];[](.html)
20 then echo "[info] account $account already exists, skipping";[](.html)
21 else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi[](.html)
22done
23
24#generate html index of shaarlis
25htmlhead='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
26<!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ -->
27<html lang="en">
28 <head>
29 <meta http-equiv="content-type" content="text/html; charset=utf-8">
30 <title>My Shaarli farm</title>
31 <style>body {font-family: "Open Sans"}</style>
32 </head>
33 <body>
34 <div>
35 <h1>My Shaarli farm</h1>
36 <ul style="list-style-type: none;">'
37
38accountlinks=''
39
40htmlfooter='
41 </ul>
42 </div>
43 </body>
44</html>'
45
46
47
48for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done
49if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi[](.html)
50echo "[info] generating new index of shaarlis"[](.html)
51echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html"
52echo '[info] done.'[](.html)
53echo "[info] list of accounts: $accounts"[](.html)
54echo "[info] contents of $shaarli_base_dir:"[](.html)
55tree -a -L 1 "$shaarli_base_dir"
56```
57
58This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/)[](.html)
diff --git a/doc/Datastore-hacks.html b/doc/Datastore-hacks.html
index 0bf2a493..6273fae0 100644
--- a/doc/Datastore-hacks.html
+++ b/doc/Datastore-hacks.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Datastore hacks</title> 7 <title>Shaarli Datastore hacks</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -78,17 +105,19 @@ code > span.er { color: #ff0000; font-weight: bold; }
78<h1 id="datastore-hacks">Datastore hacks</h1> 105<h1 id="datastore-hacks">Datastore hacks</h1>
79<h3 id="decode-datastore-content">Decode datastore content</h3> 106<h3 id="decode-datastore-content">Decode datastore content</h3>
80<p>To display the array representing the data saved in <code>data/datastore.php</code>, use the following snippet:</p> 107<p>To display the array representing the data saved in <code>data/datastore.php</code>, use the following snippet:</p>
81<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span> = <span class="st">&quot;tZNdb9MwFIb... &lt;Commented content inside datastore.php&gt;&quot;</span><span class="ot">;</span> 108<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span> = <span class="st">&quot;tZNdb9MwFIb... &lt;Commented content inside datastore.php&gt;&quot;</span><span class="ot">;</span>
82<span class="kw">$out</span> = <span class="fu">unserialize</span><span class="ot">(</span><span class="fu">gzinflate</span><span class="ot">(</span><span class="fu">base64_decode</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">)));</span> 109<span class="kw">$out</span> = <span class="fu">unserialize</span><span class="ot">(</span><span class="fu">gzinflate</span><span class="ot">(</span><span class="fu">base64_decode</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">)));</span>
83<span class="fu">echo</span> <span class="st">&quot;&lt;pre&gt;&quot;</span><span class="ot">;</span> <span class="co">// Pretty printing is love, pretty printing is life</span> 110<span class="fu">echo</span> <span class="st">&quot;&lt;pre&gt;&quot;</span><span class="ot">;</span> <span class="co">// Pretty printing is love, pretty printing is life</span>
84<span class="fu">print_r</span><span class="ot">(</span><span class="kw">$out</span><span class="ot">);</span> 111<span class="fu">print_r</span><span class="ot">(</span><span class="kw">$out</span><span class="ot">);</span>
85<span class="fu">echo</span> <span class="st">&quot;&lt;/pre&gt;&quot;</span><span class="ot">;</span> 112<span class="fu">echo</span> <span class="st">&quot;&lt;/pre&gt;&quot;</span><span class="ot">;</span>
86<span class="fu">exit</span><span class="ot">;</span></code></pre> 113<span class="fu">exit</span><span class="ot">;</span></code></pre></div>
87<p>This will output the internal representation of the datastore, &quot;unobfuscated&quot; (if this can really be considered obfuscation).</p> 114<p>This will output the internal representation of the datastore, &quot;unobfuscated&quot; (if this can really be considered obfuscation).</p>
115<p>Alternatively, you can transform to JSON format (and pretty-print if you have <code>jq</code> installed):</p>
116<pre><code>php -r &#39;print(json_encode(unserialize(gzinflate(base64_decode(preg_replace(&quot;!.*/\* (.+) \*/.*!&quot;, &quot;$1&quot;, file_get_contents(&quot;data/datastore.php&quot;)))))));&#39; | jq .</code></pre>
88<h3 id="changing-the-timestamp-for-a-link">Changing the timestamp for a link</h3> 117<h3 id="changing-the-timestamp-for-a-link">Changing the timestamp for a link</h3>
89<ul> 118<ul>
90<li>Look for <code>&lt;input type=&quot;hidden&quot; name=&quot;lf_linkdate&quot; value=&quot;{$link.linkdate}&quot;&gt;</code> in <code>tpl/editlink.tpl</code> (line 14)</li> 119<li>Look for <code>&lt;input type=&quot;hidden&quot; name=&quot;lf_linkdate&quot; value=&quot;{$link.linkdate}&quot;&gt;</code> in <code>tpl/editlink.tpl</code> (line 14)</li>
91<li>Remove <code>type=&quot;hidden&quot;</code> from this line</li> 120<li>Replace <code>type=&quot;hidden&quot;</code> with <code>type=&quot;text&quot;</code> from this line</li>
92<li>A new date/time field becomes available in the edit/new link dialog.</li> 121<li>A new date/time field becomes available in the edit/new link dialog.</li>
93<li>You can set the timestamp manually by entering it in the format <code>YYYMMDD_HHMMS</code>.</li> 122<li>You can set the timestamp manually by entering it in the format <code>YYYMMDD_HHMMS</code>.</li>
94</ul> 123</ul>
diff --git a/doc/Datastore-hacks.md b/doc/Datastore-hacks.md
index 33aa2223..ef6f6d50 100644
--- a/doc/Datastore-hacks.md
+++ b/doc/Datastore-hacks.md
@@ -12,8 +12,13 @@ exit;
12``` 12```
13This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). 13This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation).
14 14
15Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed):
16```
17php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq .
18```
19
15### Changing the timestamp for a link 20### Changing the timestamp for a link
16* Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14) 21* Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14)
17* Remove `type="hidden"` from this line 22* Replace `type="hidden"` with `type="text"` from this line
18* A new date/time field becomes available in the edit/new link dialog. 23* A new date/time field becomes available in the edit/new link dialog.
19* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. 24* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`.
diff --git a/doc/Development.html b/doc/Development.html
index 88cf5854..f7ada07f 100644
--- a/doc/Development.html
+++ b/doc/Development.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Development</title> 7 <title>Shaarli Development</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -92,7 +101,7 @@
92</ul> 101</ul>
93<p>After all jobs have finished, Travis returns the results to GitHub:</p> 102<p>After all jobs have finished, Travis returns the results to GitHub:</p>
94<ul> 103<ul>
95<li>a status icon represents the result for the <code>master</code> branch: <a href="(https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli).html"><img src="https://travis-ci.org/shaarli/Shaarli" alt="(https://api.travis-ci.org/shaarli/Shaarli.svg)" /></a></li> 104<li>a status icon represents the result for the <code>master</code> branch: <a href="(https://api.travis-ci.org/shaarli/Shaarli.svg)%5D(https://travis-ci.org/shaarli/Shaarli).html"><img src="https://travis-ci.org/shaarli/Shaarli" alt="(https://api.travis-ci.org/shaarli/Shaarli.svg)" /></a></li>
96<li>Pull Requests are updated with the Travis result 105<li>Pull Requests are updated with the Travis result
97<ul> 106<ul>
98<li>Green: all tests have passed</li> 107<li>Green: all tests have passed</li>
diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html
index 7015923c..2369950a 100644
--- a/doc/Directory-structure.html
+++ b/doc/Directory-structure.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Directory structure</title> 7 <title>Shaarli Directory structure</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -77,7 +104,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
77</div> 104</div>
78<h1 id="directory-structure">Directory structure</h1> 105<h1 id="directory-structure">Directory structure</h1>
79<p>Here is the directory structure of Shaarli and the purpose of the different files:</p> 106<p>Here is the directory structure of Shaarli and the purpose of the different files:</p>
80<pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">index.php</span> <span class="co"># Main program</span> 107<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">index.php</span> <span class="co"># Main program</span>
81 <span class="kw">application/</span> <span class="co"># Shaarli classes</span> 108 <span class="kw">application/</span> <span class="co"># Shaarli classes</span>
82 ├── <span class="kw">LinkDB.php</span> 109 ├── <span class="kw">LinkDB.php</span>
83 └── <span class="kw">Utils.php</span> 110 └── <span class="kw">Utils.php</span>
@@ -104,6 +131,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
104 <span class="kw">cache/</span> <span class="co"># thumbnails cache</span> 131 <span class="kw">cache/</span> <span class="co"># thumbnails cache</span>
105 <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> 132 <span class="co"># This directory is automatically created. You can erase it anytime you want.</span>
106 <span class="kw">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span> 133 <span class="kw">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span>
107 <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre> 134 <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div>
108</body> 135</body>
109</html> 136</html>
diff --git a/doc/Docker.html b/doc/Docker.html
new file mode 100644
index 00000000..ab95da39
--- /dev/null
+++ b/doc/Docker.html
@@ -0,0 +1,245 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Docker</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="docker">Docker</h1>
106<ul>
107<li><a href="#docker-usage">Docker usage</a><a href=".html"></a></li>
108<li><a href="#get-and-run-a-shaarli-image">Get and run a Shaarli image</a><a href=".html"></a></li>
109<li><a href="#resources">Resources</a><a href=".html"></a></li>
110</ul>
111<h2 id="docker-usage">Docker usage</h2>
112<h3 id="basics">Basics</h3>
113<p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant<a href=".html"></a><br />
114to your OS / distribution, and start the service.</p>
115<h4 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a><a href=".html"></a></h4>
116<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">docker</span> search debian
117
118<span class="kw">NAME</span> DESCRIPTION STARS OFFICIAL AUTOMATED
119<span class="kw">ubuntu</span> Ubuntu is a Debian-based Linux operating s... 2065 [OK][](.html)
120<span class="kw">debian</span> Debian is a Linux distribution that<span class="st">&#39;s comp... 603 [OK][](.html)</span>
121<span class="st">google/debian 47 [OK][](.html)</span></code></pre></div>
122<h4 id="show-available-tags-for-a-repository">Show available tags for a repository</h4>
123<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">curl</span> https://index.docker.io/v1/repositories/debian/tags <span class="kw">|</span> <span class="kw">python</span> -m json.tool
124
125<span class="kw">%</span> Total % Received % Xferd Average Speed Time Time Time Current
126<span class="kw">Dload</span> Upload Total Spent Left Speed
127<span class="kw">100</span> 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433</code></pre></div>
128<p>Sample output:</p>
129<div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="ot">[[]</span><span class="er">(.html)</span>
130 <span class="fu">{</span>
131 <span class="dt">&quot;layer&quot;</span><span class="fu">:</span> <span class="st">&quot;85a02782&quot;</span><span class="fu">,</span>
132 <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;stretch&quot;</span>
133 <span class="fu">}</span><span class="ot">,</span>
134 <span class="fu">{</span>
135 <span class="dt">&quot;layer&quot;</span><span class="fu">:</span> <span class="st">&quot;59abecbc&quot;</span><span class="fu">,</span>
136 <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;testing&quot;</span>
137 <span class="fu">}</span><span class="ot">,</span>
138 <span class="fu">{</span>
139 <span class="dt">&quot;layer&quot;</span><span class="fu">:</span> <span class="st">&quot;bf0fd686&quot;</span><span class="fu">,</span>
140 <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;unstable&quot;</span>
141 <span class="fu">}</span><span class="ot">,</span>
142 <span class="fu">{</span>
143 <span class="dt">&quot;layer&quot;</span><span class="fu">:</span> <span class="st">&quot;60c52dbe&quot;</span><span class="fu">,</span>
144 <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;wheezy&quot;</span>
145 <span class="fu">}</span><span class="ot">,</span>
146 <span class="fu">{</span>
147 <span class="dt">&quot;layer&quot;</span><span class="fu">:</span> <span class="st">&quot;c5b806fe&quot;</span><span class="fu">,</span>
148 <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;wheezy-backports&quot;</span>
149 <span class="fu">}</span>
150<span class="ot">]</span></code></pre></div>
151<h4 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h4>
152<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">docker</span> pull repository[:tag][](.html)
153
154$ <span class="kw">docker</span> pull debian:wheezy
155<span class="kw">wheezy</span>: Pulling from debian
156<span class="kw">4c8cbfd2973e</span>: Pull complete
157<span class="kw">60c52dbe9d91</span>: Pull complete
158<span class="kw">Digest</span>: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
159<span class="kw">Status</span>: Downloaded newer image for debian:wheezy</code></pre></div>
160<h2 id="get-and-run-a-shaarli-image">Get and run a Shaarli image</h2>
161<h3 id="dockerhub-repository">DockerHub repository</h3>
162<p>The images can be found in the <a href="https://hub.docker.com/r/shaarli/shaarli/"><code>shaarli/shaarli</code></a><a href=".html"></a><br />
163repository.</p>
164<h3 id="available-image-tags">Available image tags</h3>
165<ul>
166<li><code>latest</code>: master branch (tarball release)</li>
167<li><code>stable</code>: stable branch (tarball release)</li>
168<li><code>dev</code>: master branch (Git clone)</li>
169</ul>
170<p>All images rely on:</p>
171<ul>
172<li><a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a><a href=".html"></a></li>
173<li><a href="http://php-fpm.org/">PHP5-FPM</a><a href=".html"></a></li>
174<li><a href="http://nginx.org/">Nginx</a><a href=".html"></a></li>
175</ul>
176<h3 id="download-from-dockerhub">Download from DockerHub</h3>
177<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">docker</span> pull shaarli/shaarli
178<span class="kw">latest</span>: Pulling from shaarli/shaarli
179<span class="kw">32716d9fcddb</span>: Pull complete
180<span class="kw">84899d045435</span>: Pull complete
181<span class="kw">4b6ad7444763</span>: Pull complete
182<span class="kw">e0345ef7a3e0</span>: Pull complete
183<span class="kw">5c1dd344094f</span>: Pull complete
184<span class="kw">6422305a200b</span>: Pull complete
185<span class="kw">7d63f861dbef</span>: Pull complete
186<span class="kw">3eb97210645c</span>: Pull complete
187<span class="kw">869319d746ff</span>: Already exists
188<span class="kw">869319d746ff</span>: Pulling fs layer
189<span class="kw">902b87aaaec9</span>: Already exists
190<span class="kw">Digest</span>: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
191<span class="kw">Status</span>: Downloaded newer image for shaarli/shaarli:latest</code></pre></div>
192<h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3>
193<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># map the host&#39;s :8000 port to the container&#39;s :80 port</span>
194$ <span class="kw">docker</span> create -p 8000:80 shaarli/shaarli
195<span class="kw">d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101</span>
196
197<span class="co"># launch the container in the background</span>
198$ <span class="kw">docker</span> start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
199<span class="kw">d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101</span>
200
201<span class="co"># list active containers</span>
202$ <span class="kw">docker</span> ps
203<span class="kw">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES
204<span class="kw">d40b7af693d6</span> shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000-<span class="kw">&gt;</span>80/tcp backstabbing_galileo</code></pre></div>
205<h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3>
206<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">docker</span> stop backstabbing_galileo <span class="co"># those docker guys are really rude to physicists!</span>
207<span class="kw">backstabbing_galileo</span>
208
209<span class="co"># check the container is stopped</span>
210$ <span class="kw">docker</span> ps
211<span class="kw">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES
212
213<span class="co"># list ALL containers</span>
214$ <span class="kw">docker</span> ps -a
215<span class="kw">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES
216<span class="kw">d40b7af693d6</span> shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) <span class="kw">48</span> seconds ago backstabbing_galileo
217
218<span class="co"># destroy the container</span>
219$ <span class="kw">docker</span> rm backstabbing_galileo <span class="co"># let&#39;s put an end to these barbarian practices</span>
220<span class="kw">backstabbing_galileo</span>
221
222$ <span class="kw">docker</span> ps -a
223<span class="kw">CONTAINER</span> ID IMAGE COMMAND CREATED STATUS PORTS NAMES</code></pre></div>
224<h2 id="resources">Resources</h2>
225<h3 id="docker-1">Docker</h3>
226<ul>
227<li><a href="http://blog.thoward37.me/articles/where-are-docker-images-stored/">Where are Docker images stored?</a><a href=".html"></a></li>
228<li><a href="https://docs.docker.com/reference/builder/">Dockerfile reference</a><a href=".html"></a></li>
229<li><a href="https://docs.docker.com/articles/dockerfile_best-practices/">Dockerfile best practices</a><a href=".html"></a></li>
230<li><a href="https://docs.docker.com/userguide/dockervolumes/">Volumes</a><a href=".html"></a></li>
231</ul>
232<h3 id="dockerhub">DockerHub</h3>
233<ul>
234<li><a href="https://docs.docker.com/userguide/dockerrepos/">Repositories</a><a href=".html"></a></li>
235<li><a href="https://docs.docker.com/docker-hub/orgs/">Teams and organizations</a><a href=".html"></a></li>
236<li><a href="https://docs.docker.com/docker-hub/github/">GitHub automated build</a><a href=".html"></a></li>
237</ul>
238<h3 id="service-management">Service management</h3>
239<ul>
240<li><a href="https://docs.docker.com/articles/using_supervisord/">Using supervisord</a><a href=".html"></a></li>
241<li><a href="http://nginx.org/en/docs/ngx_core_module.html#daemon">Nginx in the foreground</a><a href=".html"></a></li>
242<li><a href="http://supervisord.org/">supervisord</a><a href=".html"></a></li>
243</ul>
244</body>
245</html>
diff --git a/doc/Docker.md b/doc/Docker.md
new file mode 100644
index 00000000..1faa7904
--- /dev/null
+++ b/doc/Docker.md
@@ -0,0 +1,157 @@
1#Docker
2- [Docker usage](#docker-usage)[](.html)
3- [Get and run a Shaarli image](#get-and-run-a-shaarli-image)[](.html)
4- [Resources](#resources)[](.html)
5
6## Docker usage
7### Basics
8Install [Docker](https://www.docker.com/), by following the instructions relevant[](.html)
9to your OS / distribution, and start the service.
10
11#### Search an image on [DockerHub](https://hub.docker.com/)[](.html)
12
13```bash
14$ docker search debian
15
16NAME DESCRIPTION STARS OFFICIAL AUTOMATED
17ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK][](.html)
18debian Debian is a Linux distribution that's comp... 603 [OK][](.html)
19google/debian 47 [OK][](.html)
20```
21
22#### Show available tags for a repository
23```bash
24$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool
25
26% Total % Received % Xferd Average Speed Time Time Time Current
27Dload Upload Total Spent Left Speed
28100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433
29```
30
31Sample output:
32```json
33[[](.html)
34 {
35 "layer": "85a02782",
36 "name": "stretch"
37 },
38 {
39 "layer": "59abecbc",
40 "name": "testing"
41 },
42 {
43 "layer": "bf0fd686",
44 "name": "unstable"
45 },
46 {
47 "layer": "60c52dbe",
48 "name": "wheezy"
49 },
50 {
51 "layer": "c5b806fe",
52 "name": "wheezy-backports"
53 }
54]
55
56```
57
58#### Pull an image from DockerHub
59```bash
60$ docker pull repository[:tag][](.html)
61
62$ docker pull debian:wheezy
63wheezy: Pulling from debian
644c8cbfd2973e: Pull complete
6560c52dbe9d91: Pull complete
66Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
67Status: Downloaded newer image for debian:wheezy
68```
69
70## Get and run a Shaarli image
71### DockerHub repository
72The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/)[](.html)
73repository.
74
75### Available image tags
76- `latest`: master branch (tarball release)
77- `stable`: stable branch (tarball release)
78- `dev`: master branch (Git clone)
79
80All images rely on:
81- [Debian 8 Jessie](https://hub.docker.com/_/debian/)[](.html)
82- [PHP5-FPM](http://php-fpm.org/)[](.html)
83- [Nginx](http://nginx.org/)[](.html)
84
85### Download from DockerHub
86```bash
87$ docker pull shaarli/shaarli
88latest: Pulling from shaarli/shaarli
8932716d9fcddb: Pull complete
9084899d045435: Pull complete
914b6ad7444763: Pull complete
92e0345ef7a3e0: Pull complete
935c1dd344094f: Pull complete
946422305a200b: Pull complete
957d63f861dbef: Pull complete
963eb97210645c: Pull complete
97869319d746ff: Already exists
98869319d746ff: Pulling fs layer
99902b87aaaec9: Already exists
100Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
101Status: Downloaded newer image for shaarli/shaarli:latest
102```
103
104### Create and start a new container from the image
105```bash
106# map the host's :8000 port to the container's :80 port
107$ docker create -p 8000:80 shaarli/shaarli
108d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
109
110# launch the container in the background
111$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
112d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
113
114# list active containers
115$ docker ps
116CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
117d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo
118```
119
120### Stop and destroy a container
121```bash
122$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
123backstabbing_galileo
124
125# check the container is stopped
126$ docker ps
127CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
128
129# list ALL containers
130$ docker ps -a
131CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
132d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
133
134# destroy the container
135$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
136backstabbing_galileo
137
138$ docker ps -a
139CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
140```
141
142## Resources
143### Docker
144- [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/)[](.html)
145- [Dockerfile reference](https://docs.docker.com/reference/builder/)[](.html)
146- [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/)[](.html)
147- [Volumes](https://docs.docker.com/userguide/dockervolumes/)[](.html)
148
149### DockerHub
150- [Repositories](https://docs.docker.com/userguide/dockerrepos/)[](.html)
151- [Teams and organizations](https://docs.docker.com/docker-hub/orgs/)[](.html)
152- [GitHub automated build](https://docs.docker.com/docker-hub/github/)[](.html)
153
154### Service management
155- [Using supervisord](https://docs.docker.com/articles/using_supervisord/)[](.html)
156- [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon)[](.html)
157- [supervisord](http://supervisord.org/)[](.html)
diff --git a/doc/Download-CSS-styles-from-an-OPML-list.html b/doc/Download-CSS-styles-from-an-OPML-list.html
index 7d7fe968..aaafbfeb 100644
--- a/doc/Download-CSS-styles-from-an-OPML-list.html
+++ b/doc/Download-CSS-styles-from-an-OPML-list.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Download CSS styles from an OPML list</title> 7 <title>Shaarli Download CSS styles from an OPML list</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -78,7 +105,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
78<h1 id="download-css-styles-from-an-opml-list">Download CSS styles from an OPML list</h1> 105<h1 id="download-css-styles-from-an-opml-list">Download CSS styles from an OPML list</h1>
79<h3 id="download-css-styles-for-shaarlis-listed-in-an-opml-file">Download CSS styles for shaarlis listed in an opml file</h3> 106<h3 id="download-css-styles-for-shaarlis-listed-in-an-opml-file">Download CSS styles for shaarlis listed in an opml file</h3>
80<p>Example php script:</p> 107<p>Example php script:</p>
81<pre class="sourceCode php"><code class="sourceCode php">&lt;!---- <span class="ot">?</span>php --&gt; 108<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php">&lt;!---- <span class="ot">?</span>php --&gt;
82&lt;!---- Copyright <span class="ot">(</span>c<span class="ot">)</span> <span class="dv">2014</span> Nicolas Delsaux <span class="ot">(</span>https<span class="ot">:</span><span class="co">//github.com/Riduidel) --&gt;</span> 109&lt;!---- Copyright <span class="ot">(</span>c<span class="ot">)</span> <span class="dv">2014</span> Nicolas Delsaux <span class="ot">(</span>https<span class="ot">:</span><span class="co">//github.com/Riduidel) --&gt;</span>
83&lt;!---- License: zlib <span class="ot">(</span>http:<span class="co">//www.gzip.org/zlib/zlib_license.html) --&gt;</span> 110&lt;!---- License: zlib <span class="ot">(</span>http:<span class="co">//www.gzip.org/zlib/zlib_license.html) --&gt;</span>
84 111
@@ -226,6 +253,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
226<span class="kw">$knownStyles</span> = findKnownStyles<span class="ot">();</span> 253<span class="kw">$knownStyles</span> = findKnownStyles<span class="ot">();</span>
227copyUserStylesFrom<span class="ot">(</span>createShaarliHashFromOPMLL<span class="ot">(</span><span class="kw">SHAARLI_RSS_OPML</span><span class="ot">),</span> <span class="kw">$knownStyles</span><span class="ot">);</span> 254copyUserStylesFrom<span class="ot">(</span>createShaarliHashFromOPMLL<span class="ot">(</span><span class="kw">SHAARLI_RSS_OPML</span><span class="ot">),</span> <span class="kw">$knownStyles</span><span class="ot">);</span>
228 255
229&lt;!--- <span class="ot">?</span> ----&gt;</code></pre> 256&lt;!--- <span class="ot">?</span> ----&gt;</code></pre></div>
230</body> 257</body>
231</html> 258</html>
diff --git a/doc/Download.html b/doc/Download.html
index 5f39c70f..6d668e8e 100644
--- a/doc/Download.html
+++ b/doc/Download.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Download</title> 7 <title>Shaarli Download</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -80,18 +107,18 @@ code > span.er { color: #ff0000; font-weight: bold; }
80<h3 id="latest-stable-revision">Latest stable revision</h3> 107<h3 id="latest-stable-revision">Latest stable revision</h3>
81<p>This revision has been <a href="https://github.com/shaarli/Shaarli/releases">released</a> and tested.<a href=".html"></a></p> 108<p>This revision has been <a href="https://github.com/shaarli/Shaarli/releases">released</a> and tested.<a href=".html"></a></p>
82<h4 id="clone-with-git-recommended">Clone with Git (recommended)</h4> 109<h4 id="clone-with-git-recommended">Clone with Git (recommended)</h4>
83<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git -b stable shaarli</code></pre> 110<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git -b stable shaarli</code></pre></div>
84<h4 id="download-as-an-archive">Download as an archive</h4> 111<h4 id="download-as-an-archive">Download as an archive</h4>
85<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">wget</span> https://github.com/shaarli/Shaarli/archive/stable.zip 112<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">wget</span> https://github.com/shaarli/Shaarli/archive/stable.zip
86$ <span class="kw">unzip</span> stable.zip 113$ <span class="kw">unzip</span> stable.zip
87$ <span class="kw">mv</span> Shaarli-stable shaarli</code></pre> 114$ <span class="kw">mv</span> Shaarli-stable shaarli</code></pre></div>
88<p>Tarballs are also available:</p> 115<p>Tarballs are also available:</p>
89<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">wget</span> https://github.com/shaarli/Shaarli/archive/stable.tar.gz 116<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">wget</span> https://github.com/shaarli/Shaarli/archive/stable.tar.gz
90$ <span class="kw">tar</span> xvf stable.tar.gz 117$ <span class="kw">tar</span> xvf stable.tar.gz
91$ <span class="kw">mv</span> Shaarli-stable shaarli</code></pre> 118$ <span class="kw">mv</span> Shaarli-stable shaarli</code></pre></div>
92<h3 id="development-mainline">Development (mainline)</h3> 119<h3 id="development-mainline">Development (mainline)</h3>
93<p><em>Use at your own risk!</em></p> 120<p><em>Use at your own risk!</em></p>
94<p>To get the latest changes:</p> 121<p>To get the latest changes:</p>
95<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli</code></pre> 122<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli</code></pre></div>
96</body> 123</body>
97</html> 124</html>
diff --git a/doc/Example-patch---add-new-via-field-for-links.html b/doc/Example-patch---add-new-via-field-for-links.html
index 388ff963..d6f9a92e 100644
--- a/doc/Example-patch---add-new-via-field-for-links.html
+++ b/doc/Example-patch---add-new-via-field-for-links.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Example patch add new via field for links</title> 7 <title>Shaarli Example patch add new via field for links</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/FAQ.html b/doc/FAQ.html
index 33eb7c60..72343b3f 100644
--- a/doc/FAQ.html
+++ b/doc/FAQ.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - FAQ</title> 7 <title>Shaarli FAQ</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/Firefox-share.html b/doc/Firefox-share.html
index 2943a86d..0ae70605 100644
--- a/doc/Firefox-share.html
+++ b/doc/Firefox-share.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Firefox share</title> 7 <title>Shaarli Firefox share</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -69,6 +78,19 @@
69<li>When you are visiting a webpage you would like to share with Shaarli, click the Firefox <em>Share</em> button <a href="images/firefoxshare.png.html">images/firefoxshare.png</a></li> 78<li>When you are visiting a webpage you would like to share with Shaarli, click the Firefox <em>Share</em> button <a href="images/firefoxshare.png.html">images/firefoxshare.png</a></li>
70<li>You can edit your link before and after saving, just like the bookmarklet above.</li> 79<li>You can edit your link before and after saving, just like the bookmarklet above.</li>
71</ul> 80</ul>
72<p>|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. |<br />|------|-------------------------------------------------------------------------------|</p> 81<table style="width:100%;">
82<colgroup>
83<col style="width: 8%" />
84<col style="width: 91%" />
85</colgroup>
86<thead>
87<tr class="header">
88<th></th>
89<th>Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.</th>
90</tr>
91</thead>
92<tbody>
93</tbody>
94</table>
73</body> 95</body>
74</html> 96</html>
diff --git a/doc/GnuPG-signature.html b/doc/GnuPG-signature.html
index a1210b75..c187c996 100644
--- a/doc/GnuPG-signature.html
+++ b/doc/GnuPG-signature.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - GnuPG signature</title> 7 <title>Shaarli GnuPG signature</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -78,10 +105,13 @@ code > span.er { color: #ff0000; font-weight: bold; }
78<h1 id="gnupg-signature">GnuPG signature</h1> 105<h1 id="gnupg-signature">GnuPG signature</h1>
79<h2 id="introduction">Introduction</h2> 106<h2 id="introduction">Introduction</h2>
80<h3 id="pgp-and-gpg">PGP and GPG</h3> 107<h3 id="pgp-and-gpg">PGP and GPG</h3>
81<p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good [](.html)<br />Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication,<br />signature and encryption.</p> 108<p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good [](.html)<br />
109Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication,<br />
110signature and encryption.</p>
82<p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify:<a href=".html"></a></p> 111<p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify:<a href=".html"></a></p>
83<ul> 112<ul>
84<li>Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master [](.html)<br />Keys</a></li> 113<li>Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master [](.html)<br />
114Keys</a></li>
85<li><a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases &amp; maintainer identity<a href=".html"></a></li> 115<li><a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases &amp; maintainer identity<a href=".html"></a></li>
86</ul> 116</ul>
87<h3 id="trust">Trust</h3> 117<h3 id="trust">Trust</h3>
@@ -95,9 +125,12 @@ code > span.er { color: #ff0000; font-weight: bold; }
95<li><a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a><a href=".html"></a></li> 125<li><a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a><a href=".html"></a></li>
96</ul> 126</ul>
97<h2 id="generate-a-gpg-key">Generate a GPG key</h2> 127<h2 id="generate-a-gpg-key">Generate a GPG key</h2>
98<p>See <a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a>.<a href=".html"></a></p> 128<ul>
129<li><a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a> (StackOverflow)<a href=".html"></a></li>
130<li><a href="https://help.github.com/articles/generating-a-gpg-key/">Generating a GPG key</a> (GitHub)<a href=".html"></a></li>
131</ul>
99<h3 id="gpg---provide-identity-information">gpg - provide identity information</h3> 132<h3 id="gpg---provide-identity-information">gpg - provide identity information</h3>
100<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --gen-key 133<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --gen-key
101 134
102<span class="kw">gpg</span> (GnuPG) <span class="kw">2.1.6;</span> <span class="kw">Copyright</span> (C) <span class="kw">2015</span> Free Software Foundation, Inc. 135<span class="kw">gpg</span> (GnuPG) <span class="kw">2.1.6;</span> <span class="kw">Copyright</span> (C) <span class="kw">2015</span> Free Software Foundation, Inc.
103<span class="kw">This</span> is free software: you are free to change and redistribute it. 136<span class="kw">This</span> is free software: you are free to change and redistribute it.
@@ -116,7 +149,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
116<span class="kw">We</span> need to generate a lot of random bytes. It is a good idea to perform 149<span class="kw">We</span> need to generate a lot of random bytes. It is a good idea to perform
117<span class="kw">some</span> other action (type on the keyboard, move the mouse, utilize the 150<span class="kw">some</span> other action (type on the keyboard, move the mouse, utilize the
118<span class="kw">disks</span>) <span class="kw">during</span> the prime generation<span class="kw">;</span> <span class="kw">this</span> gives the random number 151<span class="kw">disks</span>) <span class="kw">during</span> the prime generation<span class="kw">;</span> <span class="kw">this</span> gives the random number
119<span class="kw">generator</span> a better chance to gain enough entropy.</code></pre> 152<span class="kw">generator</span> a better chance to gain enough entropy.</code></pre></div>
120<h3 id="gpg---entropy-interlude">gpg - entropy interlude</h3> 153<h3 id="gpg---entropy-interlude">gpg - entropy interlude</h3>
121<p>At this point, you will:</p> 154<p>At this point, you will:</p>
122<ul> 155<ul>
@@ -124,7 +157,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
124<li>be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em></li> 157<li>be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em></li>
125</ul> 158</ul>
126<h3 id="gpg---key-creation-confirmation">gpg - key creation confirmation</h3> 159<h3 id="gpg---key-creation-confirmation">gpg - key creation confirmation</h3>
127<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">gpg</span>: key A9D53A3E marked as ultimately trusted 160<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">gpg</span>: key A9D53A3E marked as ultimately trusted
128<span class="kw">public</span> and secret key created and signed. 161<span class="kw">public</span> and secret key created and signed.
129 162
130<span class="kw">gpg</span>: checking the trustdb 163<span class="kw">gpg</span>: checking the trustdb
@@ -133,69 +166,11 @@ code > span.er { color: #ff0000; font-weight: bold; }
133<span class="kw">pub</span> rsa2048/A9D53A3E 2015-07-31 166<span class="kw">pub</span> rsa2048/A9D53A3E 2015-07-31
134 <span class="kw">Key</span> fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E 167 <span class="kw">Key</span> fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E
135<span class="kw">uid</span> [ultimate] Marvin the Paranoid Android <span class="kw">&lt;</span>marvin@h2g2.net<span class="kw">&gt;</span>[](.html) 168<span class="kw">uid</span> [ultimate] Marvin the Paranoid Android <span class="kw">&lt;</span>marvin@h2g2.net<span class="kw">&gt;</span>[](.html)
136<span class="kw">sub</span> rsa2048/8C0EACF1 2015-07-31</code></pre> 169<span class="kw">sub</span> rsa2048/8C0EACF1 2015-07-31</code></pre></div>
137<h3 id="gpg---submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3> 170<h3 id="gpg---submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3>
138<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --keyserver pgp.mit.edu --send-keys A9D53A3E 171<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --keyserver pgp.mit.edu --send-keys A9D53A3E
139<span class="kw">gpg</span>: sending key A9D53A3E to hkp server pgp.mit.edu</code></pre> 172<span class="kw">gpg</span>: sending key A9D53A3E to hkp server pgp.mit.edu</code></pre></div>
140<h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2> 173<h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2>
141<p>See <a href="http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your [](.html)<br />releases</a>.</p> 174<p>See <a href="Release-Shaarli.html">Release Shaarli</a>.</p>
142<h3 id="prerequisites">Prerequisites</h3>
143<p>This guide assumes that you have:</p>
144<ul>
145<li>a GPG key matching your GitHub authentication credentials
146<ul>
147<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
148</ul></li>
149<li>a GitHub fork of Shaarli</li>
150<li>a local clone of your Shaarli fork, with the following remotes:
151<ul>
152<li><code>origin</code> pointing to your GitHub fork</li>
153<li><code>upstream</code> pointing to the main Shaarli repository</li>
154</ul></li>
155<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
156</ul>
157<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
158<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
159
160<span class="co"># create a new branch</span>
161$ <span class="kw">git</span> fetch upstream
162$ <span class="kw">git</span> checkout upstream/master -b v0.5.0
163
164<span class="co"># bump the version number</span>
165$ <span class="kw">vim</span> index.php shaarli_version.php
166
167<span class="co"># commit the changes</span>
168$ <span class="kw">git</span> add index.php shaarli_version.php
169$ <span class="kw">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>
170
171<span class="co"># push the commit on your GitHub fork</span>
172$ <span class="kw">git</span> push origin v0.5.0</code></pre>
173<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
174<p>This one is pretty straightforward ;-)</p>
175<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
176<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
177$ <span class="kw">git</span> checkout master
178$ <span class="kw">git</span> fetch upstream
179$ <span class="kw">git</span> pull upstream master
180
181<span class="co"># create a signed tag</span>
182$ <span class="kw">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0
183
184<span class="co"># push it to &quot;upstream&quot;</span>
185$ <span class="kw">git</span> push --tags upstream</code></pre>
186<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
187<p><a href="https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.<a href=".html"></a></p>
188<p>Let's have a look at its signature!</p>
189<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
190$ <span class="kw">git</span> fetch upstream
191
192<span class="co"># get the SHA1 reference of the tag</span>
193$ <span class="kw">git</span> show-ref tags/v0.5.0
194<span class="kw">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
195
196<span class="co"># verify the tag signature information</span>
197$ <span class="kw">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
198<span class="kw">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
199<span class="kw">gpg</span>: Good signature from <span class="st">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre>
200</body> 175</body>
201</html> 176</html>
diff --git a/doc/GnuPG-signature.md b/doc/GnuPG-signature.md
index e8dbdb11..b0028d55 100644
--- a/doc/GnuPG-signature.md
+++ b/doc/GnuPG-signature.md
@@ -20,7 +20,8 @@ Trust can be gained by having your key signed by other people (and signing their
20- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html) 20- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html)
21 21
22## Generate a GPG key 22## Generate a GPG key
23See [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717).[](.html) 23- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)[](.html)
24- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)[](.html)
24 25
25### gpg - provide identity information 26### gpg - provide identity information
26```bash 27```bash
@@ -72,70 +73,5 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu
72``` 73```
73 74
74## Create and push a GPG-signed tag 75## Create and push a GPG-signed tag
75See [Git - Maintaining a project - Tagging your [](.html)
76releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases).
77
78### Prerequisites
79This guide assumes that you have:
80- a GPG key matching your GitHub authentication credentials
81 - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig`
82- a GitHub fork of Shaarli
83- a local clone of your Shaarli fork, with the following remotes:
84 - `origin` pointing to your GitHub fork
85 - `upstream` pointing to the main Shaarli repository
86- maintainer permissions on the main Shaarli repository (to push the signed tag)
87
88### Bump Shaarli's version
89```bash
90$ cd /path/to/shaarli
91
92# create a new branch
93$ git fetch upstream
94$ git checkout upstream/master -b v0.5.0
95
96# bump the version number
97$ vim index.php shaarli_version.php
98
99# commit the changes
100$ git add index.php shaarli_version.php
101$ git commit -s -m "Bump version to v0.5.0"
102
103# push the commit on your GitHub fork
104$ git push origin v0.5.0
105```
106
107### Create and merge a Pull Request
108This one is pretty straightforward ;-)
109
110### Create and push a signed tag
111```bash
112# update your local copy
113$ git checkout master
114$ git fetch upstream
115$ git pull upstream master
116 76
117# create a signed tag 77See [Release Shaarli](Release-Shaarli.html).
118$ git tag -s -m "Release v0.5.0" v0.5.0
119
120# push it to "upstream"
121$ git push --tags upstream
122```
123
124### Verify a signed tag
125[`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.[](.html)
126
127Let's have a look at its signature!
128
129```bash
130$ cd /path/to/shaarli
131$ git fetch upstream
132
133# get the SHA1 reference of the tag
134$ git show-ref tags/v0.5.0
135f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
136
137# verify the tag signature information
138$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
139gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
140gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
141```
diff --git a/doc/Home.html b/doc/Home.html
index 39d951c8..827d256f 100644
--- a/doc/Home.html
+++ b/doc/Home.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Home</title> 7 <title>Shaarli Home</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -61,7 +70,7 @@
61<p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki<embed src=".html" /></p> 70<p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki<embed src=".html" /></p>
62<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p> 71<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
63<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.<a href=".html"></a></p> 72<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.<a href=".html"></a></p>
64<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/44">general discussion</a> or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.<a href=".html"></a></p> 73<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.<a href=".html"></a></p>
65<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.<a href=".html"></a></p> 74<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.<a href=".html"></a></p>
66<p><em>Note: This documentation is available online at <a href="https://github.com/shaarli/Shaarli/wiki" class="uri">https://github.com/shaarli/Shaarli/wiki</a>, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p> 75<p><em>Note: This documentation is available online at <a href="https://github.com/shaarli/Shaarli/wiki" class="uri">https://github.com/shaarli/Shaarli/wiki</a>, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p>
67</body> 76</body>
diff --git a/doc/Home.md b/doc/Home.md
index a824d983..38413f24 100644
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -7,7 +7,7 @@ Here you can find some info on how to use, configure, tweak and solve problems w
7 7
8For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).[](.html) 8For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).[](.html)
9 9
10If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/44) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) 10If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).[](.html)
11 11
12If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).[](.html) 12If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).[](.html)
13 13
diff --git a/doc/Plugin-System.html b/doc/Plugin-System.html
index cb1cb746..2a660c49 100644
--- a/doc/Plugin-System.html
+++ b/doc/Plugin-System.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Plugin System</title> 7 <title>Shaarli Plugin System</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -77,32 +104,11 @@ code > span.er { color: #ff0000; font-weight: bold; }
77</div> 104</div>
78<h1 id="plugin-system">Plugin System</h1> 105<h1 id="plugin-system">Plugin System</h1>
79<blockquote> 106<blockquote>
80<p>Note: Plugin current status - in developpement (not merged into master).</p> 107<p>Note: Plugin current status - in development (not merged into master).</p>
81</blockquote> 108</blockquote>
82<p><a href="#plugin-user-guide"><strong>I am a user.</strong> Plugin User Guide.</a><a href=".html"></a></p> 109<p><a href="#developer-api"><strong>I am a developer.</strong> Developer API.</a><a href=".html"></a></p>
83<p><a href="#developper-api"><strong>I am a developper.</strong> Developper API.</a><a href=".html"></a></p>
84<p><a href="#guide-for-template-designer"><strong>I am a template designer.</strong> Guide for template designer.</a><a href=".html"></a></p> 110<p><a href="#guide-for-template-designer"><strong>I am a template designer.</strong> Guide for template designer.</a><a href=".html"></a></p>
85<h2 id="plugin-user-guide">Plugin User Guide</h2> 111<h2 id="developer-api">Developer API</h2>
86<h3 id="manage-plugins">Manage plugins</h3>
87<p>In <code>config.php</code>, change $GLOBALS<a href="&#39;ENABLED_PLUGINS&#39;]-array:.html">'config'['ENABLED_PLUGINS'] array:</a></p>
88<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]](</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span>.html<span class="ot">)</span></code></pre>
89<p>Full list:</p>
90<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(](</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span>.html<span class="ot">)</span>
91 <span class="st">&#39;qrcode&#39;</span><span class="ot">,</span> <span class="st">&#39;archiveorg&#39;</span><span class="ot">,</span> <span class="st">&#39;readityourself&#39;</span><span class="ot">,</span> <span class="st">&#39;playvideos&#39;</span><span class="ot">,</span>
92 <span class="st">&#39;wallabag&#39;</span><span class="ot">,</span> <span class="st">&#39;markdown&#39;</span><span class="ot">,</span> <span class="st">&#39;addlink_toolbar&#39;</span><span class="ot">,</span>
93<span class="ot">);</span></code></pre>
94<h3 id="list-of-plugins">List of plugins</h3>
95<p>Plugin maintained by the community:</p>
96<ul>
97<li>Archive.org - add a clickable icon to every link to archive.org.</li>
98<li>Addlink in toolbar - add a field to paste new links URL in toolbar.</li>
99<li>Markdown - write and display Shaare in Markdown.</li>
100<li>Play videos - popup to play all videos displayed in linklist.</li>
101<li>QRCode - add a clickable icon generating a QRCode for every link.</li>
102<li>ReadItYourself - add a clickable icon for ReadItYourself.</li>
103<li>Wallabag - add a clickable icon for Wallabag.</li>
104</ul>
105<h2 id="developper-api">Developper API</h2>
106<h3 id="what-can-i-do-with-plugins">What can I do with plugins?</h3> 112<h3 id="what-can-i-do-with-plugins">What can I do with plugins?</h3>
107<p>The plugin system let you:</p> 113<p>The plugin system let you:</p>
108<ul> 114<ul>
@@ -134,72 +140,86 @@ code > span.er { color: #ff0000; font-weight: bold; }
134<p>Template placeholders are displayed in template in specific places.</p> 140<p>Template placeholders are displayed in template in specific places.</p>
135<p>RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.</p> 141<p>RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.</p>
136<p>For example, let's add a value in the placeholder <code>top_placeholder</code> which is displayed at the top of my page:</p> 142<p>For example, let's add a value in the placeholder <code>top_placeholder</code> which is displayed at the top of my page:</p>
137<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">[]</span> = <span class="st">&#39;My content&#39;</span><span class="ot">;](]</span>-=-<span class="st">&#39;My-content&#39;</span><span class="ot">;</span>.html<span class="ot">)</span> 143<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">[]</span> = <span class="st">&#39;My content&#39;</span><span class="ot">;](]</span>-=-<span class="st">&#39;My-content&#39;</span><span class="ot">;</span>.html<span class="ot">)</span>
138<span class="co"># OR</span> 144<span class="co"># OR</span>
139<span class="fu">array_push</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">],</span> <span class="st">&#39;My&#39;</span><span class="ot">,</span> <span class="st">&#39;content&#39;</span><span class="ot">);[](</span>.html<span class="ot">)</span> 145<span class="fu">array_push</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">],</span> <span class="st">&#39;My&#39;</span><span class="ot">,</span> <span class="st">&#39;content&#39;</span><span class="ot">);[](</span>.html<span class="ot">)</span>
140 146
141<span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre> 147<span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div>
142<h4 id="data-manipulation">Data manipulation</h4> 148<h4 id="data-manipulation">Data manipulation</h4>
143<p>When a page is displayed, every variable send to the template engine is passed to plugins before that in <code>$data</code>.</p> 149<p>When a page is displayed, every variable send to the template engine is passed to plugins before that in <code>$data</code>.</p>
144<p>The data contained by this array can be altered before template rendering.</p> 150<p>The data contained by this array can be altered before template rendering.</p>
145<p>For exemple, in linklist, it is possible to alter every title:</p> 151<p>For exemple, in linklist, it is possible to alter every title:</p>
146<pre class="sourceCode php"><code class="sourceCode php"><span class="co">// mind the reference if you want $data to be altered</span> 152<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">// mind the reference if you want $data to be altered</span>
147<span class="kw">foreach</span> <span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;links&#39;</span><span class="ot">]</span> <span class="kw">as</span> &amp;<span class="kw">$value</span><span class="ot">)</span> {<span class="ot">[](</span>.html<span class="ot">)</span> 153<span class="kw">foreach</span> <span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;links&#39;</span><span class="ot">]</span> <span class="kw">as</span> &amp;<span class="kw">$value</span><span class="ot">)</span> {<span class="ot">[](</span>.html<span class="ot">)</span>
148 <span class="co">// String reverse every title.</span> 154 <span class="co">// String reverse every title.</span>
149 <span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]</span> = <span class="fu">strrev</span><span class="ot">(</span><span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]);[](</span>.html<span class="ot">)</span> 155 <span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]</span> = <span class="fu">strrev</span><span class="ot">(</span><span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]);[](</span>.html<span class="ot">)</span>
150} 156}
151 157
152<span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre> 158<span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div>
159<h3 id="metadata">Metadata</h3>
160<p>Every plugin needs a <code>&lt;plugin_name&gt;.meta</code> file, which is in fact an <code>.ini</code> file (<code>KEY=&quot;VALUE&quot;</code>), to be listed in plugin administration.</p>
161<p>Each file contain two keys:</p>
162<ul>
163<li><code>description</code>: plugin description</li>
164<li><code>parameters</code>: user parameter names, separated by a <code>;</code>.</li>
165</ul>
166<blockquote>
167<p>Note: In PHP, <code>parse_ini_file()</code> seems to want strings to be between by quotes <code>&quot;</code> in the ini file.</p>
168</blockquote>
153<h3 id="its-not-working">It's not working!</h3> 169<h3 id="its-not-working">It's not working!</h3>
154<p>Use <code>demo_plugin</code> as a functional example. It covers most of the plugin system features.</p> 170<p>Use <code>demo_plugin</code> as a functional example. It covers most of the plugin system features.</p>
155<p>If it's still not working, please <a href="https://github.com/shaarli/Shaarli/issues/new">open an issue</a>.<a href=".html"></a></p> 171<p>If it's still not working, please <a href="https://github.com/shaarli/Shaarli/issues/new">open an issue</a>.<a href=".html"></a></p>
156<h3 id="hooks">Hooks</h3> 172<h3 id="hooks">Hooks</h3>
157<table> 173<table style="width:42%;">
174<colgroup>
175<col style="width: 19%" />
176<col style="width: 22%" />
177</colgroup>
158<thead> 178<thead>
159<tr class="header"> 179<tr class="header">
160<th style="text-align: left;">Hooks</th> 180<th>Hooks</th>
161<th style="text-align: center;">Description</th> 181<th style="text-align: center;">Description</th>
162</tr> 182</tr>
163</thead> 183</thead>
164<tbody> 184<tbody>
165<tr class="odd"> 185<tr class="odd">
166<td style="text-align: left;"><a href="#render_header">render_header</a></td> 186<td><a href="#render_header">render_header</a></td>
167<td style="text-align: center;">Allow plugin to add content in page headers.</td> 187<td style="text-align: center;">Allow plugin to add content in page headers.</td>
168</tr> 188</tr>
169<tr class="even"> 189<tr class="even">
170<td style="text-align: left;"><a href="#render_includes">render_includes</a></td> 190<td><a href="#render_includes">render_includes</a></td>
171<td style="text-align: center;">Allow plugin to include their own CSS files.</td> 191<td style="text-align: center;">Allow plugin to include their own CSS files.</td>
172</tr> 192</tr>
173<tr class="odd"> 193<tr class="odd">
174<td style="text-align: left;"><a href="#render_footer">render_footer</a></td> 194<td><a href="#render_footer">render_footer</a></td>
175<td style="text-align: center;">Allow plugin to add content in page footer and include their own JS files.</td> 195<td style="text-align: center;">Allow plugin to add content in page footer and include their own JS files.</td>
176</tr> 196</tr>
177<tr class="even"> 197<tr class="even">
178<td style="text-align: left;"><a href="#render_linklist">render_linklist</a></td> 198<td><a href="#render_linklist">render_linklist</a></td>
179<td style="text-align: center;">It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</td> 199<td style="text-align: center;">It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</td>
180</tr> 200</tr>
181<tr class="odd"> 201<tr class="odd">
182<td style="text-align: left;"><a href="#render_editlink">render_editlink</a></td> 202<td><a href="#render_editlink">render_editlink</a></td>
183<td style="text-align: center;">Allow to add fields in the form, or display elements.</td> 203<td style="text-align: center;">Allow to add fields in the form, or display elements.</td>
184</tr> 204</tr>
185<tr class="even"> 205<tr class="even">
186<td style="text-align: left;"><a href="#render_tools">render_tools</a></td> 206<td><a href="#render_tools">render_tools</a></td>
187<td style="text-align: center;">Allow to add content at the end of the page.</td> 207<td style="text-align: center;">Allow to add content at the end of the page.</td>
188</tr> 208</tr>
189<tr class="odd"> 209<tr class="odd">
190<td style="text-align: left;"><a href="#render_picwall">render_picwall</a></td> 210<td><a href="#render_picwall">render_picwall</a></td>
191<td style="text-align: center;">Allow to add content at the top and bottom of the page.</td> 211<td style="text-align: center;">Allow to add content at the top and bottom of the page.</td>
192</tr> 212</tr>
193<tr class="even"> 213<tr class="even">
194<td style="text-align: left;"><a href="#render_tagcloud">render_tagcloud</a></td> 214<td><a href="#render_tagcloud">render_tagcloud</a></td>
195<td style="text-align: center;">Allow to add content at the top and bottom of the page.</td> 215<td style="text-align: center;">Allow to add content at the top and bottom of the page.</td>
196</tr> 216</tr>
197<tr class="odd"> 217<tr class="odd">
198<td style="text-align: left;"><a href="#render_daily">render_daily</a></td> 218<td><a href="#render_daily">render_daily</a></td>
199<td style="text-align: center;">Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</td> 219<td style="text-align: center;">Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</td>
200</tr> 220</tr>
201<tr class="even"> 221<tr class="even">
202<td style="text-align: left;"><a href="#savelink">savelink</a></td> 222<td><a href="#savelink">savelink</a></td>
203<td style="text-align: center;">Allow to alter the link being saved in the datastore.</td> 223<td style="text-align: center;">Allow to alter the link being saved in the datastore.</td>
204</tr> 224</tr>
205</tbody> 225</tbody>
@@ -393,6 +413,20 @@ code > span.er { color: #ff0000; font-weight: bold; }
393<li>tags</li> 413<li>tags</li>
394</ul> 414</ul>
395<h2 id="guide-for-template-designer">Guide for template designer</h2> 415<h2 id="guide-for-template-designer">Guide for template designer</h2>
416<h3 id="plugin-administration">Plugin administration</h3>
417<p>Your theme must include a plugin administration page: <code>pluginsadmin.html</code>.</p>
418<blockquote>
419<p>Note: repo's template link needs to be added when the PR is merged.</p>
420</blockquote>
421<p>Use the default one as an example.</p>
422<p>Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include <code>plugin_admin.js</code>, only if:</p>
423<ul>
424<li>you're using a table.</li>
425<li>you call orderUp() and orderUp() onclick on arrows.</li>
426<li>you add data-line and data-order to your rows.</li>
427</ul>
428<p>Otherwise, you can use your own JS as long as this field is send by the form:</p>
429<p><input type="hidden" name="order_{$key}" value="{$counter}"></p>
396<h3 id="placeholder-system">Placeholder system</h3> 430<h3 id="placeholder-system">Placeholder system</h3>
397<p>In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.</p> 431<p>In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.</p>
398<p>It's a RainTPL loop like this:</p> 432<p>It's a RainTPL loop like this:</p>
@@ -406,96 +440,104 @@ code > span.er { color: #ff0000; font-weight: bold; }
406<pre><code>{loop=&quot;$plugins_header.buttons_toolbar&quot;} 440<pre><code>{loop=&quot;$plugins_header.buttons_toolbar&quot;}
407 {$value} 441 {$value}
408{/loop}</code></pre> 442{/loop}</code></pre>
443<p>At the end of file, before clearing floating blocks:</p>
444<pre><code>{if=&quot;!empty($plugin_errors) &amp;&amp; isLoggedIn()&quot;}
445 &lt;ul class=&quot;errors&quot;&gt;
446 {loop=&quot;plugin_errors&quot;}
447 &lt;li&gt;{$value}&lt;/li&gt;
448 {/loop}
449 &lt;/ul&gt;
450{/if}</code></pre>
409<p><strong>includes.html</strong></p> 451<p><strong>includes.html</strong></p>
410<p>At the end of the file:</p> 452<p>At the end of the file:</p>
411<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_includes.css_files&quot;} 453<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_includes.css_files&quot;}
412<span class="kw">&lt;link</span><span class="ot"> type=</span><span class="st">&quot;text/css&quot;</span><span class="ot"> rel=</span><span class="st">&quot;stylesheet&quot;</span><span class="ot"> href=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">/&gt;</span> 454<span class="kw">&lt;link</span><span class="ot"> type=</span><span class="st">&quot;text/css&quot;</span><span class="ot"> rel=</span><span class="st">&quot;stylesheet&quot;</span><span class="ot"> href=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">/&gt;</span>
413{/loop}</code></pre> 455{/loop}</code></pre></div>
414<p><strong>page.footer.html</strong></p> 456<p><strong>page.footer.html</strong></p>
415<p>At the end of your footer notes:</p> 457<p>At the end of your footer notes:</p>
416<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.text&quot;} 458<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.text&quot;}
417 {$value} 459 {$value}
418{/loop}</code></pre> 460{/loop}</code></pre></div>
419<p>At the end of file:</p> 461<p>At the end of file:</p>
420<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.js_files&quot;} 462<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.js_files&quot;}
421 <span class="kw">&lt;script</span><span class="ot"> src=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">&gt;&lt;/script&gt;</span> 463 <span class="kw">&lt;script</span><span class="ot"> src=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">&gt;&lt;/script&gt;</span>
422{/loop}</code></pre> 464{/loop}</code></pre></div>
423<p><strong>linklist.html</strong></p> 465<p><strong>linklist.html</strong></p>
424<p>After search fields:</p> 466<p>After search fields:</p>
425<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_header.fields_toolbar&quot;} 467<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_header.fields_toolbar&quot;}
426 {$value} 468 {$value}
427{/loop}</code></pre> 469{/loop}</code></pre></div>
428<p>Before displaying the link list (after paging):</p> 470<p>Before displaying the link list (after paging):</p>
429<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_start_zone&quot;} 471<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_start_zone&quot;}
430 {$value} 472 {$value}
431{/loop}</code></pre> 473{/loop}</code></pre></div>
432<p>For every links (icons):</p> 474<p>For every links (icons):</p>
433<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$value.link_plugin&quot;} 475<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$value.link_plugin&quot;}
434 <span class="kw">&lt;span&gt;</span>{$value}<span class="kw">&lt;/span&gt;</span> 476 <span class="kw">&lt;span&gt;</span>{$value}<span class="kw">&lt;/span&gt;</span>
435{/loop}</code></pre> 477{/loop}</code></pre></div>
436<p>Before end paging:</p> 478<p>Before end paging:</p>
437<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_end_zone&quot;} 479<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_end_zone&quot;}
438 {$value} 480 {$value}
439{/loop}</code></pre> 481{/loop}</code></pre></div>
440<p><strong>linklist.paging.html</strong></p> 482<p><strong>linklist.paging.html</strong></p>
441<p>After the &quot;private only&quot; icon:</p> 483<p>After the &quot;private only&quot; icon:</p>
442<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$action_plugin&quot;} 484<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$action_plugin&quot;}
443 {$value} 485 {$value}
444{/loop}</code></pre> 486{/loop}</code></pre></div>
445<p><strong>editlink.html</strong></p> 487<p><strong>editlink.html</strong></p>
446<p>After tags field:</p> 488<p>After tags field:</p>
447<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$edit_link_plugin&quot;} 489<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$edit_link_plugin&quot;}
448 {$value} 490 {$value}
449{/loop}</code></pre> 491{/loop}</code></pre></div>
450<p><strong>tools.html</strong></p> 492<p><strong>tools.html</strong></p>
451<p>After the last tool:</p> 493<p>After the last tool:</p>
452<pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$tools_plugin&quot;} 494<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$tools_plugin&quot;}
453 {$value} 495 {$value}
454{/loop}</code></pre> 496{/loop}</code></pre></div>
455<p><strong>picwall.html</strong></p> 497<p><strong>picwall.html</strong></p>
456<p>Top:</p> 498<p>Top:</p>
457<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 499<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
458 {loop=&quot;$plugin_start_zone&quot;} 500 {loop=&quot;$plugin_start_zone&quot;}
459 {$value} 501 {$value}
460 {/loop} 502 {/loop}
461<span class="kw">&lt;/div&gt;</span></code></pre> 503<span class="kw">&lt;/div&gt;</span></code></pre></div>
462<p>Bottom:</p> 504<p>Bottom:</p>
463<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 505<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
464 {loop=&quot;$plugin_end_zone&quot;} 506 {loop=&quot;$plugin_end_zone&quot;}
465 {$value} 507 {$value}
466 {/loop} 508 {/loop}
467<span class="kw">&lt;/div&gt;</span></code></pre> 509<span class="kw">&lt;/div&gt;</span></code></pre></div>
468<p><strong>tagcloud.html</strong></p> 510<p><strong>tagcloud.html</strong></p>
469<p>Top:</p> 511<p>Top:</p>
470<pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 512<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
471 {loop=&quot;$plugin_start_zone&quot;} 513 {loop=&quot;$plugin_start_zone&quot;}
472 {$value} 514 {$value}
473 {/loop} 515 {/loop}
474 <span class="kw">&lt;/div&gt;</span></code></pre> 516 <span class="kw">&lt;/div&gt;</span></code></pre></div>
475<p>Bottom:</p> 517<p>Bottom:</p>
476<pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 518<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
477 {loop=&quot;$plugin_end_zone&quot;} 519 {loop=&quot;$plugin_end_zone&quot;}
478 {$value} 520 {$value}
479 {/loop} 521 {/loop}
480 <span class="kw">&lt;/div&gt;</span></code></pre> 522 <span class="kw">&lt;/div&gt;</span></code></pre></div>
481<p><strong>daily.html</strong></p> 523<p><strong>daily.html</strong></p>
482<p>Top:</p> 524<p>Top:</p>
483<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 525<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
484 {loop=&quot;$plugin_start_zone&quot;} 526 {loop=&quot;$plugin_start_zone&quot;}
485 {$value} 527 {$value}
486 {/loop} 528 {/loop}
487<span class="kw">&lt;/div&gt;</span></code></pre> 529<span class="kw">&lt;/div&gt;</span></code></pre></div>
488<p>After every link:</p> 530<p>After every link:</p>
489<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;dailyEntryFooter&quot;</span><span class="kw">&gt;</span> 531<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;dailyEntryFooter&quot;</span><span class="kw">&gt;</span>
490 {loop=&quot;$link.link_plugin&quot;} 532 {loop=&quot;$link.link_plugin&quot;}
491 {$value} 533 {$value}
492 {/loop} 534 {/loop}
493<span class="kw">&lt;/div&gt;</span></code></pre> 535<span class="kw">&lt;/div&gt;</span></code></pre></div>
494<p>Bottom:</p> 536<p>Bottom:</p>
495<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span> 537<div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
496 {loop=&quot;$plugin_end_zone&quot;} 538 {loop=&quot;$plugin_end_zone&quot;}
497 {$value} 539 {$value}
498 {/loop} 540 {/loop}
499<span class="kw">&lt;/div&gt;</span></code></pre> 541<span class="kw">&lt;/div&gt;</span></code></pre></div>
500</body> 542</body>
501</html> 543</html>
diff --git a/doc/Plugin-System.md b/doc/Plugin-System.md
index 8cba6664..8281e61d 100644
--- a/doc/Plugin-System.md
+++ b/doc/Plugin-System.md
@@ -1,44 +1,11 @@
1#Plugin System 1#Plugin System
2> Note: Plugin current status - in developpement (not merged into master). 2> Note: Plugin current status - in development (not merged into master).
3 3
4[**I am a user.** Plugin User Guide.](#plugin-user-guide)[](.html) 4[**I am a developer.** Developer API.](#developer-api)[](.html)
5
6[**I am a developper.** Developper API.](#developper-api)[](.html)
7 5
8[**I am a template designer.** Guide for template designer.](#guide-for-template-designer)[](.html) 6[**I am a template designer.** Guide for template designer.](#guide-for-template-designer)[](.html)
9 7
10## Plugin User Guide 8## Developer API
11
12### Manage plugins
13
14In `config.php`, change $GLOBALS['config'['ENABLED_PLUGINS'] array:]('ENABLED_PLUGINS']-array:.html)
15
16```php
17$GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html)
18```
19
20Full list:
21
22```php
23$GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html)
24 'qrcode', 'archiveorg', 'readityourself', 'playvideos',
25 'wallabag', 'markdown', 'addlink_toolbar',
26);
27```
28
29### List of plugins
30
31Plugin maintained by the community:
32
33 * Archive.org - add a clickable icon to every link to archive.org.
34 * Addlink in toolbar - add a field to paste new links URL in toolbar.
35 * Markdown - write and display Shaare in Markdown.
36 * Play videos - popup to play all videos displayed in linklist.
37 * QRCode - add a clickable icon generating a QRCode for every link.
38 * ReadItYourself - add a clickable icon for ReadItYourself.
39 * Wallabag - add a clickable icon for Wallabag.
40
41## Developper API
42 9
43### What can I do with plugins? 10### What can I do with plugins?
44 11
@@ -123,6 +90,17 @@ foreach ($data['links'] as &$value) {[](.html)
123return $data; 90return $data;
124``` 91```
125 92
93### Metadata
94
95Every plugin needs a `<plugin_name>.meta` file, which is in fact an `.ini` file (`KEY="VALUE"`), to be listed in plugin administration.
96
97Each file contain two keys:
98
99 * `description`: plugin description
100 * `parameters`: user parameter names, separated by a `;`.
101
102> Note: In PHP, `parse_ini_file()` seems to want strings to be between by quotes `"` in the ini file.
103
126### It's not working! 104### It's not working!
127 105
128Use `demo_plugin` as a functional example. It covers most of the plugin system features. 106Use `demo_plugin` as a functional example. It covers most of the plugin system features.
@@ -399,6 +377,24 @@ Allow to alter the link being saved in the datastore.
399 377
400## Guide for template designer 378## Guide for template designer
401 379
380### Plugin administration
381
382Your theme must include a plugin administration page: `pluginsadmin.html`.
383
384> Note: repo's template link needs to be added when the PR is merged.
385
386Use the default one as an example.
387
388Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include `plugin_admin.js`, only if:
389
390 * you're using a table.
391 * you call orderUp() and orderUp() onclick on arrows.
392 * you add data-line and data-order to your rows.
393
394Otherwise, you can use your own JS as long as this field is send by the form:
395
396<input type="hidden" name="order_{$key}" value="{$counter}">
397
402### Placeholder system 398### Placeholder system
403 399
404In order to make plugins work with every custom themes, you need to add variable placeholder in your templates. 400In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.
@@ -421,6 +417,16 @@ At the end of the menu:
421 {$value} 417 {$value}
422 {/loop} 418 {/loop}
423 419
420At the end of file, before clearing floating blocks:
421
422 {if="!empty($plugin_errors) && isLoggedIn()"}
423 <ul class="errors">
424 {loop="plugin_errors"}
425 <li>{$value}</li>
426 {/loop}
427 </ul>
428 {/if}
429
424**includes.html** 430**includes.html**
425 431
426At the end of the file: 432At the end of the file:
diff --git a/doc/Plugin-installation-&-configuration.html b/doc/Plugin-installation-&-configuration.html
new file mode 100644
index 00000000..3d2f9704
--- /dev/null
+++ b/doc/Plugin-installation-&-configuration.html
@@ -0,0 +1,154 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Plugin installation & configuration</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="plugin-installation-configuration">Plugin installation &amp; configuration</h1>
106<h2 id="plugin-installation">Plugin installation</h2>
107<p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p>
108<p>If you want to install a third party plugin:</p>
109<ul>
110<li>Download it.</li>
111<li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li>
112<li>Make sure you put it correctly:</li>
113</ul>
114<pre><code>| index.php
115| plugins/
116|---| custom_plugin/
117| |---| custom_plugin.php
118| |---| ...
119</code></pre>
120<ul>
121<li>Make sure your webserver can read and write the files in your plugin folder.</li>
122</ul>
123<h2 id="plugin-configuration">Plugin configuration</h2>
124<p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p>
125<p>Here you can enable and disable all plugins available, and configure them.</p>
126<p><img src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" alt="administration screenshot" /><a href=".html"></a></p>
127<h2 id="plugin-order">Plugin order</h2>
128<p>In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.</p>
129<p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p>
130<p><strong>Use case</strong>: The (non existent) plugin <code>shaares_footer</code> adds a footer to every shaare in Markdown syntax. It needs to be processed <em>before</em> (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.</p>
131<h2 id="file-mode">File mode</h2>
132<p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p>
133<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]](</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span>.html<span class="ot">)</span></code></pre></div>
134<p>You can edit them manually here.<br />
135Example:</p>
136<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(](</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span>.html<span class="ot">)</span>
137 <span class="st">&#39;qrcode&#39;</span><span class="ot">,</span>
138 <span class="st">&#39;archiveorg&#39;</span><span class="ot">,</span>
139 <span class="st">&#39;wallabag&#39;</span><span class="ot">,</span>
140 <span class="st">&#39;markdown&#39;</span><span class="ot">,</span>
141<span class="ot">);</span></code></pre></div>
142<h3 id="plugin-usage">Plugin usage</h3>
143<p>Usage of each plugin is documented in it's README file:</p>
144<ul>
145<li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li>
146<li><code>archiveorg</code>: For each link, add an Archive.org icon</li>
147<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md"><code>markdown</code></a>: Render shaare description with Markdown syntax.<a href=".html"></a></li>
148<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md"><code>playvideos</code></a>: Add a button in the toolbar allowing to watch all videos.<a href=".html"></a></li>
149<li><code>qrcode</code>: For each link, add a QRCode icon.</li>
150<li><code>readityourself</code>: For each link, add a ReadItYourself icon to save the shaared URL</li>
151<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md"><code>wallabag</code></a>: For each link, add a Wallabag icon to save it in your instance.<a href=".html"></a></li>
152</ul>
153</body>
154</html>
diff --git a/doc/Plugin-installation-&-configuration.md b/doc/Plugin-installation-&-configuration.md
new file mode 100644
index 00000000..c260aa1a
--- /dev/null
+++ b/doc/Plugin-installation-&-configuration.md
@@ -0,0 +1,69 @@
1#Plugin installation & configuration
2## Plugin installation
3
4There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.
5
6If you want to install a third party plugin:
7
8 * Download it.
9 * Put it in the `plugins` directory in Shaarli's installation folder.
10 * Make sure you put it correctly:
11
12```
13| index.php
14| plugins/
15|---| custom_plugin/
16| |---| custom_plugin.php
17| |---| ...
18
19```
20
21 * Make sure your webserver can read and write the files in your plugin folder.
22
23## Plugin configuration
24
25In Shaarli's administration page (`Tools` link), go to `Plugin administration`.
26
27Here you can enable and disable all plugins available, and configure them.
28
29![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67)[](.html)
30
31## Plugin order
32
33In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.
34
35This is important in case plugins are depending on each other. Read plugins README details for more information.
36
37**Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.
38
39## File mode
40
41Enabled plugin are stored in your `config.php` parameters file, under the `array`:
42
43```php
44$GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html)
45```
46
47You can edit them manually here.
48Example:
49
50```php
51$GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html)
52 'qrcode',
53 'archiveorg',
54 'wallabag',
55 'markdown',
56);
57```
58
59### Plugin usage
60
61Usage of each plugin is documented in it's README file:
62
63 * `addlink-toolbar`: Adds the addlink input on the linklist page
64 * `archiveorg`: For each link, add an Archive.org icon
65 * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax.[](.html)
66 * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.[](.html)
67 * `qrcode`: For each link, add a QRCode icon.
68 * `readityourself`: For each link, add a ReadItYourself icon to save the shaared URL
69 * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance.[](.html)
diff --git a/doc/Plugin-list.html b/doc/Plugin-list.html
new file mode 100644
index 00000000..16eca046
--- /dev/null
+++ b/doc/Plugin-list.html
@@ -0,0 +1,87 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Plugin list</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Installation
19<ul>
20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
30<li><a href="Usage.html">Usage</a>
31<ul>
32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
34<li><a href="Firefox-share.html">Firefox share</a></li>
35<li><a href="RSS-feeds.html">RSS feeds</a></li>
36</ul></li>
37<li>How To
38<ul>
39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
45</ul></li>
46<li><a href="Troubleshooting.html">Troubleshooting</a></li>
47<li><a href="Development.html">Development</a>
48<ul>
49<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
50<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
51<li><a href="Directory-structure.html">Directory structure</a></li>
52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
55<li><a href="Security.html">Security</a></li>
56<li><a href="Static-analysis.html">Static analysis</a></li>
57<li><a href="Theming.html">Theming</a></li>
58<li><a href="Unit-tests.html">Unit tests</a></li>
59</ul></li>
60<li>About
61<ul>
62<li><a href="FAQ.html">FAQ</a></li>
63<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
64<li><a href="TODO.html">TODO</a></li>
65</ul></li>
66</ul>
67</div>
68<h1 id="plugin-list">Plugin list</h1>
69<h2 id="community-plugins">Community plugins</h2>
70<p>These plugins are maintained by the community:</p>
71<ul>
72<li>Archive.org - add a clickable icon to every link to archive.org.</li>
73<li>Addlink in toolbar - add a field to paste new links URL in toolbar.</li>
74<li>Markdown - write and display Shaare in Markdown.</li>
75<li>Play videos - popup to play all videos displayed in linklist.</li>
76<li>QRCode - add a clickable icon generating a QRCode for every link.</li>
77<li>ReadItYourself - add a clickable icon for ReadItYourself.</li>
78<li>Wallabag - add a clickable icon for Wallabag.</li>
79</ul>
80<h2 id="third-party-plugins">Third party plugins</h2>
81<ul>
82<li><a href="https://github.com/kalvn/shaarli-plugin-autosave">autosave</a> by <a href="https://github.com/kalvn">@kalvn</a>: Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.<a href=".html"></a></li>
83<li><a href="https://github.com/ArthurHoaro/code-coloration">Code Coloration</a> by <a href="https://github.com/ArthurHoaro">@ArthurHoaro</a>: client side code syntax highlighter.<a href=".html"></a></li>
84<li><a href="https://github.com/alexisju/social">social</a> by <a href="https://github.com/alexisju">@alexisju</a>: share links to social networks.<a href=".html"></a></li>
85</ul>
86</body>
87</html>
diff --git a/doc/Plugin-list.md b/doc/Plugin-list.md
new file mode 100644
index 00000000..bb4f553b
--- /dev/null
+++ b/doc/Plugin-list.md
@@ -0,0 +1,18 @@
1#Plugin list
2## Community plugins
3
4These plugins are maintained by the community:
5
6 * Archive.org - add a clickable icon to every link to archive.org.
7 * Addlink in toolbar - add a field to paste new links URL in toolbar.
8 * Markdown - write and display Shaare in Markdown.
9 * Play videos - popup to play all videos displayed in linklist.
10 * QRCode - add a clickable icon generating a QRCode for every link.
11 * ReadItYourself - add a clickable icon for ReadItYourself.
12 * Wallabag - add a clickable icon for Wallabag.
13
14## Third party plugins
15
16 * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html)
17 * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html)
18 * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html)
diff --git a/doc/RSS-feeds.html b/doc/RSS-feeds.html
index 859869bf..9b1447ac 100644
--- a/doc/RSS-feeds.html
+++ b/doc/RSS-feeds.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - RSS feeds</title> 7 <title>Shaarli RSS feeds</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -57,6 +66,20 @@
57</ul> 66</ul>
58</div> 67</div>
59<h1 id="rss-feeds">RSS feeds</h1> 68<h1 id="rss-feeds">RSS feeds</h1>
69<h3 id="feeds-options">Feeds options</h3>
70<p>Feeds are available in ATOM with <code>?do=atom</code> and RSS with <code>do=RSS</code>.</p>
71<p>Options:</p>
72<ul>
73<li>You can use <code>permalinks</code> in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
74<ul>
75<li>E.G. <code>https://my.shaarli.domain/?do=atom&amp;permalinks</code>.</li>
76</ul></li>
77<li>You can use <code>nb</code> parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: <code>50</code>). The keyword <code>all</code> is available if you want everything.
78<ul>
79<li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=42</code></li>
80<li><code>https://my.shaarli.domain/?do=atom&amp;permalinks&amp;nb=all</code></li>
81</ul></li>
82</ul>
60<h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3> 83<h3 id="rss-feeds-or-picture-wall-for-a-specific-searchtag">RSS Feeds or Picture Wall for a specific search/tag</h3>
61<p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p> 84<p>It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to <strong>only display results of a specific search, or for a specific tag</strong>.</p>
62<p>For example, if you want to subscribe only to links tagged <code>photography</code>:</p> 85<p>For example, if you want to subscribe only to links tagged <code>photography</code>:</p>
diff --git a/doc/RSS-feeds.md b/doc/RSS-feeds.md
index 764b3a49..757bed9a 100644
--- a/doc/RSS-feeds.md
+++ b/doc/RSS-feeds.md
@@ -1,5 +1,17 @@
1#RSS feeds 1#RSS feeds
2### Feeds options
3
4Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`.
5
6Options:
7- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
8 - E.G. `https://my.shaarli.domain/?do=atom&permalinks`.
9- You can use `nb` parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: `50`). The keyword `all` is available if you want everything.
10 - `https://my.shaarli.domain/?do=atom&permalinks&nb=42`
11 - `https://my.shaarli.domain/?do=atom&permalinks&nb=all`
12
2### RSS Feeds or Picture Wall for a specific search/tag 13### RSS Feeds or Picture Wall for a specific search/tag
14
3It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**. 15It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**.
4 16
5For example, if you want to subscribe only to links tagged `photography`: 17For example, if you want to subscribe only to links tagged `photography`:
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html
new file mode 100644
index 00000000..69b49478
--- /dev/null
+++ b/doc/Release-Shaarli.html
@@ -0,0 +1,171 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Release Shaarli</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="release-shaarli">Release Shaarli</h1>
106<p>See <a href="http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your [](.html)<br />
107releases</a>.</p>
108<h3 id="prerequisites">Prerequisites</h3>
109<p>This guide assumes that you have:</p>
110<ul>
111<li>a GPG key matching your GitHub authentication credentials
112<ul>
113<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
114</ul></li>
115<li>a GitHub fork of Shaarli</li>
116<li>a local clone of your Shaarli fork, with the following remotes:
117<ul>
118<li><code>origin</code> pointing to your GitHub fork</li>
119<li><code>upstream</code> pointing to the main Shaarli repository</li>
120</ul></li>
121<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
122<li><a href="http://pandoc.org/">Pandoc</a> needs to be installed.<a href=".html"></a></li>
123</ul>
124<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
125<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
126
127<span class="co"># create a new branch</span>
128$ <span class="kw">git</span> fetch upstream
129$ <span class="kw">git</span> checkout upstream/master -b v0.5.0
130
131<span class="co"># bump the version number</span>
132$ <span class="kw">vim</span> index.php shaarli_version.php
133
134<span class="co"># rebuild the documentation from the wiki</span>
135$ <span class="kw">make</span> htmldoc
136
137<span class="co"># commit the changes</span>
138$ <span class="kw">git</span> add index.php shaarli_version.php doc
139$ <span class="kw">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>
140
141<span class="co"># push the commit on your GitHub fork</span>
142$ <span class="kw">git</span> push origin v0.5.0</code></pre></div>
143<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
144<p>This one is pretty straightforward ;-)</p>
145<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
146<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
147$ <span class="kw">git</span> checkout master
148$ <span class="kw">git</span> fetch upstream
149$ <span class="kw">git</span> pull upstream master
150
151<span class="co"># create a signed tag</span>
152$ <span class="kw">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0
153
154<span class="co"># push it to &quot;upstream&quot;</span>
155$ <span class="kw">git</span> push --tags upstream</code></pre></div>
156<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
157<p><a href="https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.<a href=".html"></a></p>
158<p>Let's have a look at its signature!</p>
159<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
160$ <span class="kw">git</span> fetch upstream
161
162<span class="co"># get the SHA1 reference of the tag</span>
163$ <span class="kw">git</span> show-ref tags/v0.5.0
164<span class="kw">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
165
166<span class="co"># verify the tag signature information</span>
167$ <span class="kw">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
168<span class="kw">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
169<span class="kw">gpg</span>: Good signature from <span class="st">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre></div>
170</body>
171</html>
diff --git a/doc/Release-Shaarli.md b/doc/Release-Shaarli.md
new file mode 100644
index 00000000..d5044fe9
--- /dev/null
+++ b/doc/Release-Shaarli.md
@@ -0,0 +1,72 @@
1#Release Shaarli
2See [Git - Maintaining a project - Tagging your [](.html)
3releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases).
4
5### Prerequisites
6This guide assumes that you have:
7- a GPG key matching your GitHub authentication credentials
8 - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig`
9- a GitHub fork of Shaarli
10- a local clone of your Shaarli fork, with the following remotes:
11 - `origin` pointing to your GitHub fork
12 - `upstream` pointing to the main Shaarli repository
13- maintainer permissions on the main Shaarli repository (to push the signed tag)
14- [Pandoc](http://pandoc.org/) needs to be installed.[](.html)
15
16### Bump Shaarli's version
17```bash
18$ cd /path/to/shaarli
19
20# create a new branch
21$ git fetch upstream
22$ git checkout upstream/master -b v0.5.0
23
24# bump the version number
25$ vim index.php shaarli_version.php
26
27# rebuild the documentation from the wiki
28$ make htmldoc
29
30# commit the changes
31$ git add index.php shaarli_version.php doc
32$ git commit -s -m "Bump version to v0.5.0"
33
34# push the commit on your GitHub fork
35$ git push origin v0.5.0
36```
37
38### Create and merge a Pull Request
39This one is pretty straightforward ;-)
40
41### Create and push a signed tag
42```bash
43# update your local copy
44$ git checkout master
45$ git fetch upstream
46$ git pull upstream master
47
48# create a signed tag
49$ git tag -s -m "Release v0.5.0" v0.5.0
50
51# push it to "upstream"
52$ git push --tags upstream
53```
54
55### Verify a signed tag
56[`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.[](.html)
57
58Let's have a look at its signature!
59
60```bash
61$ cd /path/to/shaarli
62$ git fetch upstream
63
64# get the SHA1 reference of the tag
65$ git show-ref tags/v0.5.0
66f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
67
68# verify the tag signature information
69$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
70gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
71gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
72```
diff --git a/doc/Security.html b/doc/Security.html
index 914fa507..87a4ee4b 100644
--- a/doc/Security.html
+++ b/doc/Security.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Security</title> 7 <title>Shaarli Security</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -101,8 +128,8 @@ code > span.er { color: #ff0000; font-weight: bold; }
101<li>Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a <code>.php</code> file.</li> 128<li>Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a <code>.php</code> file.</li>
102<li>Even if the server does not support <code>.htaccess</code> files, the data file will still not be readable by URL.</li> 129<li>Even if the server does not support <code>.htaccess</code> files, the data file will still not be readable by URL.</li>
103<li><p>The database looks like this:</p> 130<li><p>The database looks like this:</p>
104<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">&lt;?php</span> <span class="co">/* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...</span> 131<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">&lt;?php</span> <span class="co">/* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...</span>
105<span class="co">...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */</span> <span class="kw">?&gt;</span></code></pre></li> 132<span class="co">...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */</span> <span class="kw">?&gt;</span></code></pre></div></li>
106<li><p>Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. <code>20110923_150523</code>) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only <code>A-Z a-z 0-9 - _</code> and <code>@</code>.</p></li> 133<li><p>Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. <code>20110923_150523</code>) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only <code>A-Z a-z 0-9 - _</code> and <code>@</code>.</p></li>
107</ul> 134</ul>
108</body> 135</body>
diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html
index 3aa89722..e1edf557 100644
--- a/doc/Server-configuration.html
+++ b/doc/Server-configuration.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Server configuration</title> 7 <title>Shaarli Server configuration</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -79,10 +106,10 @@ code > span.er { color: #ff0000; font-weight: bold; }
79<p><em>Example virtual host configurations for popular web servers</em></p> 106<p><em>Example virtual host configurations for popular web servers</em></p>
80<ul> 107<ul>
81<li><a href="#apache">Apache</a><a href=".html"></a></li> 108<li><a href="#apache">Apache</a><a href=".html"></a></li>
82<li><a href="#lighthttpd">LightHttpd</a> (empty)<a href=".html"></a></li>
83<li><a href="#nginx">Nginx</a><a href=".html"></a></li> 109<li><a href="#nginx">Nginx</a><a href=".html"></a></li>
84</ul> 110</ul>
85<h2 id="prerequisites">Prerequisites</h2> 111<h2 id="prerequisites">Prerequisites</h2>
112<h3 id="shaarli">Shaarli</h3>
86<ul> 113<ul>
87<li>Shaarli is installed in a directory readable/writeable by the user</li> 114<li>Shaarli is installed in a directory readable/writeable by the user</li>
88<li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li> 115<li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li>
@@ -90,25 +117,35 @@ code > span.er { color: #ff0000; font-weight: bold; }
90<li>a key pair (public, private) and a certificate have been generated</li> 117<li>a key pair (public, private) and a certificate have been generated</li>
91<li>the appropriate server SSL extension is installed and active</li> 118<li>the appropriate server SSL extension is installed and active</li>
92</ul> 119</ul>
120<h3 id="https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</h3>
93<p>Related guides:</p> 121<p>Related guides:</p>
94<ul> 122<ul>
95<li><a href="http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php">How to Create Self-Signed SSL Certificates with OpenSSL</a><a href=".html"></a></li> 123<li><a href="http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php">How to Create Self-Signed SSL Certificates with OpenSSL</a><a href=".html"></a></li>
96<li><a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a><a href=".html"></a></li> 124<li><a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a><a href=".html"></a></li>
125<li>Generate a self-signed certificate (will trigger browser warnings) with apache2: <code>make-ssl-cert generate-default-snakeoil --force-overwrite</code> will create <code>/etc/ssl/certs/ssl-cert-snakeoil.pem</code> and <code>/etc/ssl/private/ssl-cert-snakeoil.key</code></li>
126</ul>
127<h3 id="proxies">Proxies</h3>
128<p>If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:</p>
129<ul>
130<li><code>X-Forwarded-Proto</code>;</li>
131<li><code>X-Forwarded-Host</code>;</li>
132<li><code>X-Forwarded-For</code>.</li>
97</ul> 133</ul>
134<p>See also <a href="https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&amp;q=label%3Aproxy+">proxy-related</a> issues.<a href=".html"></a></p>
98<h2 id="apache">Apache</h2> 135<h2 id="apache">Apache</h2>
99<h3 id="minimal">Minimal</h3> 136<h3 id="minimal">Minimal</h3>
100<pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span> 137<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
101 ServerName<span class="st"> shaarli.my-domain.org</span> 138 ServerName<span class="st"> shaarli.my-domain.org</span>
102 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> 139 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
103<span class="fu">&lt;/VirtualHost&gt;</span></code></pre> 140<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
104<h3 id="debug---log-all-the-things">Debug - Log all the things!</h3> 141<h3 id="debug---log-all-the-things">Debug - Log all the things!</h3>
105<p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p> 142<p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p>
106<p>See:</p> 143<p>See:</p>
107<ul> 144<ul>
108<li><a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow)<a href=".html"></a></li> 145<li><a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow)<a href=".html"></a></li>
109<li><a href="PHP:%20php_value%20vs%20php_admin_value%20and%20the%20use%20of%20php_flag%20explained">PHP: php_value vs php_admin_value and the use of php_flag explained</a><a href=".html"></a></li> 146<li><a href="https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/">PHP: php_value vs php_admin_value and the use of php_flag explained</a><a href=".html"></a></li>
110</ul> 147</ul>
111<pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span> 148<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
112 ServerName<span class="st"> shaarli.my-domain.org</span> 149 ServerName<span class="st"> shaarli.my-domain.org</span>
113 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> 150 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
114 151
@@ -120,24 +157,24 @@ code > span.er { color: #ff0000; font-weight: bold; }
120 php_flag display_errors on 157 php_flag display_errors on
121 php_value error_reporting 2147483647 158 php_value error_reporting 2147483647
122 php_value error_log /var/log/apache2/shaarli-php-error.log 159 php_value error_log /var/log/apache2/shaarli-php-error.log
123<span class="fu">&lt;/VirtualHost&gt;</span></code></pre> 160<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
124<h3 id="standard---keep-access-and-error-logs">Standard - Keep access and error logs</h3> 161<h3 id="standard---keep-access-and-error-logs">Standard - Keep access and error logs</h3>
125<pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span> 162<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
126 ServerName<span class="st"> shaarli.my-domain.org</span> 163 ServerName<span class="st"> shaarli.my-domain.org</span>
127 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> 164 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
128 165
129 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> 166 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
130 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> 167 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
131 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> 168 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
132<span class="fu">&lt;/VirtualHost&gt;</span></code></pre> 169<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
133<h3 id="paranoid---redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3> 170<h3 id="paranoid---redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3>
134<p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).<a href=".html"></a></p> 171<p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).<a href=".html"></a></p>
135<pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:443</span><span class="fu">&gt;</span> 172<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:443</span><span class="fu">&gt;</span>
136 ServerName<span class="st"> shaarli.my-domain.org</span> 173 ServerName<span class="st"> shaarli.my-domain.org</span>
137 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span> 174 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
138 175
139 <span class="ot">SSLEngine</span><span class="ch"> </span><span class="kw">on</span> 176 <span class="ot">SSLEngine</span><span class="ch"> </span><span class="kw">on</span>
140 SSLCertificateFile<span class="st"> /absolute/path/to/the/website/certificate.crt</span> 177 SSLCertificateFile<span class="st"> /absolute/path/to/the/website/certificate.pem</span>
141 SSLCertificateKeyFile<span class="st"> /absolute/path/to/the/website/key.key</span> 178 SSLCertificateKeyFile<span class="st"> /absolute/path/to/the/website/key.key</span>
142 179
143 <span class="fu">&lt;Directory</span><span class="ot"> /absolute/path/to/shaarli/</span><span class="fu">&gt;</span> 180 <span class="fu">&lt;Directory</span><span class="ot"> /absolute/path/to/shaarli/</span><span class="fu">&gt;</span>
@@ -158,7 +195,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
158 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span> 195 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
159 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span> 196 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
160 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span> 197 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
161<span class="fu">&lt;/VirtualHost&gt;</span></code></pre> 198<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
162<h2 id="lighthttpd">LightHttpd</h2> 199<h2 id="lighthttpd">LightHttpd</h2>
163<h2 id="nginx">Nginx</h2> 200<h2 id="nginx">Nginx</h2>
164<h3 id="foreword">Foreword</h3> 201<h3 id="foreword">Foreword</h3>
@@ -204,13 +241,13 @@ code > span.er { color: #ff0000; font-weight: bold; }
204<li><code>user:group = john:users</code>,</li> 241<li><code>user:group = john:users</code>,</li>
205</ul> 242</ul>
206<p>which corresponds to the following service configuration:</p> 243<p>which corresponds to the following service configuration:</p>
207<pre class="sourceCode ini"><code class="sourceCode ini"><span class="co">; /etc/php/php-fpm.conf</span> 244<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co">; /etc/php/php-fpm.conf</span>
208<span class="dt">user </span><span class="ot">=</span><span class="st"> john</span> 245<span class="dt">user </span><span class="ot">=</span><span class="st"> john</span>
209<span class="dt">group </span><span class="ot">=</span><span class="st"> users</span> 246<span class="dt">group </span><span class="ot">=</span><span class="st"> users</span>
210 247
211<span class="kw">[...][]</span><span class="dt">(.html)</span> 248<span class="kw">[...][]</span><span class="dt">(.html)</span>
212<span class="dt">listen.owner </span><span class="ot">=</span><span class="st"> john</span> 249<span class="dt">listen.owner </span><span class="ot">=</span><span class="st"> john</span>
213<span class="dt">listen.group </span><span class="ot">=</span><span class="st"> users</span></code></pre> 250<span class="dt">listen.group </span><span class="ot">=</span><span class="st"> users</span></code></pre></div>
214<pre class="nginx"><code># /etc/nginx/nginx.conf 251<pre class="nginx"><code># /etc/nginx/nginx.conf
215user john users; 252user john users;
216 253
@@ -374,5 +411,10 @@ http {
374 include php.conf; 411 include php.conf;
375 } 412 }
376}</code></pre> 413}</code></pre>
414<h2 id="restricting-search-engines-and-web-crawler-traffic">Restricting search engines and web crawler traffic</h2>
415<p>Creating a <code>robots.txt</code> witht he following contents at the root of your Shaarli installation will prevent &quot;honest&quot; web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.</p>
416<pre><code>User-agent: *
417Disallow: /</code></pre>
418<p>See: <a href="http://www.robotstxt.org/" class="uri">http://www.robotstxt.org/</a>, <a href="http://www.robotstxt.org/robotstxt.html" class="uri">http://www.robotstxt.org/robotstxt.html</a>, <a href="http://www.robotstxt.org/meta.html" class="uri">http://www.robotstxt.org/meta.html</a></p>
377</body> 419</body>
378</html> 420</html>
diff --git a/doc/Server-configuration.md b/doc/Server-configuration.md
index c7b17c5a..fd98a608 100644
--- a/doc/Server-configuration.md
+++ b/doc/Server-configuration.md
@@ -2,19 +2,29 @@
2*Example virtual host configurations for popular web servers* 2*Example virtual host configurations for popular web servers*
3 3
4- [Apache](#apache)[](.html) 4- [Apache](#apache)[](.html)
5- [LightHttpd](#lighthttpd) (empty)[](.html)
6- [Nginx](#nginx)[](.html) 5- [Nginx](#nginx)[](.html)
7 6
8## Prerequisites 7## Prerequisites
8### Shaarli
9* Shaarli is installed in a directory readable/writeable by the user 9* Shaarli is installed in a directory readable/writeable by the user
10* the correct read/write permissions have been granted to the web server _user and/or group_ 10* the correct read/write permissions have been granted to the web server _user and/or group_
11* for HTTPS / SSL: 11* for HTTPS / SSL:
12 * a key pair (public, private) and a certificate have been generated 12 * a key pair (public, private) and a certificate have been generated
13 * the appropriate server SSL extension is installed and active 13 * the appropriate server SSL extension is installed and active
14 14
15### HTTPS, TLS and self-signed certificates
15Related guides: 16Related guides:
16* [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php)[](.html) 17* [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php)[](.html)
17* [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority)[](.html) 18* [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority)[](.html)
19* Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key`
20
21### Proxies
22If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:
23- `X-Forwarded-Proto`;
24- `X-Forwarded-Host`;
25- `X-Forwarded-For`.
26
27See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.[](.html)
18 28
19## Apache 29## Apache
20### Minimal 30### Minimal
@@ -29,7 +39,7 @@ This configuration will log both Apache and PHP errors, which may prove useful t
29 39
30See: 40See:
31* [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow)[](.html) 41* [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow)[](.html)
32* [PHP: php_value vs php_admin_value and the use of php_flag explained](PHP: php_value vs php_admin_value and the use of php_flag explained)[](.html) 42* [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/)[](.html)
33 43
34```apache 44```apache
35<VirtualHost *:80> 45<VirtualHost *:80>
@@ -68,7 +78,7 @@ See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache)
68 DocumentRoot /absolute/path/to/shaarli/ 78 DocumentRoot /absolute/path/to/shaarli/
69 79
70 SSLEngine on 80 SSLEngine on
71 SSLCertificateFile /absolute/path/to/the/website/certificate.crt 81 SSLCertificateFile /absolute/path/to/the/website/certificate.pem
72 SSLCertificateKeyFile /absolute/path/to/the/website/key.key 82 SSLCertificateKeyFile /absolute/path/to/the/website/key.key
73 83
74 <Directory /absolute/path/to/shaarli/> 84 <Directory /absolute/path/to/shaarli/>
@@ -324,3 +334,15 @@ http {
324 } 334 }
325} 335}
326``` 336```
337
338## Restricting search engines and web crawler traffic
339
340Creating a `robots.txt` witht he following contents at the root of your Shaarli installation will prevent "honest" web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.
341
342```
343User-agent: *
344Disallow: /
345```
346
347See: http://www.robotstxt.org/, http://www.robotstxt.org/robotstxt.html, http://www.robotstxt.org/meta.html
348
diff --git a/doc/Server-requirements.html b/doc/Server-requirements.html
index f34f589b..ff0ad9cd 100644
--- a/doc/Server-requirements.html
+++ b/doc/Server-requirements.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Server requirements</title> 7 <title>Shaarli Server requirements</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -62,6 +71,7 @@
62<ul> 71<ul>
63<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a><a href=".html"></a></li> 72<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a><a href=".html"></a></li>
64<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em><a href=".html"></a></li> 73<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em><a href=".html"></a></li>
74<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a><a href=".html"></a></li>
65<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a><a href=".html"></a></li> 75<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a><a href=".html"></a></li>
66<li><a href="https://bugs.php.net/">PHP: Bugs</a><a href=".html"></a></li> 76<li><a href="https://bugs.php.net/">PHP: Bugs</a><a href=".html"></a></li>
67</ul> 77</ul>
@@ -76,29 +86,29 @@
76</thead> 86</thead>
77<tbody> 87<tbody>
78<tr class="odd"> 88<tr class="odd">
79<td style="text-align: center;">7</td> 89<td style="text-align: center;">7.0</td>
80<td style="text-align: center;">RC2</td> 90<td style="text-align: center;">Supported</td>
81<td style="text-align: center;">planned</td> 91<td style="text-align: center;"></td>
82</tr> 92</tr>
83<tr class="even"> 93<tr class="even">
84<td style="text-align: center;">5.6</td> 94<td style="text-align: center;">5.6</td>
85<td style="text-align: center;">Supported</td> 95<td style="text-align: center;">Supported</td>
86<td style="text-align: center;">:white_check_mark:</td> 96<td style="text-align: center;"></td>
87</tr> 97</tr>
88<tr class="odd"> 98<tr class="odd">
89<td style="text-align: center;">5.5</td> 99<td style="text-align: center;">5.5</td>
90<td style="text-align: center;">Supported</td> 100<td style="text-align: center;">Supported</td>
91<td style="text-align: center;">:white_check_mark:</td> 101<td style="text-align: center;"></td>
92</tr> 102</tr>
93<tr class="even"> 103<tr class="even">
94<td style="text-align: center;">5.4</td> 104<td style="text-align: center;">5.4</td>
95<td style="text-align: center;">EOL: 2015-09-14</td> 105<td style="text-align: center;">EOL: 2015-09-14</td>
96<td style="text-align: center;">:white_check_mark:</td> 106<td style="text-align: center;"></td>
97</tr> 107</tr>
98<tr class="odd"> 108<tr class="odd">
99<td style="text-align: center;">5.3</td> 109<td style="text-align: center;">5.3</td>
100<td style="text-align: center;">EOL: 2014-08-14</td> 110<td style="text-align: center;">EOL: 2014-08-14</td>
101<td style="text-align: center;">:white_check_mark:</td> 111<td style="text-align: center;"></td>
102</tr> 112</tr>
103</tbody> 113</tbody>
104</table> 114</table>
@@ -106,32 +116,40 @@
106<ul> 116<ul>
107<li><a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a><a href=".html"></a></li> 117<li><a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a><a href=".html"></a></li>
108</ul> 118</ul>
109<p>PHP 7 information:</p>
110<ul>
111<li>Announcements: <a href="http://php.net/archive/2015.php#id2015-07-10-4">Beta1</a>, <a href="http://php.net/archive/2015.php#id2015-08-21-1">RC1</a>, <a href="http://php.net/archive/2015.php#id2015-09-04-1">RC2</a><a href=".html"></a></li>
112<li><a href="https://wiki.php.net/todo/php70">TODOLIST</a><a href=".html"></a></li>
113<li><a href="https://bugs.php.net/search.php?limit=30&amp;order_by=id&amp;direction=DESC&amp;cmd=display&amp;status=Open&amp;bug_type=All&amp;phpver=7.0">Recent bugs</a><a href=".html"></a></li>
114<li><a href="http://git.php.net/?p=php-src.git;a=shortlog;h=refs/heads/PHP-7.0.0">Git repository</a><a href=".html"></a></li>
115</ul>
116<h3 id="extensions">Extensions</h3> 119<h3 id="extensions">Extensions</h3>
117<table> 120<table style="width:19%;">
121<colgroup>
122<col style="width: 5%" />
123<col style="width: 8%" />
124<col style="width: 5%" />
125</colgroup>
118<thead> 126<thead>
119<tr class="header"> 127<tr class="header">
120<th style="text-align: left;">Extension</th> 128<th>Extension</th>
121<th style="text-align: center;">Required?</th> 129<th style="text-align: center;">Required?</th>
122<th style="text-align: left;">Usage</th> 130<th>Usage</th>
123</tr> 131</tr>
124</thead> 132</thead>
125<tbody> 133<tbody>
126<tr class="odd"> 134<tr class="odd">
127<td style="text-align: left;"><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td> 135<td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
128<td style="text-align: center;">CentOS, Fedora, RHEL, Windows</td> 136<td style="text-align: center;">All</td>
129<td style="text-align: left;">multibyte (Unicode) string support<a href=".html"></a></td> 137<td>OpenSSL, HTTPS<a href=".html"></a></td>
130</tr> 138</tr>
131<tr class="even"> 139<tr class="even">
132<td style="text-align: left;"><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td> 140<td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
141<td style="text-align: center;">CentOS, Fedora, RHEL, Windows</td>
142<td>multibyte (Unicode) string support<a href=".html"></a></td>
143</tr>
144<tr class="odd">
145<td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
133<td style="text-align: center;">-</td> 146<td style="text-align: center;">-</td>
134<td style="text-align: left;">thumbnail resizing<a href=".html"></a></td> 147<td>thumbnail resizing<a href=".html"></a></td>
148</tr>
149<tr class="even">
150<td><a href="http://php.net/manual/fr/book.intl.php"><code>php-intl</code></a></td>
151<td style="text-align: center;">Optional</td>
152<td>Tag cloud intelligent sorting (eg. <code>e-&gt;è-&gt;f</code>)<a href=".html"></a></td>
135</tr> 153</tr>
136</tbody> 154</tbody>
137</table> 155</table>
diff --git a/doc/Server-requirements.md b/doc/Server-requirements.md
index 8f44d606..7955fddf 100644
--- a/doc/Server-requirements.md
+++ b/doc/Server-requirements.md
@@ -3,13 +3,14 @@
3### Release information 3### Release information
4- [PHP: Supported versions](http://php.net/supported-versions.php)[](.html) 4- [PHP: Supported versions](http://php.net/supported-versions.php)[](.html)
5- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_[](.html) 5- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_[](.html)
6- [PHP 7 Changelog](http://php.net/ChangeLog-7.php)[](.html)
6- [PHP 5 Changelog](http://php.net/ChangeLog-5.php)[](.html) 7- [PHP 5 Changelog](http://php.net/ChangeLog-5.php)[](.html)
7- [PHP: Bugs](https://bugs.php.net/)[](.html) 8- [PHP: Bugs](https://bugs.php.net/)[](.html)
8 9
9### Supported versions 10### Supported versions
10Version | Status | Shaarli compatibility 11Version | Status | Shaarli compatibility
11:---:|:---:|:---: 12:---:|:---:|:---:
127 | RC2 | planned 137.0 | Supported | :white_check_mark:
135.6 | Supported | :white_check_mark: 145.6 | Supported | :white_check_mark:
145.5 | Supported | :white_check_mark: 155.5 | Supported | :white_check_mark:
155.4 | EOL: 2015-09-14 | :white_check_mark: 165.4 | EOL: 2015-09-14 | :white_check_mark:
@@ -18,14 +19,10 @@ Version | Status | Shaarli compatibility
18See also: 19See also:
19- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)[](.html) 20- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)[](.html)
20 21
21PHP 7 information:
22- Announcements: [Beta1](http://php.net/archive/2015.php#id2015-07-10-4), [RC1](http://php.net/archive/2015.php#id2015-08-21-1), [RC2](http://php.net/archive/2015.php#id2015-09-04-1)[](.html)
23- [TODOLIST](https://wiki.php.net/todo/php70)[](.html)
24- [Recent bugs](https://bugs.php.net/search.php?limit=30&order_by=id&direction=DESC&cmd=display&status=Open&bug_type=All&phpver=7.0)[](.html)
25- [Git repository](http://git.php.net/?p=php-src.git;a=shortlog;h=refs/heads/PHP-7.0.0)[](.html)
26
27### Extensions 22### Extensions
28Extension | Required? | Usage 23Extension | Required? | Usage
29---|:---:|--- 24---|:---:|---
25[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS[](.html)
30[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support[](.html) 26[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support[](.html)
31[`php-gd`](http://php.net/manual/en/book.image.php) | - | thumbnail resizing[](.html) 27[`php-gd`](http://php.net/manual/en/book.image.php) | - | thumbnail resizing[](.html)
28[`php-intl`](http://php.net/manual/fr/book.intl.php) | Optional | Tag cloud intelligent sorting (eg. `e->è->f`)[](.html)
diff --git a/doc/Server-security.html b/doc/Server-security.html
new file mode 100644
index 00000000..97f93780
--- /dev/null
+++ b/doc/Server-security.html
@@ -0,0 +1,166 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Server security</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="server-security">Server security</h1>
106<h2 id="php.ini">php.ini</h2>
107<p>PHP settings are defined in:</p>
108<ul>
109<li>a main configuration file, usually found under <code>/etc/php5/php.ini</code>; some distributions provide different configuration environments, e.g.
110<ul>
111<li><code>/etc/php5/php.ini</code> - used when running console scripts</li>
112<li><code>/etc/php5/apache2/php.ini</code> - used when a client requests PHP resources from Apache</li>
113<li><code>/etc/php5/php-fpm.conf</code> - used when PHP requests are proxied to PHP-FPM</li>
114</ul></li>
115<li>additional configuration files/entries, depending on the installed/enabled extensions:
116<ul>
117<li><code>/etc/php/conf.d/xdebug.ini</code></li>
118</ul></li>
119</ul>
120<h3 id="locate-.ini-files">Locate .ini files</h3>
121<h4 id="console-environment">Console environment</h4>
122<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">php</span> --ini
123<span class="kw">Configuration</span> File (php.ini) <span class="kw">Path</span>: /etc/php
124<span class="kw">Loaded</span> Configuration File: /etc/php/php.ini
125<span class="kw">Scan</span> for additional .ini files in: /etc/php/conf.d
126<span class="kw">Additional</span> .ini files parsed: /etc/php/conf.d/xdebug.ini</code></pre></div>
127<h4 id="server-environment">Server environment</h4>
128<ul>
129<li>create a <code>phpinfo.php</code> script located in a path supported by the web server, e.g.
130<ul>
131<li>Apache (with user dirs enabled): <code>/home/myself/public_html/phpinfo.php</code></li>
132<li><code>/var/www/test/phpinfo.php</code></li>
133</ul></li>
134<li>make sure the script is readable by the web server user/group (usually, <code>www</code>, <code>www-data</code> or <code>httpd</code>)</li>
135<li>access the script from a web browser</li>
136<li><p>look at the <em>Loaded Configuration File</em> and <em>Scan this dir for additional .ini files</em> entries</p>
137<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">&lt;?php</span> <span class="fu">phpinfo</span><span class="ot">();</span> <span class="kw">?&gt;</span></code></pre></div></li>
138</ul>
139<h2 id="fail2ban">fail2ban</h2>
140<p><code>fail2ban</code> is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses <code>iptables</code> profiles to block brute-force attempts:</p>
141<ul>
142<li><a href="http://www.fail2ban.org/wiki/index.php/Main_Page">Official website</a><a href=".html"></a></li>
143<li><a href="https://github.com/fail2ban/fail2ban">Source code</a><a href=".html"></a></li>
144</ul>
145<h3 id="read-shaarli-logs-to-ban-ips">Read Shaarli logs to ban IPs</h3>
146<p>Example configuration:</p>
147<ul>
148<li>allow 3 login attempts per IP address</li>
149<li>after 3 failures, permanently ban the corresponding IP adddress</li>
150</ul>
151<p><code>/etc/fail2ban/jail.local</code></p>
152<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="kw">[shaarli-auth][]</span><span class="dt">(.html)</span>
153<span class="dt">enabled </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span>
154<span class="dt">port </span><span class="ot">=</span><span class="st"> https,http</span>
155<span class="dt">filter </span><span class="ot">=</span><span class="st"> shaarli-auth</span>
156<span class="dt">logpath </span><span class="ot">=</span><span class="st"> /var/www/path/to/shaarli/data/log.txt</span>
157<span class="dt">maxretry </span><span class="ot">=</span><span class="st"> </span><span class="dv">3</span>
158<span class="dt">bantime </span><span class="ot">=</span><span class="st"> -</span><span class="dv">1</span></code></pre></div>
159<p><code>/etc/fail2ban/filter.d/shaarli-auth.conf</code></p>
160<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="kw">[INCLUDES][]</span><span class="dt">(.html)</span>
161<span class="dt">before </span><span class="ot">=</span><span class="st"> common.conf</span>
162<span class="kw">[Definition][]</span><span class="dt">(.html)</span>
163<span class="dt">failregex </span><span class="ot">=</span><span class="st"> \s-\s&lt;HOST&gt;\s-\sLogin failed for user.*$</span>
164<span class="dt">ignoreregex </span><span class="ot">=</span><span class="st"> </span></code></pre></div>
165</body>
166</html>
diff --git a/doc/Server-security.md b/doc/Server-security.md
new file mode 100644
index 00000000..0d16e284
--- /dev/null
+++ b/doc/Server-security.md
@@ -0,0 +1,60 @@
1#Server security
2## php.ini
3PHP settings are defined in:
4- a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g.
5 - `/etc/php5/php.ini` - used when running console scripts
6 - `/etc/php5/apache2/php.ini` - used when a client requests PHP resources from Apache
7 - `/etc/php5/php-fpm.conf` - used when PHP requests are proxied to PHP-FPM
8- additional configuration files/entries, depending on the installed/enabled extensions:
9 - `/etc/php/conf.d/xdebug.ini`
10
11### Locate .ini files
12#### Console environment
13```bash
14$ php --ini
15Configuration File (php.ini) Path: /etc/php
16Loaded Configuration File: /etc/php/php.ini
17Scan for additional .ini files in: /etc/php/conf.d
18Additional .ini files parsed: /etc/php/conf.d/xdebug.ini
19```
20
21#### Server environment
22- create a `phpinfo.php` script located in a path supported by the web server, e.g.
23 - Apache (with user dirs enabled): `/home/myself/public_html/phpinfo.php`
24 - `/var/www/test/phpinfo.php`
25- make sure the script is readable by the web server user/group (usually, `www`, `www-data` or `httpd`)
26- access the script from a web browser
27- look at the _Loaded Configuration File_ and _Scan this dir for additional .ini files_ entries
28```php
29<?php phpinfo(); ?>
30```
31
32## fail2ban
33`fail2ban` is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses `iptables` profiles to block brute-force attempts:
34- [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page)[](.html)
35- [Source code](https://github.com/fail2ban/fail2ban)[](.html)
36
37### Read Shaarli logs to ban IPs
38Example configuration:
39- allow 3 login attempts per IP address
40- after 3 failures, permanently ban the corresponding IP adddress
41
42`/etc/fail2ban/jail.local`
43```ini
44[shaarli-auth][](.html)
45enabled = true
46port = https,http
47filter = shaarli-auth
48logpath = /var/www/path/to/shaarli/data/log.txt
49maxretry = 3
50bantime = -1
51```
52
53`/etc/fail2ban/filter.d/shaarli-auth.conf`
54```ini
55[INCLUDES][](.html)
56before = common.conf
57[Definition][](.html)
58failregex = \s-\s<HOST>\s-\sLogin failed for user.*$
59ignoreregex =
60```
diff --git a/doc/Shaarli-configuration.html b/doc/Shaarli-configuration.html
index b7e29cb3..f53289fe 100644
--- a/doc/Shaarli-configuration.html
+++ b/doc/Shaarli-configuration.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Shaarli configuration</title> 7 <title>Shaarli Shaarli configuration</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -81,6 +108,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
81<p>Once your Shaarli instance is installed, the file <code>data/config.php</code> is generated:</p> 108<p>Once your Shaarli instance is installed, the file <code>data/config.php</code> is generated:</p>
82<ul> 109<ul>
83<li>it contains all settings, and can be edited to customize values</li> 110<li>it contains all settings, and can be edited to customize values</li>
111<li>it defines which <a href="Plugin-System">plugins</a> are enabled<a href=".html"></a></li>
84<li>its values override those defined in <code>index.php</code></li> 112<li>its values override those defined in <code>index.php</code></li>
85</ul> 113</ul>
86<h2 id="file-and-directory-permissions">File and directory permissions</h2> 114<h2 id="file-and-directory-permissions">File and directory permissions</h2>
@@ -88,14 +116,14 @@ code > span.er { color: #ff0000; font-weight: bold; }
88<ul> 116<ul>
89<li><code>read</code> access to the following resources: 117<li><code>read</code> access to the following resources:
90<ul> 118<ul>
91<li>PHP scripts: <code>index.php</code>, <code>application/*.php</code></li> 119<li>PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code></li>
92<li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc\*.js</code></li> 120<li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code></li>
93<li>static assets: 121<li>static assets:
94<ul> 122<ul>
95<li>CSS stylesheets: <code>inc\*.css</code></li> 123<li>CSS stylesheets: <code>inc/*.css</code></li>
96<li><code>images\*</code></li> 124<li><code>images/*</code></li>
97</ul></li> 125</ul></li>
98<li>RainTPL templates: <code>tpl\*.html</code></li> 126<li>RainTPL templates: <code>tpl/*.html</code></li>
99</ul></li> 127</ul></li>
100<li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories: 128<li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories:
101<ul> 129<ul>
@@ -117,7 +145,8 @@ code > span.er { color: #ff0000; font-weight: bold; }
117<li>if you have a domain / subdomain to serve Shaarli, <a href="Server-configuration">configure the server</a> accordingly<a href=".html"></a></li> 145<li>if you have a domain / subdomain to serve Shaarli, <a href="Server-configuration">configure the server</a> accordingly<a href=".html"></a></li>
118</ul> 146</ul>
119<h2 id="example-dataconfig.php">Example <code>data/config.php</code></h2> 147<h2 id="example-dataconfig.php">Example <code>data/config.php</code></h2>
120<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">&lt;?php</span> 148<p>See also <a href="Plugin-System.html">Plugin System</a>.</p>
149<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">&lt;?php</span>
121<span class="co">// User login</span> 150<span class="co">// User login</span>
122<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;login&#39;</span><span class="ot">]</span> = <span class="st">&#39;&lt;login&gt;&#39;</span><span class="ot">;[](</span>.html<span class="ot">)</span> 151<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;login&#39;</span><span class="ot">]</span> = <span class="st">&#39;&lt;login&gt;&#39;</span><span class="ot">;[](</span>.html<span class="ot">)</span>
123 152
@@ -146,6 +175,10 @@ code > span.er { color: #ff0000; font-weight: bold; }
146<span class="co">// Whether new links are private by default</span> 175<span class="co">// Whether new links are private by default</span>
147<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;privateLinkByDefault&#39;</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;[](</span>.html<span class="ot">)</span> 176<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;privateLinkByDefault&#39;</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;[](</span>.html<span class="ot">)</span>
148 177
178<span class="co">// Enabled plugins</span>
179<span class="co">// Note: each plugin may provide further settings through its own &quot;config.php&quot;</span>
180<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(</span><span class="st">&#39;addlink_toolbar&#39;</span><span class="ot">,</span> <span class="st">&#39;qrcode&#39;</span><span class="ot">);](</span><span class="st">&#39;ENABLED_PLUGINS&#39;</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span><span class="st">&#39;addlink_toolbar&#39;</span><span class="ot">,</span>-<span class="st">&#39;qrcode&#39;</span><span class="ot">);</span>.html<span class="ot">)</span>
181
149<span class="co">// Subdirectory where Shaarli stores its data files.</span> 182<span class="co">// Subdirectory where Shaarli stores its data files.</span>
150<span class="co">// You can change it for better security.</span> 183<span class="co">// You can change it for better security.</span>
151<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;DATADIR&#39;</span><span class="ot">]</span> = <span class="st">&#39;data&#39;</span><span class="ot">;](</span><span class="st">&#39;DATADIR&#39;</span><span class="ot">]</span>-=-<span class="st">&#39;data&#39;</span><span class="ot">;</span>.html<span class="ot">)</span> 184<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;DATADIR&#39;</span><span class="ot">]</span> = <span class="st">&#39;data&#39;</span><span class="ot">;](</span><span class="st">&#39;DATADIR&#39;</span><span class="ot">]</span>-=-<span class="st">&#39;data&#39;</span><span class="ot">;</span>.html<span class="ot">)</span>
@@ -218,6 +251,11 @@ code > span.er { color: #ff0000; font-weight: bold; }
218<span class="co">// Show an ATOM Feed button next to the Subscribe (RSS) button.</span> 251<span class="co">// Show an ATOM Feed button next to the Subscribe (RSS) button.</span>
219<span class="co">// ATOM feeds are available at the address ?do=atom regardless of this option.</span> 252<span class="co">// ATOM feeds are available at the address ?do=atom regardless of this option.</span>
220<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;SHOW_ATOM&#39;</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">&#39;SHOW_ATOM&#39;</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> 253<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;SHOW_ATOM&#39;</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">&#39;SHOW_ATOM&#39;</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span>
221<span class="kw">?&gt;</span></code></pre> 254
255<span class="co">// Set this to true if the redirector requires encoded URL, false otherwise.</span>
256<span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;REDIRECTOR_URLENCODE&#39;</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">&#39;REDIRECTOR_URLENCODE&#39;</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span>
257<span class="kw">?&gt;</span></code></pre></div>
258<h2 id="additional-configuration">Additional configuration</h2>
259<p>The playvideos plugin may require that you adapt your server's <a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting">Content Security Policy</a> configuration to work properly.<a href=".html"></a></p>
222</body> 260</body>
223</html> 261</html>
diff --git a/doc/Shaarli-configuration.md b/doc/Shaarli-configuration.md
index 5bf70a62..d0560d79 100644
--- a/doc/Shaarli-configuration.md
+++ b/doc/Shaarli-configuration.md
@@ -5,17 +5,18 @@
5 5
6Once your Shaarli instance is installed, the file `data/config.php` is generated: 6Once your Shaarli instance is installed, the file `data/config.php` is generated:
7* it contains all settings, and can be edited to customize values 7* it contains all settings, and can be edited to customize values
8* it defines which [plugins](Plugin-System) are enabled[](.html)
8* its values override those defined in `index.php` 9* its values override those defined in `index.php`
9 10
10## File and directory permissions 11## File and directory permissions
11The server process running Shaarli must have: 12The server process running Shaarli must have:
12- `read` access to the following resources: 13- `read` access to the following resources:
13 - PHP scripts: `index.php`, `application/*.php` 14 - PHP scripts: `index.php`, `application/*.php`, `plugins/*.php`
14 - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc\*.js` 15 - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc/*.js`
15 - static assets: 16 - static assets:
16 - CSS stylesheets: `inc\*.css` 17 - CSS stylesheets: `inc/*.css`
17 - `images\*` 18 - `images/*`
18 - RainTPL templates: `tpl\*.html` 19 - RainTPL templates: `tpl/*.html`
19- `read`, `write` and `execution` access to the following directories: 20- `read`, `write` and `execution` access to the following directories:
20 - `cache` - thumbnail cache 21 - `cache` - thumbnail cache
21 - `data` - link data store, configuration options 22 - `data` - link data store, configuration options
@@ -31,6 +32,8 @@ On a Linux distribution:
31- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) 32- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html)
32 33
33## Example `data/config.php` 34## Example `data/config.php`
35See also [Plugin System](Plugin-System.html).
36
34```php 37```php
35<?php 38<?php
36// User login 39// User login
@@ -61,6 +64,10 @@ $GLOBALS['disablesessionprotection'] = false; [](.html)
61// Whether new links are private by default 64// Whether new links are private by default
62$GLOBALS['privateLinkByDefault'] = false;[](.html) 65$GLOBALS['privateLinkByDefault'] = false;[](.html)
63 66
67// Enabled plugins
68// Note: each plugin may provide further settings through its own "config.php"
69$GLOBALS['config'['ENABLED_PLUGINS'] = array('addlink_toolbar', 'qrcode');]('ENABLED_PLUGINS']-=-array('addlink_toolbar',-'qrcode');.html)
70
64// Subdirectory where Shaarli stores its data files. 71// Subdirectory where Shaarli stores its data files.
65// You can change it for better security. 72// You can change it for better security.
66$GLOBALS['config'['DATADIR'] = 'data';]('DATADIR']-=-'data';.html) 73$GLOBALS['config'['DATADIR'] = 'data';]('DATADIR']-=-'data';.html)
@@ -133,5 +140,12 @@ $GLOBALS['config'['PUBSUBHUB_URL'] = '';]('PUBSUBHUB_URL']-=-'';.html)
133// Show an ATOM Feed button next to the Subscribe (RSS) button. 140// Show an ATOM Feed button next to the Subscribe (RSS) button.
134// ATOM feeds are available at the address ?do=atom regardless of this option. 141// ATOM feeds are available at the address ?do=atom regardless of this option.
135$GLOBALS['config'['SHOW_ATOM'] = false;]('SHOW_ATOM']-=-false;.html) 142$GLOBALS['config'['SHOW_ATOM'] = false;]('SHOW_ATOM']-=-false;.html)
143
144// Set this to true if the redirector requires encoded URL, false otherwise.
145$GLOBALS['config'['REDIRECTOR_URLENCODE'] = true;]('REDIRECTOR_URLENCODE']-=-true;.html)
136?> 146?>
137``` 147```
148
149## Additional configuration
150
151The playvideos plugin may require that you adapt your server's [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) configuration to work properly.[](.html)
diff --git a/doc/Shaarli-installation.html b/doc/Shaarli-installation.html
new file mode 100644
index 00000000..ae40b3a3
--- /dev/null
+++ b/doc/Shaarli-installation.html
@@ -0,0 +1,73 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Shaarli installation</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Installation
19<ul>
20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
30<li><a href="Usage.html">Usage</a>
31<ul>
32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
34<li><a href="Firefox-share.html">Firefox share</a></li>
35<li><a href="RSS-feeds.html">RSS feeds</a></li>
36</ul></li>
37<li>How To
38<ul>
39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
45</ul></li>
46<li><a href="Troubleshooting.html">Troubleshooting</a></li>
47<li><a href="Development.html">Development</a>
48<ul>
49<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
50<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
51<li><a href="Directory-structure.html">Directory structure</a></li>
52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
55<li><a href="Security.html">Security</a></li>
56<li><a href="Static-analysis.html">Static analysis</a></li>
57<li><a href="Theming.html">Theming</a></li>
58<li><a href="Unit-tests.html">Unit tests</a></li>
59</ul></li>
60<li>About
61<ul>
62<li><a href="FAQ.html">FAQ</a></li>
63<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
64<li><a href="TODO.html">TODO</a></li>
65</ul></li>
66</ul>
67</div>
68<h1 id="shaarli-installation">Shaarli installation</h1>
69<p>Once Shaarli is downloaded and installed behind a web server, open it in your favorite browser.</p>
70<p><img src="http://i.imgur.com/wuMpDSN.png" alt="install screenshot" /><a href=".html"></a></p>
71<p>Setup your Shaarli installation, and it's ready to use!</p>
72</body>
73</html>
diff --git a/doc/Shaarli-installation.md b/doc/Shaarli-installation.md
new file mode 100644
index 00000000..be9726e0
--- /dev/null
+++ b/doc/Shaarli-installation.md
@@ -0,0 +1,6 @@
1#Shaarli installation
2Once Shaarli is downloaded and installed behind a web server, open it in your favorite browser.
3
4![install screenshot](http://i.imgur.com/wuMpDSN.png)[](.html)
5
6Setup your Shaarli installation, and it's ready to use!
diff --git a/doc/Sharing-button.html b/doc/Sharing-button.html
index 6fa5e77a..6dfdd564 100644
--- a/doc/Sharing-button.html
+++ b/doc/Sharing-button.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Sharing button</title> 7 <title>Shaarli Sharing button</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -74,5 +83,13 @@
74<li>You can also check the “Private” box so that the link is saved but only visible to you.</li> 83<li>You can also check the “Private” box so that the link is saved but only visible to you.</li>
75<li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li> 84<li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li>
76</ul> 85</ul>
86<h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-e.g.-github.com">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3>
87<p>Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.</p>
88<p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.<a href=".html"></a></p>
89<p>There is an open bug for both Firefox and Chromium:</p>
90<ul>
91<li><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=866522" class="uri">https://bugzilla.mozilla.org/show_bug.cgi?id=866522</a></li>
92<li><a href="https://code.google.com/p/chromium/issues/detail?id=233903" class="uri">https://code.google.com/p/chromium/issues/detail?id=233903</a></li>
93</ul>
77</body> 94</body>
78</html> 95</html>
diff --git a/doc/Sharing-button.md b/doc/Sharing-button.md
index fe576a77..e4388863 100644
--- a/doc/Sharing-button.md
+++ b/doc/Sharing-button.md
@@ -17,3 +17,15 @@ _This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. U
17 * You will be able to edit this link later using the ![(https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button.]((https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png)-edit-button..html) 17 * You will be able to edit this link later using the ![(https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button.]((https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png)-edit-button..html)
18 * You can also check the “Private” box so that the link is saved but only visible to you. 18 * You can also check the “Private” box so that the link is saved but only visible to you.
19 * Click `Save`.**Voilà! Your link is now shared.** 19 * Click `Save`.**Voilà! Your link is now shared.**
20
21### Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)
22
23Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.
24
25See [#196](https://github.com/shaarli/Shaarli#196).[](.html)
26
27There is an open bug for both Firefox and Chromium:
28
29 * https://bugzilla.mozilla.org/show_bug.cgi?id=866522
30 * https://code.google.com/p/chromium/issues/detail?id=233903
31
diff --git a/doc/Static-analysis.html b/doc/Static-analysis.html
index e95893a8..6d1695cb 100644
--- a/doc/Static-analysis.html
+++ b/doc/Static-analysis.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Static analysis</title> 7 <title>Shaarli Static analysis</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/TODO.html b/doc/TODO.html
index 7a6a4bf6..e7ce4f04 100644
--- a/doc/TODO.html
+++ b/doc/TODO.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - TODO</title> 7 <title>Shaarli TODO</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/Theming.html b/doc/Theming.html
index a751eb98..1eda52e4 100644
--- a/doc/Theming.html
+++ b/doc/Theming.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Theming</title> 7 <title>Shaarli Theming</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -89,14 +116,14 @@ code > span.er { color: #ff0000; font-weight: bold; }
89<h2 id="raintpl-template">RainTPL template</h2> 116<h2 id="raintpl-template">RainTPL template</h2>
90<p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p> 117<p><em>WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.</em></p>
91<ul> 118<ul>
92<li>Find the template you'd like to install (see the list of <a href="available-templates|Theming#community-themes--templates.html">available templates|Theming#community-themes--templates</a>)</li> 119<li>Find the template you'd like to install (see the list of <a href="available-templates%7CTheming#community-themes--templates.html">available templates|Theming#community-themes--templates</a>)</li>
93<li>Find it's git clone URL or download the zip archive for the template.</li> 120<li>Find it's git clone URL or download the zip archive for the template.</li>
94<li>In your Shaarli <code>tpl/</code> directory, run <code>git clone https://url/of/my-template/</code> or unpack the zip archive. 121<li>In your Shaarli <code>tpl/</code> directory, run <code>git clone https://url/of/my-template/</code> or unpack the zip archive.
95<ul> 122<ul>
96<li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li> 123<li>There should now be a <code>my-template/</code> directory under the <code>tpl/</code> dir, containing directly all the template files.</li>
97</ul></li> 124</ul></li>
98<li><p>Edit <code>data/config.php</code> to have Shaarli use this template, e.g.</p> 125<li><p>Edit <code>data/config.php</code> to have Shaarli use this template, e.g.</p>
99<pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;RAINTPL_TPL&#39;</span><span class="ot">]</span> = <span class="st">&#39;tpl/my-template/&#39;</span><span class="ot">;](</span><span class="st">&#39;RAINTPL_TPL&#39;</span><span class="ot">]</span>-=-<span class="st">&#39;tpl/my-template/&#39;</span><span class="ot">;</span>.html<span class="ot">)</span></code></pre></li> 126<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">&#39;config&#39;</span><span class="ot">[</span><span class="st">&#39;RAINTPL_TPL&#39;</span><span class="ot">]</span> = <span class="st">&#39;tpl/my-template/&#39;</span><span class="ot">;](</span><span class="st">&#39;RAINTPL_TPL&#39;</span><span class="ot">]</span>-=-<span class="st">&#39;tpl/my-template/&#39;</span><span class="ot">;</span>.html<span class="ot">)</span></code></pre></div></li>
100</ul> 127</ul>
101<h2 id="community-themes-templates">Community themes &amp; templates</h2> 128<h2 id="community-themes-templates">Community themes &amp; templates</h2>
102<ul> 129<ul>
@@ -116,7 +143,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
116<li>user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code></li> 143<li>user sites are enabled, e.g. <code>/home/user/public_html/somedir</code> is served as <code>http://localhost/~user/somedir</code></li>
117<li><code>http</code> is the name of the Apache user</li> 144<li><code>http</code> is the name of the Apache user</li>
118</ul> 145</ul>
119<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> ~/public_html 146<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> ~/public_html
120 147
121<span class="co"># clone repositories</span> 148<span class="co"># clone repositories</span>
122$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli 149$ <span class="kw">git</span> clone https://github.com/shaarli/Shaarli.git shaarli
@@ -126,15 +153,15 @@ $ <span class="kw">popd</span>
126 153
127<span class="co"># set access rights for Apache</span> 154<span class="co"># set access rights for Apache</span>
128$ <span class="kw">chgrp</span> -R http shaarli 155$ <span class="kw">chgrp</span> -R http shaarli
129$ <span class="kw">chmod</span> g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp</code></pre> 156$ <span class="kw">chmod</span> g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp</code></pre></div>
130<p>Get config written:</p> 157<p>Get config written:</p>
131<ul> 158<ul>
132<li>go to the freshly installed site</li> 159<li>go to the freshly installed site</li>
133<li>fill the install form</li> 160<li>fill the install form</li>
134<li>log in to Shaarli</li> 161<li>log in to Shaarli</li>
135</ul> 162</ul>
136<p>Edit Shaarli's <a href="configuration|Shaarli-configuration.html">configuration|Shaarli configuration</a>:</p> 163<p>Edit Shaarli's <a href="configuration%7CShaarli-configuration.html">configuration|Shaarli configuration</a>:</p>
137<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># the file should be owned by Apache, thus not writeable =&gt; sudo</span> 164<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># the file should be owned by Apache, thus not writeable =&gt; sudo</span>
138$ <span class="kw">sudo</span> sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php</code></pre> 165$ <span class="kw">sudo</span> sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php</code></pre></div>
139</body> 166</body>
140</html> 167</html>
diff --git a/doc/Troubleshooting.html b/doc/Troubleshooting.html
index 98fd5354..0d58f321 100644
--- a/doc/Troubleshooting.html
+++ b/doc/Troubleshooting.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Troubleshooting</title> 7 <title>Shaarli Troubleshooting</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -131,23 +158,24 @@ code > span.er { color: #ff0000; font-weight: bold; }
131<p>Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.</p> 158<p>Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.</p>
132<p>To remove the current IP bans, delete the file <code>data/ipbans.php</code></p> 159<p>To remove the current IP bans, delete the file <code>data/ipbans.php</code></p>
133<h3 id="list-of-all-login-attempts">List of all login attempts</h3> 160<h3 id="list-of-all-login-attempts">List of all login attempts</h3>
134<p>The file <code>data/log.txt</code> shows all logins (successful or failed) and bans/lifted bans.<br />Search for <code>failed</code> in this file to look for unauthorized login attempts.</p> 161<p>The file <code>data/log.txt</code> shows all logins (successful or failed) and bans/lifted bans.<br />
162Search for <code>failed</code> in this file to look for unauthorized login attempts.</p>
135<h2 id="hosting-problems">Hosting problems</h2> 163<h2 id="hosting-problems">Hosting problems</h2>
136<h3 id="old-php-versions">Old PHP versions</h3> 164<h3 id="old-php-versions">Old PHP versions</h3>
137<ul> 165<ul>
138<li>On <strong>free.fr</strong> : free.fr now support php 5.6.x(<a href="http://les.pages.perso.chez.free.fr/migrations/php5v6.io">link</a>)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a <code>sessions</code> directory and a <code>.htaccess</code> file containing:<a href=".html"></a></li> 166<li>On <strong>free.fr</strong> : free.fr now support php 5.6.x(<a href="http://les.pages.perso.chez.free.fr/migrations/php5v6.io">link</a>)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a <code>sessions</code> directory and a <code>.htaccess</code> file containing:<a href=".html"></a></li>
139</ul> 167</ul>
140<pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">&lt;IfDefine Free&gt;</span> 168<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">&lt;IfDefine Free&gt;</span>
141<span class="dt">php56 1</span> 169<span class="dt">php56 1</span>
142<span class="dt">&lt;/IfDefine&gt;</span></code></pre> 170<span class="dt">&lt;/IfDefine&gt;</span></code></pre></div>
143<ul> 171<ul>
144<li>If you have an error such as: <code>Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx</code>, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to <code>.php5</code></li> 172<li>If you have an error such as: <code>Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx</code>, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to <code>.php5</code></li>
145<li>On <strong>1and1</strong> : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).</li> 173<li>On <strong>1and1</strong> : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).</li>
146<li>If you have the error <code>Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx</code>, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:<a href=".html"></a></li> 174<li>If you have the error <code>Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx</code>, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:<a href=".html"></a></li>
147</ul> 175</ul>
148<pre class="sourceCode php"><code class="sourceCode php"><span class="co">//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.</span> 176<div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.</span>
149<span class="co">// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) &lt;head&gt; in html </span> 177<span class="co">// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) &lt;head&gt; in html </span>
150<span class="co">//if (strpos($status,&#39;200 OK&#39;)) $title=html_extract_title($data);</span></code></pre> 178<span class="co">//if (strpos($status,&#39;200 OK&#39;)) $title=html_extract_title($data);</span></code></pre></div>
151<ul> 179<ul>
152<li>On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.</li> 180<li>On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.</li>
153<li>On <strong>lost-oasis</strong>, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <code>&lt;? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?&gt;</code>. To fix this, remove this message from <code>php-include/prepend.php</code></li> 181<li>On <strong>lost-oasis</strong>, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <code>&lt;? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?&gt;</code>. To fix this, remove this message from <code>php-include/prepend.php</code></li>
diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html
index 6d760771..b933bc7c 100644
--- a/doc/Unit-tests.html
+++ b/doc/Unit-tests.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Unit tests</title> 7 <title>Shaarli Unit tests</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -84,27 +111,27 @@ code > span.er { color: #ff0000; font-weight: bold; }
84<li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li> 111<li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li>
85</ul> 112</ul>
86<h4 id="sample-usage">Sample usage</h4> 113<h4 id="sample-usage">Sample usage</h4>
87<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span> 114<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span>
88$ <span class="kw">composer</span> install 115$ <span class="kw">composer</span> install
89$ <span class="kw">composer</span> update 116$ <span class="kw">composer</span> update
90 117
91<span class="co"># local version</span> 118<span class="co"># local version</span>
92$ <span class="kw">php</span> composer.phar self-update 119$ <span class="kw">php</span> composer.phar self-update
93$ <span class="kw">php</span> composer.phar install 120$ <span class="kw">php</span> composer.phar install
94$ <span class="kw">php</span> composer.phar update</code></pre> 121$ <span class="kw">php</span> composer.phar update</code></pre></div>
95<h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4> 122<h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4>
96<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli 123<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
97$ <span class="kw">composer</span> update</code></pre> 124$ <span class="kw">composer</span> update</code></pre></div>
98<h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4> 125<h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4>
99<p>For Debian-based distros:</p> 126<p>For Debian-based distros:</p>
100<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">aptitude</span> install php5-xdebug</code></pre> 127<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">aptitude</span> install php5-xdebug</code></pre></div>
101<p>For ArchLinux:</p> 128<p>For ArchLinux:</p>
102<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre> 129<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre></div>
103<p>Then add the following line to <code>/etc/php/php.ini</code>:</p> 130<p>Then add the following line to <code>/etc/php/php.ini</code>:</p>
104<pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">zend_extension</span><span class="ot">=</span><span class="st">xdebug.so</span></code></pre> 131<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">zend_extension</span><span class="ot">=</span><span class="st">xdebug.so</span></code></pre></div>
105<h4 id="run-unit-tests">Run unit tests</h4> 132<h4 id="run-unit-tests">Run unit tests</h4>
106<p>Successful test suite:</p> 133<p>Successful test suite:</p>
107<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test 134<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
108 135
109<span class="kw">-------</span> 136<span class="kw">-------</span>
110<span class="kw">PHPUNIT</span> 137<span class="kw">PHPUNIT</span>
@@ -117,9 +144,9 @@ $ <span class="kw">composer</span> update</code></pre>
117 144
118<span class="kw">Time</span>: 759 ms, Memory: 8.25Mb 145<span class="kw">Time</span>: 759 ms, Memory: 8.25Mb
119 146
120<span class="kw">OK</span> (36 tests, 65 assertions)</code></pre> 147<span class="kw">OK</span> (36 tests, 65 assertions)</code></pre></div>
121<p>Test suite with failures and errors:</p> 148<p>Test suite with failures and errors:</p>
122<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test 149<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
123<span class="kw">-------</span> 150<span class="kw">-------</span>
124<span class="kw">PHPUNIT</span> 151<span class="kw">PHPUNIT</span>
125<span class="kw">-------</span> 152<span class="kw">-------</span>
@@ -165,7 +192,7 @@ DBTest.php on line 79 and defined
165<span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span> 192<span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span>
166 193
167<span class="kw">FAILURES</span>! 194<span class="kw">FAILURES</span>!
168<span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre> 195<span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre></div>
169<h4 id="test-results-and-coverage">Test results and coverage</h4> 196<h4 id="test-results-and-coverage">Test results and coverage</h4>
170<p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p> 197<p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p>
171<p>Each test has 3 possible outcomes:</p> 198<p>Each test has 3 possible outcomes:</p>
diff --git a/doc/Upgrade-from-original-sebsauvage-Shaarli.html b/doc/Upgrade-from-original-sebsauvage-Shaarli.html
new file mode 100644
index 00000000..5297c8bb
--- /dev/null
+++ b/doc/Upgrade-from-original-sebsauvage-Shaarli.html
@@ -0,0 +1,75 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Upgrade from original sebsauvage Shaarli</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Installation
19<ul>
20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
30<li><a href="Usage.html">Usage</a>
31<ul>
32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
34<li><a href="Firefox-share.html">Firefox share</a></li>
35<li><a href="RSS-feeds.html">RSS feeds</a></li>
36</ul></li>
37<li>How To
38<ul>
39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
45</ul></li>
46<li><a href="Troubleshooting.html">Troubleshooting</a></li>
47<li><a href="Development.html">Development</a>
48<ul>
49<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
50<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
51<li><a href="Directory-structure.html">Directory structure</a></li>
52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
55<li><a href="Security.html">Security</a></li>
56<li><a href="Static-analysis.html">Static analysis</a></li>
57<li><a href="Theming.html">Theming</a></li>
58<li><a href="Unit-tests.html">Unit tests</a></li>
59</ul></li>
60<li>About
61<ul>
62<li><a href="FAQ.html">FAQ</a></li>
63<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
64<li><a href="TODO.html">TODO</a></li>
65</ul></li>
66</ul>
67</div>
68<h1 id="upgrade-from-original-sebsauvage-shaarli">Upgrade from original sebsauvage Shaarli</h1>
69<ul>
70<li>Backup your original <code>data/</code> directory.</li>
71<li><a href="https://github.com/shaarli/Shaarli#installation--upgrade">Install</a> and setup the Shaarli community fork.<a href=".html"></a></li>
72<li>Copy your original <code>data</code> directory over the new installation.</li>
73</ul>
74</body>
75</html>
diff --git a/doc/Upgrade-from-original-sebsauvage-Shaarli.md b/doc/Upgrade-from-original-sebsauvage-Shaarli.md
new file mode 100644
index 00000000..6ae0c67b
--- /dev/null
+++ b/doc/Upgrade-from-original-sebsauvage-Shaarli.md
@@ -0,0 +1,4 @@
1#Upgrade from original sebsauvage Shaarli
2 * Backup your original `data/` directory.
3 * [Install](https://github.com/shaarli/Shaarli#installation--upgrade) and setup the Shaarli community fork.[](.html)
4 * Copy your original `data` directory over the new installation.
diff --git a/doc/Usage.html b/doc/Usage.html
index 0ba457f6..5b4b8a5f 100644
--- a/doc/Usage.html
+++ b/doc/Usage.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Usage</title> 7 <title>Shaarli Usage</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/_Footer.html b/doc/_Footer.html
index 98032386..8cc166ac 100644
--- a/doc/_Footer.html
+++ b/doc/_Footer.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - _Footer</title> 7 <title>Shaarli _Footer</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -56,6 +65,7 @@
56</ul></li> 65</ul></li>
57</ul> 66</ul>
58</div> 67</div>
59<h1 id="footer-shaarli-the-personal-minimalist-super-fast-no-database-delicious-clone">_Footer<br /><em>Shaarli, the personal, minimalist, super-fast, no-database delicious clone</em></h1> 68<h1 id="footer-shaarli-the-personal-minimalist-super-fast-no-database-delicious-clone">_Footer<br />
69<em>Shaarli, the personal, minimalist, super-fast, no-database delicious clone</em></h1>
60</body> 70</body>
61</html> 71</html>
diff --git a/doc/_Sidebar.html b/doc/_Sidebar.html
index fbf6dffd..2c7d2837 100644
--- a/doc/_Sidebar.html
+++ b/doc/_Sidebar.html
@@ -4,12 +4,12 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - _Sidebar</title> 7 <title>Shaarli _Sidebar</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
9 <!--[if lt IE 9]> 10 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
11 <![endif]--> 12 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head> 13</head>
14<body> 14<body>
15<div id="local-sidebar"> 15<div id="local-sidebar">
@@ -20,18 +20,26 @@
20<li><a href="Download.html">Download</a></li> 20<li><a href="Download.html">Download</a></li>
21<li><a href="Server-requirements.html">Server requirements</a></li> 21<li><a href="Server-requirements.html">Server requirements</a></li>
22<li><a href="Server-configuration.html">Server configuration</a></li> 22<li><a href="Server-configuration.html">Server configuration</a></li>
23<li><a href="Server-security.html">Server security</a></li>
24<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
23<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
24</ul></li> 27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Plugin-list.html">Plugin list</a></li>
25<li><a href="Usage.html">Usage</a> 30<li><a href="Usage.html">Usage</a>
26<ul> 31<ul>
27<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 32<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
33<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
28<li><a href="Firefox-share.html">Firefox share</a></li> 34<li><a href="Firefox-share.html">Firefox share</a></li>
29<li><a href="RSS-feeds.html">RSS feeds</a></li> 35<li><a href="RSS-feeds.html">RSS feeds</a></li>
30</ul></li> 36</ul></li>
31<li>How To 37<li>How To
32<ul> 38<ul>
33<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 39<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
40<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
34<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 41<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
42<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
35<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 43<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
36<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 44<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
37</ul></li> 45</ul></li>
@@ -43,6 +51,7 @@
43<li><a href="Directory-structure.html">Directory structure</a></li> 51<li><a href="Directory-structure.html">Directory structure</a></li>
44<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 52<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
45<li><a href="Plugin-System.html">Plugin System</a></li> 53<li><a href="Plugin-System.html">Plugin System</a></li>
54<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
46<li><a href="Security.html">Security</a></li> 55<li><a href="Security.html">Security</a></li>
47<li><a href="Static-analysis.html">Static analysis</a></li> 56<li><a href="Static-analysis.html">Static analysis</a></li>
48<li><a href="Theming.html">Theming</a></li> 57<li><a href="Theming.html">Theming</a></li>
@@ -64,18 +73,26 @@
64<li><a href="Download.html">Download</a></li> 73<li><a href="Download.html">Download</a></li>
65<li><a href="Server-requirements.html">Server requirements</a></li> 74<li><a href="Server-requirements.html">Server requirements</a></li>
66<li><a href="Server-configuration.html">Server configuration</a></li> 75<li><a href="Server-configuration.html">Server configuration</a></li>
76<li><a href="Server-security.html">Server security</a></li>
77<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
67<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 78<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
79<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
68</ul></li> 80</ul></li>
81<li><a href="Docker.html">Docker</a></li>
82<li><a href="Plugin-list.html">Plugin list</a></li>
69<li><a href="Usage.html">Usage</a> 83<li><a href="Usage.html">Usage</a>
70<ul> 84<ul>
71<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 85<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
86<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
72<li><a href="Firefox-share.html">Firefox share</a></li> 87<li><a href="Firefox-share.html">Firefox share</a></li>
73<li><a href="RSS-feeds.html">RSS feeds</a></li> 88<li><a href="RSS-feeds.html">RSS feeds</a></li>
74</ul></li> 89</ul></li>
75<li>How To 90<li>How To
76<ul> 91<ul>
77<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 92<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
93<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 94<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
95<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
79<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 96<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
80<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 97<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
81</ul></li> 98</ul></li>
@@ -87,6 +104,7 @@
87<li><a href="Directory-structure.html">Directory structure</a></li> 104<li><a href="Directory-structure.html">Directory structure</a></li>
88<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 105<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
89<li><a href="Plugin-System.html">Plugin System</a></li> 106<li><a href="Plugin-System.html">Plugin System</a></li>
107<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
90<li><a href="Security.html">Security</a></li> 108<li><a href="Security.html">Security</a></li>
91<li><a href="Static-analysis.html">Static analysis</a></li> 109<li><a href="Static-analysis.html">Static analysis</a></li>
92<li><a href="Theming.html">Theming</a></li> 110<li><a href="Theming.html">Theming</a></li>
diff --git a/doc/_Sidebar.md b/doc/_Sidebar.md
index 68e3b9f3..4522c254 100644
--- a/doc/_Sidebar.md
+++ b/doc/_Sidebar.md
@@ -4,14 +4,22 @@
4 - [Download](Download.html) 4 - [Download](Download.html)
5 - [Server requirements](Server-requirements.html) 5 - [Server requirements](Server-requirements.html)
6 - [Server configuration](Server-configuration.html) 6 - [Server configuration](Server-configuration.html)
7 - [Server security](Server-security.html)
8 - [Shaarli installation](Shaarli-installation.html)
7 - [Shaarli configuration](Shaarli-configuration.html) 9 - [Shaarli configuration](Shaarli-configuration.html)
10 - [Plugin installation & configuration](Plugin-installation-&-configuration.html)
11- [Docker](Docker.html)
12- [Plugin list](Plugin-list.html)
8- [Usage](Usage.html) 13- [Usage](Usage.html)
9 - [Sharing button](Sharing-button.html) (bookmarklet) 14 - [Sharing button](Sharing-button.html) (bookmarklet)
15 - [Browsing and Searching](Browsing-and-Searching.html)
10 - [Firefox share](Firefox-share.html) 16 - [Firefox share](Firefox-share.html)
11 - [RSS feeds](RSS-feeds.html) 17 - [RSS feeds](RSS-feeds.html)
12- How To 18- How To
13 - [Backup, restore, import and export](Backup,-restore,-import-and-export.html) 19 - [Backup, restore, import and export](Backup,-restore,-import-and-export.html)
20 - [Upgrade from original sebsauvage/Shaarli](Upgrade-from-original-sebsauvage/Shaarli.html)
14 - [Copy an existing installation over SSH and serve it locally](Copy-an-existing-installation-over-SSH-and-serve-it-locally.html) 21 - [Copy an existing installation over SSH and serve it locally](Copy-an-existing-installation-over-SSH-and-serve-it-locally.html)
22 - [Create and serve multiple Shaarlis (farm)](Create-and-serve-multiple-Shaarlis-(farm).html)
15 - [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) 23 - [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html)
16 - [Datastore hacks](Datastore-hacks.html) 24 - [Datastore hacks](Datastore-hacks.html)
17- [Troubleshooting](Troubleshooting.html) 25- [Troubleshooting](Troubleshooting.html)
@@ -21,6 +29,7 @@
21 - [Directory structure](Directory-structure.html) 29 - [Directory structure](Directory-structure.html)
22 - [3rd party libraries](3rd-party-libraries.html) 30 - [3rd party libraries](3rd-party-libraries.html)
23 - [Plugin System](Plugin-System.html) 31 - [Plugin System](Plugin-System.html)
32 - [Release Shaarli](Release-Shaarli.html)
24 - [Security](Security.html) 33 - [Security](Security.html)
25 - [Static analysis](Static-analysis.html) 34 - [Static analysis](Static-analysis.html)
26 - [Theming](Theming.html) 35 - [Theming](Theming.html)
diff --git a/doc/images/doc-logo.svg b/doc/images/doc-logo.svg
new file mode 100644
index 00000000..37fc6658
--- /dev/null
+++ b/doc/images/doc-logo.svg
@@ -0,0 +1,522 @@
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<svg
3 xmlns:dc="http://purl.org/dc/elements/1.1/"
4 xmlns:cc="http://creativecommons.org/ns#"
5 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
6 xmlns:svg="http://www.w3.org/2000/svg"
7 xmlns="http://www.w3.org/2000/svg"
8 xmlns:xlink="http://www.w3.org/1999/xlink"
9 width="600"
10 height="240"
11 id="svg2"
12 version="1.1">
13 <title
14 id="title6384">Shaarli Logo</title>
15 <defs
16 id="defs4">
17 <linearGradient
18 id="linearGradient4405">
19 <stop
20 style="stop-color:#000000;stop-opacity:1;"
21 offset="0"
22 id="stop4407" />
23 <stop
24 style="stop-color:#ffffff;stop-opacity:1;"
25 offset="1"
26 id="stop4409" />
27 </linearGradient>
28 <linearGradient
29 id="linearGradient3780">
30 <stop
31 style="stop-color:#8aea00;stop-opacity:1;"
32 offset="0"
33 id="stop3782" />
34 <stop
35 style="stop-color:#ebff36;stop-opacity:1;"
36 offset="1"
37 id="stop3784" />
38 </linearGradient>
39 <linearGradient
40 id="linearGradient4333-6-7">
41 <stop
42 style="stop-color:#ffffff;stop-opacity:1;"
43 offset="0"
44 id="stop4335-0-4" />
45 <stop
46 style="stop-color:#e1e1e1;stop-opacity:1;"
47 offset="1"
48 id="stop4337-49-0" />
49 </linearGradient>
50 <linearGradient
51 xlink:href="#linearGradient4333-6-7"
52 id="linearGradient4435"
53 gradientUnits="userSpaceOnUse"
54 gradientTransform="translate(-606.51586,-487.01655)"
55 x1="845.7998"
56 y1="637.30005"
57 x2="845.7998"
58 y2="509.84348" />
59 <linearGradient
60 xlink:href="#linearGradient3780"
61 id="linearGradient4437"
62 gradientUnits="userSpaceOnUse"
63 gradientTransform="translate(-1434.0326,365.55395)"
64 x1="1984.2427"
65 y1="-348.63434"
66 x2="1984.2427"
67 y2="-293.69879" />
68 <linearGradient
69 xlink:href="#linearGradient4333-6-7"
70 id="linearGradient4439"
71 gradientUnits="userSpaceOnUse"
72 gradientTransform="translate(-699.19746,-487.01655)"
73 x1="845.7998"
74 y1="637.30005"
75 x2="845.7998"
76 y2="509.84348" />
77 <linearGradient
78 xlink:href="#linearGradient4333-6-7"
79 id="linearGradient4441"
80 gradientUnits="userSpaceOnUse"
81 gradientTransform="translate(-699.87915,-487.01655)"
82 x1="845.7998"
83 y1="637.30005"
84 x2="845.7998"
85 y2="509.84348" />
86 <linearGradient
87 xlink:href="#linearGradient4333-6-7"
88 id="linearGradient4443"
89 gradientUnits="userSpaceOnUse"
90 gradientTransform="translate(-703.2869,-487.01655)"
91 x1="845.7998"
92 y1="637.30005"
93 x2="845.7998"
94 y2="509.84348" />
95 <linearGradient
96 xlink:href="#linearGradient4333-6-7"
97 id="linearGradient4445"
98 gradientUnits="userSpaceOnUse"
99 gradientTransform="translate(-701.24225,-487.01655)"
100 x1="845.7998"
101 y1="637.30005"
102 x2="845.7998"
103 y2="509.84348" />
104 <linearGradient
105 xlink:href="#linearGradient4333-6-7"
106 id="linearGradient4447"
107 gradientUnits="userSpaceOnUse"
108 gradientTransform="translate(-699.1976,-487.01655)"
109 x1="845.7998"
110 y1="637.30005"
111 x2="845.7998"
112 y2="509.84348" />
113 <linearGradient
114 xlink:href="#linearGradient4333-6-7"
115 id="linearGradient4449"
116 gradientUnits="userSpaceOnUse"
117 gradientTransform="translate(-701.24225,-487.01655)"
118 x1="845.7998"
119 y1="637.30005"
120 x2="845.7998"
121 y2="509.84348" />
122 <linearGradient
123 xlink:href="#linearGradient4333-6-7"
124 id="linearGradient4451"
125 gradientUnits="userSpaceOnUse"
126 gradientTransform="translate(-701.24225,-487.01655)"
127 x1="845.7998"
128 y1="637.30005"
129 x2="845.7998"
130 y2="509.84348" />
131 <linearGradient
132 xlink:href="#linearGradient4333-6-7"
133 id="linearGradient4453"
134 gradientUnits="userSpaceOnUse"
135 gradientTransform="translate(-701.24225,-487.01655)"
136 x1="845.7998"
137 y1="637.30005"
138 x2="845.7998"
139 y2="509.84348" />
140 <linearGradient
141 y2="509.84348"
142 x2="845.7998"
143 y1="637.30005"
144 x1="845.7998"
145 gradientTransform="translate(-701.24225,-487.01655)"
146 gradientUnits="userSpaceOnUse"
147 id="linearGradient6071"
148 xlink:href="#linearGradient4333-6-7" />
149 <linearGradient
150 y2="509.84348"
151 x2="845.7998"
152 y1="637.30005"
153 x1="845.7998"
154 gradientTransform="translate(-701.24225,-487.01655)"
155 gradientUnits="userSpaceOnUse"
156 id="linearGradient6073"
157 xlink:href="#linearGradient4333-6-7" />
158 <linearGradient
159 y2="509.84348"
160 x2="845.7998"
161 y1="637.30005"
162 x1="845.7998"
163 gradientTransform="translate(-701.24225,-487.01655)"
164 gradientUnits="userSpaceOnUse"
165 id="linearGradient6075"
166 xlink:href="#linearGradient4333-6-7" />
167 <linearGradient
168 y2="509.84348"
169 x2="845.7998"
170 y1="637.30005"
171 x1="845.7998"
172 gradientTransform="translate(-699.1976,-487.01655)"
173 gradientUnits="userSpaceOnUse"
174 id="linearGradient6077"
175 xlink:href="#linearGradient4333-6-7" />
176 <linearGradient
177 y2="509.84348"
178 x2="845.7998"
179 y1="637.30005"
180 x1="845.7998"
181 gradientTransform="translate(-701.24225,-487.01655)"
182 gradientUnits="userSpaceOnUse"
183 id="linearGradient6079"
184 xlink:href="#linearGradient4333-6-7" />
185 <linearGradient
186 y2="509.84348"
187 x2="845.7998"
188 y1="637.30005"
189 x1="845.7998"
190 gradientTransform="translate(-703.2869,-487.01655)"
191 gradientUnits="userSpaceOnUse"
192 id="linearGradient6081"
193 xlink:href="#linearGradient4333-6-7" />
194 <linearGradient
195 y2="509.84348"
196 x2="845.7998"
197 y1="637.30005"
198 x1="845.7998"
199 gradientTransform="translate(-699.87915,-487.01655)"
200 gradientUnits="userSpaceOnUse"
201 id="linearGradient6083"
202 xlink:href="#linearGradient4333-6-7" />
203 <linearGradient
204 y2="509.84348"
205 x2="845.7998"
206 y1="637.30005"
207 x1="845.7998"
208 gradientTransform="translate(-699.19746,-487.01655)"
209 gradientUnits="userSpaceOnUse"
210 id="linearGradient6085"
211 xlink:href="#linearGradient4333-6-7" />
212 <linearGradient
213 y2="-293.69879"
214 x2="1984.2427"
215 y1="-348.63434"
216 x1="1984.2427"
217 gradientTransform="translate(-1434.0326,365.55395)"
218 gradientUnits="userSpaceOnUse"
219 id="linearGradient6087"
220 xlink:href="#linearGradient3780" />
221 <linearGradient
222 y2="509.84348"
223 x2="845.7998"
224 y1="637.30005"
225 x1="845.7998"
226 gradientTransform="translate(-606.51586,-487.01655)"
227 gradientUnits="userSpaceOnUse"
228 id="linearGradient6089"
229 xlink:href="#linearGradient4333-6-7" />
230 <linearGradient
231 y2="-5.3252554"
232 x2="1795.8763"
233 y1="-116.8399"
234 x1="1795.8763"
235 gradientTransform="translate(-1431.3064,219.11539)"
236 gradientUnits="userSpaceOnUse"
237 id="linearGradient6095"
238 xlink:href="#linearGradient4405" />
239 <mask
240 id="mask6091"
241 maskUnits="userSpaceOnUse">
242 <rect
243 y="11.978719"
244 x="8.1208458"
245 height="153.34807"
246 width="582.72266"
247 id="rect6093"
248 style="color:#000000;fill:url(#linearGradient6095);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0" />
249 </mask>
250 </defs>
251 <metadata
252 id="metadata7">
253 <rdf:RDF>
254 <cc:Work
255 rdf:about="">
256 <dc:format>image/svg+xml</dc:format>
257 <dc:type
258 rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
259 <dc:title>Shaarli Logo</dc:title>
260 <dc:creator>
261 <cc:Agent>
262 <dc:title>http://blog.idleman.fr/</dc:title>
263 </cc:Agent>
264 </dc:creator>
265 <dc:date>2012-08-29 22:36:01+02:00</dc:date>
266 <dc:publisher>
267 <cc:Agent>
268 <dc:title>http://sebsauvage.net/</dc:title>
269 </cc:Agent>
270 </dc:publisher>
271 <dc:subject>
272 <rdf:Bag>
273 <rdf:li>Shaarli</rdf:li>
274 <rdf:li>Logo</rdf:li>
275 </rdf:Bag>
276 </dc:subject>
277 <dc:contributor>
278 <cc:Agent>
279 <dc:title>http://thatguynamedandy.com/,
280http://mro.name/me</dc:title>
281 </cc:Agent>
282 </dc:contributor>
283 <cc:license
284 rdf:resource="http://www.opensource.org/licenses/zlib-license.php" />
285 <dc:source>http://sebsauvage.net/files/shaarli_logo.zip</dc:source>
286 <dc:relation>http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion#comment_09a1e91bc0abc7db6d186a6abf429877</dc:relation>
287 </cc:Work>
288 </rdf:RDF>
289 </metadata>
290 <g
291 style="display:inline"
292 id="layer9">
293 <g
294 id="g6232">
295 <g
296 style="display:inline"
297 id="g5987"
298 transform="matrix(1,0,0,-1,0,323.7441)"
299 mask="url(#mask6091)">
300 <path
301 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
302 d="m 549.36434,78.11349 c -9.4946,1.99352 -9.7027,14.03504 -9.8352,21.77668 0.1121,11.0831 -0.2095,22.9628 4.1417,33.27264 2.0054,4.85047 9.7812,4.74809 10.3195,-1.06753 4.7624,-15.20498 4.7481,-32.01281 1.4946,-47.50541 -0.983,-2.75668 -3.069,-6.35036 -6.1206,-6.47638 z"
303 id="path5989" />
304 <path
305 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
306 d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z"
307 id="path5991" />
308 <path
309 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
310 d="m 132.42293,35.23407 c -7.6945,2.17125 -5.9206,12.79289 -6.2273,19.00216 1.6106,23.24538 0.8475,46.57408 2.1706,69.81693 0.068,7.09423 3.2021,16.90233 11.8853,16.22657 7.5709,-1.76417 5.7778,-11.8325 5.6557,-17.71589 -0.047,-7.84014 -4.5559,-19.23884 3.9165,-24.30949 7.6405,-5.37547 19.848,0.64078 18.6463,10.39069 -0.3251,8.83089 -2.0837,22.16882 7.8287,26.47493 6.4024,2.92649 10.6176,-5.21693 9.3943,-10.71096 -0.3749,-13.55442 1.2727,-30.22607 -10.711,-39.6768 -7.9735,-4.05845 -18.9828,-5.54515 -26.8307,-0.21351 -1.0372,2.42576 -6.9951,6.95054 -6.4053,1.24546 -1.6949,-15.3749 2.056,-31.45755 -2.3485,-46.40228 -1.2024,-2.63946 -4.0324,-4.45898 -6.9746,-4.12781 z"
311 id="path5993" />
312 <path
313 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
314 d="m 442.14024,64.05759 c -10.165,-0.2579 -20.6562,1.86137 -28.1474,9.18081 -2.8958,2.05591 -1.2663,-4.94966 -4.8395,-5.01742 -5.4074,-2.93338 -11.5829,2.98762 -9.5367,8.75381 0.099,20.06919 -1.977,40.97889 3.8787,60.387 3.1796,4.95849 13.7562,4.09337 12.7037,-2.9891 1.546,-15.53942 -2.968,-32.10549 3.167,-46.86488 4.3319,-8.66318 18.41,-14.13659 25.3718,-5.90704 3.521,6.12624 -0.9752,16.78774 6.8323,20.31879 7.6504,1.3481 9.6041,-9.08157 8.825,-14.7676 -1.6539,-6.72434 -2.1565,-14.5353 -6.6544,-19.99852 -3.1376,-2.78799 -7.564,-3.22067 -11.6005,-3.09585 z"
315 id="path5995" />
316 <path
317 style="color:#000000;fill:url(#linearGradient6071);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
318 d="m 442.38294,54.04595 c -0.1827,-0.005 -0.3789,0.0345 -0.5625,0.0312 -8.6942,-0.15632 -18.301,1.16995 -26.7813,5.96876 -0.368,-0.21564 -0.7676,-0.37654 -1.1562,-0.5625 l 0.031,-0.0625 c -0.2019,-0.10958 -0.4204,-0.1194 -0.625,-0.21875 -0.5569,-0.23563 -1.1103,-0.37966 -1.6874,-0.53125 -6.0741,-2.10894 -12.7994,-0.4336 -16.8438,3.34375 -3.8577,3.60298 -6.0063,9.29062 -5.1562,15.125 0.085,19.31578 -2.292,41.23535 4.3124,63.12499 l 0.4063,1.3125 0.75,1.1875 c 4.4521,6.94297 11.5862,8.53059 18,7.46875 3.2069,-0.53092 6.701,-1.89897 9.5,-5.03125 2.2725,-2.54317 3.5121,-6.27514 3.5937,-9.84375 0,-0.0435 0,-0.0816 0,-0.125 1.7478,-17.81793 -1.8544,-32.72457 2.2813,-43.375 0.6976,-1.23208 3.1856,-3.39065 5.4063,-4.03125 1.1119,-0.32077 1.7363,-0.44325 2.1874,-0.40625 0.051,0.8996 0.2789,2.71568 0.5313,6.0625 0.1821,2.41445 0.4732,5.42185 2.0313,8.8125 1.558,3.39065 4.8419,6.94014 8.8437,8.75 l 1.1563,0.5 1.2187,0.21875 c 4.1545,0.73208 8.9361,-0.28467 12.2187,-2.59375 3.2827,-2.30908 5.1358,-5.31163 6.3126,-8.0625 2.3534,-5.50175 2.5912,-10.54096 1.9374,-15.3125 l -0.062,-0.53125 -0.125,-0.5 c -1.3372,-5.43656 -1.418,-15.17693 -8.6563,-23.96874 l -0.4687,-0.59375 -0.5938,-0.53125 c -6.0316,-5.35952 -13.0425,-5.71213 -18,-5.59376 l 0,-0.0312 z m -20.9688,14.62501 c 0.3103,0.61975 0.1924,0.76755 0.063,0.28125 -0.016,-0.0599 -0.046,-0.21107 -0.063,-0.28125 z m -11.8437,14.15624 c 0.271,0.10418 0.5347,0.22752 0.8125,0.3125 l -0.125,0.21875 -0.125,0.3125 c -0.2313,0.55649 -0.3535,1.10135 -0.5625,1.65625 0.01,-0.84699 -0.01,-1.64903 0,-2.5 z"
319 id="path5997" />
320 <path
321 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:38"
322 d="m 334.93614,43.42895 -1.125,0.0625 c -11.4541,0.68757 -31.1299,2.13948 -42.5313,20.5 l -0.6875,1.15625 -0.5312,1.21875 c -4.0155,9.09454 -1.1737,19.34928 5,25.5 -7.1006,9.03999 -10.5361,20.69833 -9.25,32.65625 -0.7932,13.71238 8.5163,26.58972 21.5624,30.34375 l -0.031,0.0625 c 14.5936,5.02387 28.3345,3.89176 40,1.875 1.1383,0.61027 2.377,1.24208 3.8438,1.84375 3.1932,1.30991 7.6804,2.60895 13.1874,1.96875 5.5071,-0.6402 11.3463,-3.71585 15.0626,-7.53125 l 0.6562,-0.6875 0.5938,-0.75 c 7.375,-9.27994 7.6766,-20.19393 7.1874,-26.8125 -0.4891,-6.61857 -1.0653,-10.99648 -1.0312,-11.375 l 0.125,-1.46875 -0.094,-1.5 c -0.9045,-13.69999 -0.4438,-31.50909 -8.6874,-49.71875 -0.8869,-3.14352 -2.6183,-4.60975 -5,-6.625 -14.193,-12.04738 -29.8012,-10.22761 -37.125,-10.65625 z m -5,69.25 c -0.6975,0.25422 -0.096,-0.059 3.5937,0.375 3.1757,0.3735 8.4922,1.29071 15.3437,0.34375 -0.042,1.60674 -0.047,3.10046 0.031,4.46875 l -1.2187,0.25 c -9.4296,1.92946 -17.7526,2.70557 -24.0626,1.71875 0.3089,-2.61777 2.5558,-6.11412 4.2813,-6.53125 l 1.0313,-0.25 1,-0.375 z"
323 id="path5999" />
324 <path
325 id="path6001"
326 d="m 242.86794,62.94328 c -9.8451,0.59098 -21.9234,2.57343 -27.5069,11.56498 -1.5225,3.44827 2.5155,7.16458 5.8003,4.55483 11.6876,-3.18405 25.8772,-8.64334 36.9368,-1.03196 3.4255,4.6575 3.2712,13.73214 -2.1351,16.8315 -8.1137,1.83399 -16.456,-2.50178 -24.589,0.4626 -12.7407,3.08001 -20.924,16.83116 -18.6463,29.53519 -1.221,6.03853 2.7535,11.58045 8.7182,12.59694 12.2603,4.22059 25.7141,2.25842 37.9688,-0.24909 3.9671,2.72001 9.7011,7.85911 14.3406,3.09585 6.2596,-7.87653 1.273,-19.02318 2.088,-28.06851 -0.9577,-14.50429 -1.0481,-29.91302 -7.0343,-43.1362 -7.0905,-6.01862 -17.2216,-5.6458 -25.9411,-6.15613 z"
327 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
328 <path
329 style="color:#000000;fill:url(#linearGradient6073);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
330 d="m 132.71733,24.19589 c -0.5004,0.0152 -1.0205,0.0363 -1.5312,0.0937 l -0.9063,0.0937 -0.8437,0.25 c -4.2861,1.20943 -8.1936,4.24904 -10.375,7.56249 -2.1816,3.31346 -2.9841,6.56659 -3.4063,9.375 -0.8444,5.61682 -0.3823,10.37282 -0.4687,12.125 l -0.031,0.65625 0.062,0.625 c 1.548,22.34205 0.8033,45.46456 2.125,69.1875 5e-4,0.0505 0.031,0.10568 0.031,0.15625 0.01,0.1151 -0.01,0.22862 0,0.34375 l 0.031,0 c 0.099,4.98929 0.9665,10.43113 4.125,15.90625 3.2605,5.65198 11.0145,11.32149 19.5625,10.65625 l 0.8438,-0.0625 0.8124,-0.1875 c 4.2384,-0.98762 8.3269,-3.79564 10.625,-7.09375 2.1728,-3.63384 4.3342,-6.89183 5.1872,-10.22818 3.8402,7.13335 5.9507,8.04619 13.1566,11.44693 l 0,0.0312 c 0.059,0.0269 0.1281,0.0362 0.1875,0.0625 3.7423,1.65403 8.4312,1.97661 12.2813,0.65625 3.91101,-1.34132 6.71761,-3.90092 8.59371,-6.5 3.336,-4.62154 4.6441,-9.64143 3.9063,-15.25 -0.1718,-6.20746 0.2238,-14.23226 -1.1563,-22.8125 -1.3801,-8.58024 -5.0962,-18.36284 -13.75001,-25.1875 l -0.8437,-0.6875 -0.9688,-0.5 c -7.7653,-3.95251 -17.7087,-6.355 -27.4062,-4.09375 0.4086,-10.28331 1.089,-21.96033 -2.625,-34.5625 l -0.2188,-0.75 -0.3125,-0.71875 c -2.9167,-6.40275 -9.181,-10.82231 -16.6875,-10.59374 z m 6.0625,53.99999 c 0,0.0101 0.05,0.0315 0.062,0.0625 l -0.6245,1.46875 c 0.3311,-0.86163 0.5542,-1.56647 0.5625,-1.53125 z m 36.0625,48.28125 c 0.012,-0.004 0.019,0.005 0.031,0 l 0.063,0.3125 c -0.043,-0.19086 -0.061,-0.25465 -0.094,-0.3125 z"
331 id="path6003" />
332 <path
333 style="fill:#484848;fill-opacity:1;stroke:none"
334 id="path6005"
335 d="m 133.3461,36.09636 c -1.692,0.49428 -2.8155,1.39846 -3.625,2.625 -0.8214,1.24442 -1.3243,2.85069 -1.5938,4.625 -0.5342,3.51732 -0.1953,7.61208 -0.3438,10.8125 0,0.0285 0,0.0654 0,0.0937 1.6063,23.27388 0.8692,46.5905 2.1876,69.75 a 0.88388823,0.88388823 0 0 1 0,0.0625 c 0.033,3.4213 0.83,7.53419 2.5937,10.59375 1.7438,3.02495 4.2922,5.00636 8.2187,4.75 0.011,-7.3e-4 0.02,7.7e-4 0.031,0 1.6857,-0.39978 2.7542,-1.19719 3.5313,-2.3125 0.7819,-1.12237 1.2391,-2.59827 1.4687,-4.25 0.4593,-3.30346 2e-4,-7.22907 -0.062,-10.25 a 0.88388823,0.88388823 0 0 1 0,-0.0312 c -0.023,-3.75401 -1.179,-8.58343 -1.25,-13.1875 -0.071,-4.59014 1.0512,-9.12033 5.5625,-11.84375 0.012,-0.008 0.019,-0.023 0.031,-0.0312 8.2411,-5.75335 21.2001,0.72746 19.9687,11.1875 0,0.011 0,0.0202 0,0.0312 -4e-4,0.01 4e-4,0.0216 0,0.0312 -0.1662,4.44678 -0.6416,9.92071 0.094,14.71875 0.7386,4.81878 2.5857,8.83105 7.2188,10.84375 a 0.88388823,0.88388823 0 0 1 0.031,0 c 1.4264,0.65196 2.625,0.67804 3.6876,0.3125 1.0625,-0.36554 2.0152,-1.15367 2.7812,-2.21875 1.532,-2.13016 2.2012,-5.36524 1.6562,-7.8125 a 0.88388823,0.88388823 0 0 1 0,-0.15625 c -0.1887,-6.82351 0.1073,-14.35845 -1,-21.28125 -1.1026,-6.89383 -3.5864,-13.13587 -9.3124,-17.6875 -7.7294,-3.90433 -18.3437,-5.25802 -25.7813,-0.25 -0.7734,1.48479 -2.3237,3.00623 -4,3.78125 -0.9043,0.41808 -1.982,0.65336 -2.875,0.0312 -0.8519,-0.59346 -1.0866,-1.72753 -0.9687,-3.1875 0.01,-0.0705 -0.01,-0.11538 0,-0.1875 -1.6634,-15.48034 1.9617,-31.38045 -2.2813,-45.9375 -1.0363,-2.2749 -3.4784,-3.85945 -5.9687,-3.625 z" />
336 <path
337 style="color:#000000;fill:url(#linearGradient6075);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
338 d="m 500.00794,37.6397 c -0.47,-0.0246 -0.9099,0.13839 -1.375,0.15625 -0.3182,0.036 -0.6564,-0.0583 -0.9688,0 l 0,0.0937 c -5.9486,0.59666 -11.3199,4.27914 -13.8124,8.625 -2.5191,4.39212 -3.1643,9.07388 -2.4688,13.75001 -0.5691,24.07161 -0.3288,48.17845 0.031,71.96874 l 0.031,1.1875 0.2813,1.125 c 2.2758,9.05358 10.1204,12.94327 17.2812,13.3125 3.5804,0.18461 7.6057,-0.50128 11.25,-3.21875 3.4431,-2.56742 5.753,-7.21537 6.0625,-11.6875 l 0.062,0 c 0.024,-0.26477 0.01,-0.51719 0.031,-0.78125 1.2169,-14.32127 -0.1813,-27.63851 0.6563,-39.5625 0.8412,-12.28307 -0.4559,-23.97948 -0.6563,-34.18749 0.9168,-4.19732 0.7514,-8.64033 -1.75,-13.09376 -2.5398,-4.52202 -8.6787,-7.57722 -14.4374,-7.5625 -0.073,1.9e-4 -0.1457,-0.001 -0.2188,0 l 0,-0.125 z m -0.4375,10.46875 1.5625,8.375 c -0.089,0.0884 -0.5399,0.26586 -0.9688,0.50001 -0.4433,-0.17558 -0.588,-0.31717 -1.125,-0.59376 l 0.5313,-8.28125 z m 1.625,8.6875 0.125,0.65626 c 0,-5.2e-4 -0.146,-0.0578 -0.1563,-0.0625 0.013,-0.26164 0.01,-0.41632 0.031,-0.59376 z"
339 id="path6007" />
340 <path
341 style="fill:#484848;fill-opacity:1;stroke:none"
342 d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z"
343 id="path6009" />
344 <path
345 style="fill:#000000;fill-opacity:1;stroke:none"
346 d="m 544.51954,53.6313 c -7.5784,-0.46784 -10.6755,10.08558 -4.626,14.19825 6.4831,5.13984 16.9776,-2.57743 12.9884,-10.24836 -1.4384,-3.20261 -5.1136,-4.25984 -8.3624,-3.94989 z"
347 id="path6011" />
348 <path
349 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:38;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
350 d="m 66.312222,57.93009 c -17.370703,0.62829 -30.0641,20.09681 -26.023403,36.39781 2.1928,10.05075 13.8541,12.09708 22.635103,11.4922 7.1377,-0.5151 17.6041,2.45346 16.7319,11.49222 -1.8676,6.29718 -10.9897,4.97438 -16.0667,5.21679 -7.019003,0.3042 -14.551803,-2.83467 -21.309203,-1.0251 -5.546297,3.71601 -0.7698,11.63178 4.4362,13.09902 11.6204,3.85396 24.776703,2.98561 36.677203,0.52396 8.494404,-1.78465 13.976704,-9.66183 14.007304,-18.12905 0.5362,-8.45978 -0.1252,-18.85777 -9.082,-22.63511 -7.833304,-4.5437 -17.524404,-2.59996 -25.744004,-4.64578 -6.504303,-3.75215 -4.590203,-15.08325 3.2137,-15.54417 8.376,-2.645 16.5844,3.54335 24.730904,1.74653 6.8027,-2.75685 5.6777,-13.26551 -1.2924,-15.19486 C 82.177322,57.19274 73.972122,57.9802 66.312222,57.93009 Z"
351 id="path6013" />
352 <path
353 style="color:#000000;fill:url(#linearGradient6077);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
354 d="m 66.146122,46.92095 -0.2187,0.0312 c -25.268203,0.91394 -41.9786,26.29641 -36.375,49.71875 0,0.01 0,0.0214 0,0.0312 0.023,0.0937 0.039,0.18758 0.062,0.28125 l 0.062,0 c 1.4158,6.03031 5.2241,10.72981 9.5937,13.9375 l -1.5937,0.4375 -1.5313,1 c -3.4934,2.34058 -6.2461,6.40677 -7.0312,10.4375 -0.7852,4.03073 0.016,7.64447 1.2812,10.53125 2.4625,5.61698 6.4364,9.72109 12.843797,11.6875 l 0,0.0312 c 0.1235,0.0409 0.2514,0.0537 0.375,0.0937 0.044,0.0142 0.081,0.0484 0.125,0.0625 14.2876,4.59699 29.052403,3.33987 41.875007,0.6875 l 0.031,0 c 13.703,-2.87897 22.354804,-15.23519 22.687504,-28.1875 l 0.031,0 c 0.01,-0.1043 -0.01,-0.23849 0,-0.34375 0,-0.10511 0.031,-0.20733 0.031,-0.3125 l -0.031,0 c 0.275,-4.68022 0.3633,-10.21921 -1.4063,-16.21875 -1.6128,-5.46789 -5.6186,-11.40935 -11.718704,-15.03125 C 110.28983,79.05558 108.57813,56.15757 93.550926,50.6395 83.076822,45.62854 73.121622,46.96476 66.394622,46.92075 l -0.25,0 z M 49.927419,124.0772 c 0.4736,0.11312 0.7429,0.17483 0.6875,0.1875 -0.1379,-0.0437 -0.3009,-0.0484 -0.4375,-0.0937 l -0.25,-0.0937 z"
355 id="path6015" />
356 <path
357 style="fill:#484848;fill-opacity:1;stroke:none"
358 id="path6017"
359 d="M 67.047,59.37761 C 50.7565,60.01346 38.6203,78.63489 42.422,93.97136 a 1.4420115,1.4420115 0 0 1 0,0.0312 c 0.9874,4.52574 3.9833,7.14275 7.9688,8.71875 3.9854,1.576 8.921,1.948 13.1562,1.65625 3.8182,-0.27555 8.4163,0.35581 12.1562,2.34375 3.74,1.98794 6.6157,5.6345 6.125,10.71875 a 1.4420115,1.4420115 0 0 1 -0.062,0.28125 c -0.5618,1.89409 -1.746,3.32797 -3.1876,4.25 -1.4415,0.92203 -3.0867,1.39395 -4.7812,1.65625 -3.3889,0.5246 -7.0334,0.23046 -9.4062,0.34375 -7.4077,0.32104 -14.726,-2.60314 -20.7813,-1.09375 -0.9228,0.69289 -1.3969,1.4625 -1.5625,2.3125 -0.1806,0.92739 -0.017,2.01851 0.4688,3.125 0.9708,2.21298 3.281,4.32492 5.3437,4.90625 a 1.4420115,1.4420115 0 0 1 0.062,0 c 11.2515,3.73156 24.1465,2.93253 35.9062,0.5 7.7821,-1.63499 12.8466,-8.87337 12.875,-16.71875 a 1.4420115,1.4420115 0 0 1 0,-0.0937 c 0.2634,-4.15469 0.2008,-8.71518 -0.9374,-12.5625 -1.1383,-3.84732 -3.227,-6.9152 -7.2813,-8.625 a 1.4420115,1.4420115 0 0 1 -0.1563,-0.0937 c -7.233,-4.1955 -16.6908,-2.33856 -25.375,-4.5 a 1.4420115,1.4420115 0 0 1 -0.375,-0.15625 c -7.593,-4.38022 -5.364,-17.27483 3.5,-18.15625 l 0,-0.0312 c 0.1153,-0.0364 0.2288,-0.0291 0.3438,-0.0625 4.5012,-1.3064 8.8395,-0.37995 12.875,0.59375 4.0804,0.98454 7.88,1.92841 11.4688,1.1875 5.4755,-2.31046 4.4951,-10.8333 -1.1876,-12.40625 a 1.4420115,1.4420115 0 0 1 -0.2812,-0.0937 c -6.5535,-3.28332 -14.4405,-2.57842 -22.1875,-2.625 -0.021,-1.3e-4 -0.042,1.4e-4 -0.062,0 z" />
360 <path
361 style="color:#000000;fill:url(#linearGradient6079);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
362 d="m 334.91414,52.45217 -0.5624,0.0312 c -10.692,0.64182 -26.7608,2.35866 -35.4063,16.28126 l -0.375,0.59375 -0.2813,0.625 c -2.6168,5.92672 -0.4865,12.63582 3.8126,16.24999 2.47,2.0766 6.1544,2.97511 9.8124,2.75 -12.1731,7.16212 -18.9579,21.29295 -17.0937,35.5 -0.9321,10.0329 5.7963,19.42583 15.4375,21.90625 l 0,0.0312 c 13.5839,4.67628 27.0449,3.11875 38.7812,0.90625 1.4491,0.98507 3.2876,2.06677 5.5626,3 2.2748,0.93323 5.2583,1.74964 8.75,1.34375 3.4915,-0.40589 7.1195,-2.30283 9.625,-4.875 l 0.375,-0.34375 0.3124,-0.40625 c 5.3642,-6.74967 5.6479,-14.75709 5.2188,-20.5625 -0.4291,-5.80541 -1.211,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.75 c -0.9297,-14.08097 -0.732,-30.77734 -7.9062,-46.62499 -0.4593,-1.65783 -1.3753,-2.43205 -2.625,-3.4999 -10.8288,-9.19166 -23.8588,-8.03267 -31.8438,-8.50001 l -0.5938,-0.0312 z m 22.0626,47.46875 c 0.2983,4.01025 0.663,7.89337 0.9374,12.09375 -0.3619,6.15055 0.7536,11.18085 1.0313,14.9375 0.091,1.23358 -3e-4,1.89681 -0.031,2.71875 -0.7261,-0.49389 -0.8804,-0.56988 -1.7812,-1.1875 l -3.5,-2.40625 -4.1562,0.84375 c -11.8502,2.42474 -23.4896,3.77093 -32.7188,0.59375 l -0.75,-0.25 -0.8125,-0.15625 c -0.7563,-0.12889 -0.7437,-0.008 -0.5937,-0.75 l 0.375,-1.875 -0.3438,-1.875 c -1.3223,-7.37497 4.0726,-16.31882 11.1562,-18.03125 l 0.5626,-0.15625 0.5312,-0.1875 c 1.5591,-0.56829 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.48444 15.6563,0.0312 l 1.4687,-0.34375 1.3125,-0.75 c 1.5458,-0.8862 2.8481,-1.95265 3.9688,-3.125 z"
363 id="path6019" />
364 <path
365 style="fill:#484848;fill-opacity:1;stroke:none"
366 id="path6021"
367 d="m 442.8461,65.50261 c -9.9417,-0.25223 -20.0112,1.83054 -27.125,8.78125 a 1.4249747,1.4249747 0 0 1 -0.1876,0.125 c -0.4923,0.34955 -1.0141,0.64308 -1.6874,0.65625 -0.6734,0.0132 -1.3402,-0.39879 -1.6876,-0.8125 -0.6947,-0.82743 -0.7686,-1.5945 -0.9687,-2.34375 -0.2001,-0.74925 -0.4246,-1.47139 -0.6563,-1.84375 -0.2316,-0.37236 -0.2624,-0.39819 -0.6874,-0.40625 a 1.4249747,1.4249747 0 0 1 -0.6563,-0.1875 c -2.1511,-1.16691 -4.3134,-0.58174 -5.9063,0.90625 -1.5928,1.48799 -2.4145,3.81205 -1.5937,6.125 a 1.4249747,1.4249747 0 0 1 0.094,0.46875 c 0.099,20.08519 -1.9054,40.73856 3.75,59.71875 1.2377,1.74956 4.0539,2.66609 6.4063,2.28125 1.2075,-0.19755 2.2216,-0.71247 2.8437,-1.40625 0.6222,-0.69378 0.9615,-1.54589 0.75,-2.96875 a 1.4249747,1.4249747 0 0 1 0,-0.375 c 1.5091,-15.16756 -3.1254,-31.94343 3.25,-47.28125 a 1.4249747,1.4249747 0 0 1 0.031,-0.0625 c 2.3884,-4.77662 7.2847,-8.50018 12.5937,-10.03125 5.3091,-1.53107 11.2689,-0.75156 15.1563,3.84375 a 1.4249747,1.4249747 0 0 1 0.1563,0.1875 c 2.0694,3.60071 1.6918,8.0153 1.9687,11.75 0.1385,1.86735 0.4194,3.54061 1.0313,4.875 0.5916,1.2904 1.4751,2.25734 3.0312,3 1.4606,0.20734 2.5297,-0.051 3.4375,-0.6875 0.9587,-0.67214 1.771,-1.81376 2.375,-3.21875 1.2079,-2.80999 1.508,-6.6831 1.1563,-9.25 -1.6601,-6.82503 -2.269,-14.23556 -6.2813,-19.1875 -2.6943,-2.32961 -6.6692,-2.77567 -10.5313,-2.65625 a 1.4249747,1.4249747 0 0 1 -0.062,0 z" />
368 <path
369 style="color:#000000;fill:url(#linearGradient6081);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
370 d="m 548.52594,68.07721 -1.2187,0.25 c -8.6956,1.82574 -14.1425,9.53796 -15.9688,15.68749 -1.8263,6.14954 -1.7462,11.84707 -1.8125,15.71875 l 0,0.125 0,0.125 c 0.1092,10.79916 -0.5536,24.0134 4.9063,37 0.01,0.0225 0.022,0.0401 0.031,0.0625 2.7726,6.62078 9.3817,9.9621 15.5625,9.5625 5.6001,-0.36206 11.8353,-5.2195 13.5,-11.53125 5.3924,-17.21633 5.3013,-35.62075 1.75,-52.53125 l -0.1563,-0.6875 -0.2187,-0.62499 c -0.7814,-2.19128 -1.853,-4.62969 -3.9375,-7.1875 -2.0845,-2.55781 -5.8401,-5.71667 -11.1875,-5.9375 l -1.25,-0.0312 z"
371 id="path6023" />
372 <path
373 style="fill:#484848;fill-opacity:1;stroke:none"
374 id="path6025"
375 d="m 550.1139,78.59636 c -4.5226,0.97522 -6.7823,4.26272 -8,8.375 -1.2232,4.13111 -1.3087,9.03503 -1.375,12.90625 0.1123,11.09592 -0.2043,22.90976 4.0938,33.09375 0.9213,2.22841 3.1731,3.32073 5.25,3.1875 2.0769,-0.13323 3.906,-1.39 4.1562,-4.09375 a 0.46475483,0.46475483 0 0 1 0.031,-0.0937 c 4.7332,-15.11164 4.7084,-31.85462 1.4687,-47.28125 -0.4788,-1.32581 -1.2248,-2.85305 -2.1874,-4.03125 -0.9629,-1.17844 -2.1146,-1.98485 -3.4376,-2.0625 z" />
376 <path
377 style="color:#000000;fill:url(#linearGradient6083);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
378 d="m 242.87094,52.92092 -0.5938,0.0312 c -10.6919,0.64192 -26.7607,2.35873 -35.4062,16.28131 l -0.375,0.59375 -0.2813,0.65625 c -2.6168,5.92671 -0.4864,12.60456 3.8125,16.21874 2.4771,2.0825 6.1757,2.98309 9.8438,2.75 -12.176,7.14722 -18.9659,21.26849 -17.125,35.46875 -0.9665,10.0609 5.7999,19.48906 15.4687,21.96875 l -0.031,0.0312 c 13.5891,4.67806 27.073,3.12012 38.8125,0.90625 1.4445,0.97996 3.2715,2.07302 5.5313,3 2.2749,0.93323 5.2585,1.71839 8.75,1.3125 3.4915,-0.40589 7.1509,-2.27156 9.6562,-4.84375 l 0.3438,-0.375 0.3125,-0.40625 c 5.3641,-6.74969 5.6478,-14.72585 5.2187,-20.53125 -0.4291,-5.8054 -1.2109,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.78125 c -0.9297,-14.081 -0.7006,-30.74608 -7.875,-46.59374 l -0.9375,-2.0625 -1.7187,-1.4375 c -10.8287,-9.19167 -23.8276,-8.06392 -31.8125,-8.53126 l -0.5938,-0.0312 z m 22.0312,47.5 c 0.2974,4.00059 0.6637,7.87292 0.9375,12.0625 -0.3619,6.15055 0.7536,11.2121 1.0313,14.96875 0.091,1.22812 0,1.86766 -0.031,2.6875 -0.7261,-0.49388 -0.8805,-0.56989 -1.7813,-1.1875 l -3.5,-2.40625 -4.1562,0.875 c -11.8502,2.42475 -23.4582,3.77094 -32.6875,0.59375 l -0.7813,-0.28125 -0.8125,-0.125 c -0.7563,-0.12888 -0.7437,-0.0396 -0.5938,-0.78125 l 0.375,-1.84375 -0.3437,-1.875 c -1.3223,-7.37494 4.0726,-16.35008 11.1562,-18.0625 l 0.5625,-0.125 0.5313,-0.1875 c 1.5591,-0.56828 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.45313 15.6562,0 l 1.4688,-0.3125 1.3125,-0.75 c 1.5458,-0.8862 2.8482,-1.95265 3.9687,-3.125 z"
379 id="path6027" />
380 <path
381 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
382 id="path6029"
383 d="m 243.6361,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" />
384 <path
385 style="color:#000000;fill:url(#linearGradient6085);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
386 id="path6031"
387 d="m 252.9376,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" />
388 <path
389 style="color:#000000;fill:#305f00;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:10"
390 d="m 550.24144,11.97714 c -4.7431,8e-5 -9.3884,1.94508 -12.1562,5.65625 -2.3938,3.20927 -3.2655,7.28209 -3.5,11.84374 -5.2417,0.10768 -9.658,0.71067 -13.2813,2.53125 -3.7519,1.88519 -6.5576,5.75636 -6.9063,9.9375 l -0.062,0 c -0.013,0.1027 0.011,0.20947 0,0.3125 0,0.043 -0.03,0.0819 -0.031,0.125 l 0.031,0 c -0.383,3.94189 0.8037,8.08581 3.625,10.84375 1.7434,1.70445 3.9242,2.79035 6.3124,3.59375 l -0.875,2.4375 -0.062,0.125 -0.031,0.125 c -1.0239,3.32791 -0.9882,7.09444 0.8437,10.15625 1.8322,3.06181 4.9132,4.85334 8.3438,5.90625 l 0.7188,0.21875 0.75,0 2.2812,0 c 4.1038,5e-5 8.0184,-1.11288 11.1562,-3.5 1.388,-1.05587 2.5677,-2.38102 3.5938,-3.8125 2.738,2.5559 6.0541,4.80834 10,6.78125 l 0.5,0.25 0.5312,0.15625 c 3.235,0.79227 6.3972,0.95306 9.4063,-0.1875 2.9956,-1.13542 5.3523,-3.78973 6.4375,-6.71875 l 0.031,0 0,-0.0312 c 1.3188,-3.58119 1.0754,-7.65809 -0.4687,-11.1875 -0.3593,-0.82136 -0.9637,-1.56048 -1.4375,-2.34375 0.7988,-0.35352 1.5774,-0.75006 2.3125,-1.28125 3.1456,-2.2731 4.4669,-6.43958 4.1563,-10.25 l 0.031,0 c 0,-0.12851 -0.061,-0.24691 -0.062,-0.375 -0.017,-0.15367 0.023,-0.31671 0,-0.46875 l -0.062,0 c -0.2506,-3.85862 -2.6242,-7.47641 -5.875,-9.5625 -3.1968,-2.05143 -7.2278,-3.19745 -12.0625,-4.03124 -0.5947,-4.02941 -1.4462,-7.64148 -3.125,-10.53125 -2.2702,-3.9078 -6.5646,-6.71865 -11.0625,-6.71875 z m 18.3125,50.62499 c 0.2654,0.97712 0.2969,1.7705 -0.031,2.65625 l 0,0.0312 c -0.3181,0.86918 -0.3036,0.72198 -0.625,0.84375 -0.2585,0.098 -1.2073,0.14918 -2.5624,-0.0625 0.3313,-0.1475 0.7366,-0.14338 1.0312,-0.34375 l 0.4375,-0.28125 0.375,-0.40625 c 0.5814,-0.62017 0.9776,-1.55372 1.375,-2.4375 z"
391 id="path6033" />
392 <g
393 id="text6035"
394 style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:165.01513672px;line-height:125%;font-family:'comic andy';-inkscape-font-specification:'comic andy';letter-spacing:0px;word-spacing:0px;fill:url(#linearGradient4437);fill-opacity:1;stroke:none">
395 <path
396 id="path98"
397 style="fill:url(#linearGradient6087);fill-opacity:1"
398 d="m 550.24549,16.984496 q 8.54083,0 9.83001,16.920498 l 2.33664,0 q 15.22844,2.33664 15.0673,9.668855 1.28918,8.621397 -11.03861,7.976806 9.42713,8.299101 6.7682,15.470169 -2.09492,5.72074 -9.99116,3.786969 -8.70197,-4.350985 -12.32779,-9.991151 l -1.5309,0 q -3.3841,9.991151 -13.13353,9.991151 l -2.25606,0 q -8.13796,-2.497788 -5.88189,-9.830003 l 2.82008,-7.815659 -0.80574,0 q -11.92492,-1.692049 -10.79688,-10.555167 0.32229,-8.137954 16.35648,-8.218527 4.43155,-0.483443 3.70639,-2.820083 0,-14.583858 10.87746,-14.583858 z m -4.5927,16.034186 -0.16115,4.512133 q -0.24172,3.384099 -2.17549,3.384099 l -12.73066,0.725164 q -2.98123,0.08057 -2.98123,2.417214 0,2.256067 3.22295,2.417214 11.19976,-0.564016 10.47459,1.530902 l -2.25606,4.834428 q -5.72074,8.621396 -2.82009,10.152299 3.86754,2.33664 10.95804,-12.08607 1.69205,-1.530902 2.82008,0 4.99558,5.317871 8.21853,8.70197 3.30353,3.3841 5.31787,2.014345 2.41721,-2.578361 -1.28918,-5.559592 -3.62582,-3.061804 -8.2991,-8.379675 -0.48344,-1.772623 0.24172,-1.772623 15.79246,1.047459 15.14787,-2.014345 0.48345,-3.3841 -13.69754,-3.3841 -2.17549,0.402869 -3.54525,-1.047459 l 0,-7.896232 q 0,-6.607052 -3.14238,-6.526478 -3.3841,-0.805738 -3.30352,7.976806 z" />
399 </g>
400 <path
401 d="m 335.7911,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z"
402 id="path6039"
403 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
404 <path
405 d="m 345.6192,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z"
406 id="path6041"
407 style="color:#000000;fill:url(#linearGradient6089);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
408 </g>
409 <g
410 id="g5958">
411 <path
412 id="path4188"
413 d="m 549.36434,78.11349 c -9.4946,1.99352 -9.7027,14.03504 -9.8352,21.77668 0.1121,11.0831 -0.2095,22.9628 4.1417,33.27264 2.0054,4.85047 9.7812,4.74809 10.3195,-1.06753 4.7624,-15.20498 4.7481,-32.01281 1.4946,-47.50541 -0.983,-2.75668 -3.069,-6.35036 -6.1206,-6.47638 z"
414 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
415 <path
416 id="path4190"
417 d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z"
418 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
419 <path
420 id="path4192"
421 d="m 132.42293,35.23407 c -7.6945,2.17125 -5.9206,12.79289 -6.2273,19.00216 1.6106,23.24538 0.8475,46.57408 2.1706,69.81693 0.068,7.09423 3.2021,16.90233 11.8853,16.22657 7.5709,-1.76417 5.7778,-11.8325 5.6557,-17.71589 -0.047,-7.84014 -4.5559,-19.23884 3.9165,-24.30949 7.6405,-5.37547 19.848,0.64078 18.6463,10.39069 -0.3251,8.83089 -2.0837,22.16882 7.8287,26.47493 6.4024,2.92649 10.6176,-5.21693 9.3943,-10.71096 -0.3749,-13.55442 1.2727,-30.22607 -10.711,-39.6768 -7.9735,-4.05845 -18.9828,-5.54515 -26.8307,-0.21351 -1.0372,2.42576 -6.9951,6.95054 -6.4053,1.24546 -1.6949,-15.3749 2.056,-31.45755 -2.3485,-46.40228 -1.2024,-2.63946 -4.0324,-4.45898 -6.9746,-4.12781 z"
422 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
423 <path
424 id="path4194"
425 d="m 442.14024,64.05759 c -10.165,-0.2579 -20.6562,1.86137 -28.1474,9.18081 -2.8958,2.05591 -1.2663,-4.94966 -4.8395,-5.01742 -5.4074,-2.93338 -11.5829,2.98762 -9.5367,8.75381 0.099,20.06919 -1.977,40.97889 3.8787,60.387 3.1796,4.95849 13.7562,4.09337 12.7037,-2.9891 1.546,-15.53942 -2.968,-32.10549 3.167,-46.86488 4.3319,-8.66318 18.41,-14.13659 25.3718,-5.90704 3.521,6.12624 -0.9752,16.78774 6.8323,20.31879 7.6504,1.3481 9.6041,-9.08157 8.825,-14.7676 -1.6539,-6.72434 -2.1565,-14.5353 -6.6544,-19.99852 -3.1376,-2.78799 -7.564,-3.22067 -11.6005,-3.09585 z"
426 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
427 <path
428 id="path4196"
429 d="m 442.38294,54.04595 c -0.1827,-0.005 -0.3789,0.0345 -0.5625,0.0312 -8.6942,-0.15632 -18.301,1.16995 -26.7813,5.96876 -0.368,-0.21564 -0.7676,-0.37654 -1.1562,-0.5625 l 0.031,-0.0625 c -0.2019,-0.10958 -0.4204,-0.1194 -0.625,-0.21875 -0.5569,-0.23563 -1.1103,-0.37966 -1.6874,-0.53125 -6.0741,-2.10894 -12.7994,-0.4336 -16.8438,3.34375 -3.8577,3.60298 -6.0063,9.29062 -5.1562,15.125 0.085,19.31578 -2.292,41.23535 4.3124,63.12499 l 0.4063,1.3125 0.75,1.1875 c 4.4521,6.94297 11.5862,8.53059 18,7.46875 3.2069,-0.53092 6.701,-1.89897 9.5,-5.03125 2.2725,-2.54317 3.5121,-6.27514 3.5937,-9.84375 0,-0.0435 0,-0.0816 0,-0.125 1.7478,-17.81793 -1.8544,-32.72457 2.2813,-43.375 0.6976,-1.23208 3.1856,-3.39065 5.4063,-4.03125 1.1119,-0.32077 1.7363,-0.44325 2.1874,-0.40625 0.051,0.8996 0.2789,2.71568 0.5313,6.0625 0.1821,2.41445 0.4732,5.42185 2.0313,8.8125 1.558,3.39065 4.8419,6.94014 8.8437,8.75 l 1.1563,0.5 1.2187,0.21875 c 4.1545,0.73208 8.9361,-0.28467 12.2187,-2.59375 3.2827,-2.30908 5.1358,-5.31163 6.3126,-8.0625 2.3534,-5.50175 2.5912,-10.54096 1.9374,-15.3125 l -0.062,-0.53125 -0.125,-0.5 c -1.3372,-5.43656 -1.418,-15.17693 -8.6563,-23.96874 l -0.4687,-0.59375 -0.5938,-0.53125 c -6.0316,-5.35952 -13.0425,-5.71213 -18,-5.59376 l 0,-0.0312 z m -20.9688,14.62501 c 0.3103,0.61975 0.1924,0.76755 0.063,0.28125 -0.016,-0.0599 -0.046,-0.21107 -0.063,-0.28125 z m -11.8437,14.15624 c 0.271,0.10418 0.5347,0.22752 0.8125,0.3125 l -0.125,0.21875 -0.125,0.3125 c -0.2313,0.55649 -0.3535,1.10135 -0.5625,1.65625 0.01,-0.84699 -0.01,-1.64903 0,-2.5 z"
430 style="color:#000000;fill:url(#linearGradient4453);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
431 <path
432 id="path4198"
433 d="m 334.93614,43.42895 -1.125,0.0625 c -11.4541,0.68757 -31.1299,2.13948 -42.5313,20.5 l -0.6875,1.15625 -0.5312,1.21875 c -4.0155,9.09454 -1.1737,19.34928 5,25.5 -7.1006,9.03999 -10.5361,20.69833 -9.25,32.65625 -0.7932,13.71238 8.5163,26.58972 21.5624,30.34375 l -0.031,0.0625 c 14.5936,5.02387 28.3345,3.89176 40,1.875 1.1383,0.61027 2.377,1.24208 3.8438,1.84375 3.1932,1.30991 7.6804,2.60895 13.1874,1.96875 5.5071,-0.6402 11.3463,-3.71585 15.0626,-7.53125 l 0.6562,-0.6875 0.5938,-0.75 c 7.375,-9.27994 7.6766,-20.19393 7.1874,-26.8125 -0.4891,-6.61857 -1.0653,-10.99648 -1.0312,-11.375 l 0.125,-1.46875 -0.094,-1.5 c -0.9045,-13.69999 -0.4438,-31.50909 -8.6874,-49.71875 -0.8869,-3.14352 -2.6183,-4.60975 -5,-6.625 -14.193,-12.04738 -29.8012,-10.22761 -37.125,-10.65625 z m -5,69.25 c -0.6975,0.25422 -0.096,-0.059 3.5937,0.375 3.1757,0.3735 8.4922,1.29071 15.3437,0.34375 -0.042,1.60674 -0.047,3.10046 0.031,4.46875 l -1.2187,0.25 c -9.4296,1.92946 -17.7526,2.70557 -24.0626,1.71875 0.3089,-2.61777 2.5558,-6.11412 4.2813,-6.53125 l 1.0313,-0.25 1,-0.375 z"
434 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:38" />
435 <path
436 style="color:#000000;fill:#484848;fill-opacity:1;fill-rule:nonzero;stroke:#484848;stroke-width:38;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
437 d="m 242.86794,62.94328 c -9.8451,0.59098 -21.9234,2.57343 -27.5069,11.56498 -1.5225,3.44827 2.5155,7.16458 5.8003,4.55483 11.6876,-3.18405 25.8772,-8.64334 36.9368,-1.03196 3.4255,4.6575 3.2712,13.73214 -2.1351,16.8315 -8.1137,1.83399 -16.456,-2.50178 -24.589,0.4626 -12.7407,3.08001 -20.924,16.83116 -18.6463,29.53519 -1.221,6.03853 2.7535,11.58045 8.7182,12.59694 12.2603,4.22059 25.7141,2.25842 37.9688,-0.24909 3.9671,2.72001 9.7011,7.85911 14.3406,3.09585 6.2596,-7.87653 1.273,-19.02318 2.088,-28.06851 -0.9577,-14.50429 -1.0481,-29.91302 -7.0343,-43.1362 -7.0905,-6.01862 -17.2216,-5.6458 -25.9411,-6.15613 z"
438 id="path4200" />
439 <path
440 id="path4202"
441 d="m 132.71733,24.19589 c -0.5004,0.0152 -1.0205,0.0363 -1.5312,0.0937 l -0.9063,0.0937 -0.8437,0.25 c -4.2861,1.20943 -8.1936,4.24904 -10.375,7.56249 -2.1816,3.31346 -2.9841,6.56659 -3.4063,9.375 -0.8444,5.61682 -0.3823,10.37282 -0.4687,12.125 l -0.031,0.65625 0.062,0.625 c 1.548,22.34205 0.8033,45.46456 2.125,69.1875 5e-4,0.0505 0.031,0.10568 0.031,0.15625 0.01,0.1151 -0.01,0.22862 0,0.34375 l 0.031,0 c 0.099,4.98929 0.9665,10.43113 4.125,15.90625 3.2605,5.65198 11.0145,11.32149 19.5625,10.65625 l 0.8438,-0.0625 0.8124,-0.1875 c 4.2384,-0.98762 8.3269,-3.79564 10.625,-7.09375 2.1728,-3.63384 4.3342,-6.89183 5.1872,-10.22818 3.8402,7.13335 5.9507,8.04619 13.1566,11.44693 l 0,0.0312 c 0.059,0.0269 0.1281,0.0362 0.1875,0.0625 3.7423,1.65403 8.4312,1.97661 12.2813,0.65625 3.91101,-1.34132 6.71761,-3.90092 8.59371,-6.5 3.336,-4.62154 4.6441,-9.64143 3.9063,-15.25 -0.1718,-6.20746 0.2238,-14.23226 -1.1563,-22.8125 -1.3801,-8.58024 -5.0962,-18.36284 -13.75001,-25.1875 l -0.8437,-0.6875 -0.9688,-0.5 c -7.7653,-3.95251 -17.7087,-6.355 -27.4062,-4.09375 0.4086,-10.28331 1.089,-21.96033 -2.625,-34.5625 l -0.2188,-0.75 -0.3125,-0.71875 c -2.9167,-6.40275 -9.181,-10.82231 -16.6875,-10.59374 z m 6.0625,53.99999 c 0,0.0101 0.05,0.0315 0.062,0.0625 l -0.6245,1.46875 c 0.3311,-0.86163 0.5542,-1.56647 0.5625,-1.53125 z m 36.0625,48.28125 c 0.012,-0.004 0.019,0.005 0.031,0 l 0.063,0.3125 c -0.043,-0.19086 -0.061,-0.25465 -0.094,-0.3125 z"
442 style="color:#000000;fill:url(#linearGradient4451);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
443 <path
444 d="m 133.3461,36.09636 c -1.692,0.49428 -2.8155,1.39846 -3.625,2.625 -0.8214,1.24442 -1.3243,2.85069 -1.5938,4.625 -0.5342,3.51732 -0.1953,7.61208 -0.3438,10.8125 0,0.0285 0,0.0654 0,0.0937 1.6063,23.27388 0.8692,46.5905 2.1876,69.75 a 0.88388823,0.88388823 0 0 1 0,0.0625 c 0.033,3.4213 0.83,7.53419 2.5937,10.59375 1.7438,3.02495 4.2922,5.00636 8.2187,4.75 0.011,-7.3e-4 0.02,7.7e-4 0.031,0 1.6857,-0.39978 2.7542,-1.19719 3.5313,-2.3125 0.7819,-1.12237 1.2391,-2.59827 1.4687,-4.25 0.4593,-3.30346 2e-4,-7.22907 -0.062,-10.25 a 0.88388823,0.88388823 0 0 1 0,-0.0312 c -0.023,-3.75401 -1.179,-8.58343 -1.25,-13.1875 -0.071,-4.59014 1.0512,-9.12033 5.5625,-11.84375 0.012,-0.008 0.019,-0.023 0.031,-0.0312 8.2411,-5.75335 21.2001,0.72746 19.9687,11.1875 0,0.011 0,0.0202 0,0.0312 -4e-4,0.01 4e-4,0.0216 0,0.0312 -0.1662,4.44678 -0.6416,9.92071 0.094,14.71875 0.7386,4.81878 2.5857,8.83105 7.2188,10.84375 a 0.88388823,0.88388823 0 0 1 0.031,0 c 1.4264,0.65196 2.625,0.67804 3.6876,0.3125 1.0625,-0.36554 2.0152,-1.15367 2.7812,-2.21875 1.532,-2.13016 2.2012,-5.36524 1.6562,-7.8125 a 0.88388823,0.88388823 0 0 1 0,-0.15625 c -0.1887,-6.82351 0.1073,-14.35845 -1,-21.28125 -1.1026,-6.89383 -3.5864,-13.13587 -9.3124,-17.6875 -7.7294,-3.90433 -18.3437,-5.25802 -25.7813,-0.25 -0.7734,1.48479 -2.3237,3.00623 -4,3.78125 -0.9043,0.41808 -1.982,0.65336 -2.875,0.0312 -0.8519,-0.59346 -1.0866,-1.72753 -0.9687,-3.1875 0.01,-0.0705 -0.01,-0.11538 0,-0.1875 -1.6634,-15.48034 1.9617,-31.38045 -2.2813,-45.9375 -1.0363,-2.2749 -3.4784,-3.85945 -5.9687,-3.625 z"
445 id="path4440"
446 style="fill:#484848;fill-opacity:1;stroke:none" />
447 <path
448 id="path4206"
449 d="m 500.00794,37.6397 c -0.47,-0.0246 -0.9099,0.13839 -1.375,0.15625 -0.3182,0.036 -0.6564,-0.0583 -0.9688,0 l 0,0.0937 c -5.9486,0.59666 -11.3199,4.27914 -13.8124,8.625 -2.5191,4.39212 -3.1643,9.07388 -2.4688,13.75001 -0.5691,24.07161 -0.3288,48.17845 0.031,71.96874 l 0.031,1.1875 0.2813,1.125 c 2.2758,9.05358 10.1204,12.94327 17.2812,13.3125 3.5804,0.18461 7.6057,-0.50128 11.25,-3.21875 3.4431,-2.56742 5.753,-7.21537 6.0625,-11.6875 l 0.062,0 c 0.024,-0.26477 0.01,-0.51719 0.031,-0.78125 1.2169,-14.32127 -0.1813,-27.63851 0.6563,-39.5625 0.8412,-12.28307 -0.4559,-23.97948 -0.6563,-34.18749 0.9168,-4.19732 0.7514,-8.64033 -1.75,-13.09376 -2.5398,-4.52202 -8.6787,-7.57722 -14.4374,-7.5625 -0.073,1.9e-4 -0.1457,-0.001 -0.2188,0 l 0,-0.125 z m -0.4375,10.46875 1.5625,8.375 c -0.089,0.0884 -0.5399,0.26586 -0.9688,0.50001 -0.4433,-0.17558 -0.588,-0.31717 -1.125,-0.59376 l 0.5313,-8.28125 z m 1.625,8.6875 0.125,0.65626 c 0,-5.2e-4 -0.146,-0.0578 -0.1563,-0.0625 0.013,-0.26164 0.01,-0.41632 0.031,-0.59376 z"
450 style="color:#000000;fill:url(#linearGradient4449);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
451 <path
452 id="path4208"
453 d="m 499.48944,47.6175 c -6.4927,-0.34021 -9.3439,6.60543 -8.1121,12.16941 -0.5858,24.07597 -0.3292,48.31194 0.034,72.30837 1.7508,6.96484 14.895,8.48808 15.0166,-0.0712 1.2169,-13.27189 -0.274,-26.75029 0.6639,-40.10232 0.7817,-11.41478 -0.5568,-23.24296 -0.6994,-34.37618 1.5849,-5.10643 -0.4706,-11.12871 -6.9034,-9.92811 z"
454 style="fill:#484848;fill-opacity:1;stroke:none" />
455 <path
456 id="path4210"
457 d="m 544.51954,53.6313 c -7.5784,-0.46784 -10.6755,10.08558 -4.626,14.19825 6.4831,5.13984 16.9776,-2.57743 12.9884,-10.24836 -1.4384,-3.20261 -5.1136,-4.25984 -8.3624,-3.94989 z"
458 style="fill:#000000;fill-opacity:1;stroke:none" />
459 <path
460 id="path4212"
461 d="m 66.312222,57.93009 c -17.370703,0.62829 -30.0641,20.09681 -26.023403,36.39781 2.1928,10.05075 13.8541,12.09708 22.635103,11.4922 7.1377,-0.5151 17.6041,2.45346 16.7319,11.49222 -1.8676,6.29718 -10.9897,4.97438 -16.0667,5.21679 -7.019003,0.3042 -14.551803,-2.83467 -21.309203,-1.0251 -5.546297,3.71601 -0.7698,11.63178 4.4362,13.09902 11.6204,3.85396 24.776703,2.98561 36.677203,0.52396 8.494404,-1.78465 13.976704,-9.66183 14.007304,-18.12905 0.5362,-8.45978 -0.1252,-18.85777 -9.082,-22.63511 -7.833304,-4.5437 -17.524404,-2.59996 -25.744004,-4.64578 -6.504303,-3.75215 -4.590203,-15.08325 3.2137,-15.54417 8.376,-2.645 16.5844,3.54335 24.730904,1.74653 6.8027,-2.75685 5.6777,-13.26551 -1.2924,-15.19486 C 82.177322,57.19274 73.972122,57.9802 66.312222,57.93009 Z"
462 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:38;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
463 <path
464 id="path4214"
465 d="m 66.146122,46.92095 -0.2187,0.0312 c -25.268203,0.91394 -41.9786,26.29641 -36.375,49.71875 0,0.01 0,0.0214 0,0.0312 0.023,0.0937 0.039,0.18758 0.062,0.28125 l 0.062,0 c 1.4158,6.03031 5.2241,10.72981 9.5937,13.9375 l -1.5937,0.4375 -1.5313,1 c -3.4934,2.34058 -6.2461,6.40677 -7.0312,10.4375 -0.7852,4.03073 0.016,7.64447 1.2812,10.53125 2.4625,5.61698 6.4364,9.72109 12.843797,11.6875 l 0,0.0312 c 0.1235,0.0409 0.2514,0.0537 0.375,0.0937 0.044,0.0142 0.081,0.0484 0.125,0.0625 14.2876,4.59699 29.052403,3.33987 41.875007,0.6875 l 0.031,0 c 13.703,-2.87897 22.354804,-15.23519 22.687504,-28.1875 l 0.031,0 c 0.01,-0.1043 -0.01,-0.23849 0,-0.34375 0,-0.10511 0.031,-0.20733 0.031,-0.3125 l -0.031,0 c 0.275,-4.68022 0.3633,-10.21921 -1.4063,-16.21875 -1.6128,-5.46789 -5.6186,-11.40935 -11.718704,-15.03125 C 110.28983,79.05558 108.57813,56.15757 93.550926,50.6395 83.076822,45.62854 73.121622,46.96476 66.394622,46.92075 l -0.25,0 z M 49.927419,124.0772 c 0.4736,0.11312 0.7429,0.17483 0.6875,0.1875 -0.1379,-0.0437 -0.3009,-0.0484 -0.4375,-0.0937 l -0.25,-0.0937 z"
466 style="color:#000000;fill:url(#linearGradient4447);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
467 <path
468 d="M 67.047,59.37761 C 50.7565,60.01346 38.6203,78.63489 42.422,93.97136 a 1.4420115,1.4420115 0 0 1 0,0.0312 c 0.9874,4.52574 3.9833,7.14275 7.9688,8.71875 3.9854,1.576 8.921,1.948 13.1562,1.65625 3.8182,-0.27555 8.4163,0.35581 12.1562,2.34375 3.74,1.98794 6.6157,5.6345 6.125,10.71875 a 1.4420115,1.4420115 0 0 1 -0.062,0.28125 c -0.5618,1.89409 -1.746,3.32797 -3.1876,4.25 -1.4415,0.92203 -3.0867,1.39395 -4.7812,1.65625 -3.3889,0.5246 -7.0334,0.23046 -9.4062,0.34375 -7.4077,0.32104 -14.726,-2.60314 -20.7813,-1.09375 -0.9228,0.69289 -1.3969,1.4625 -1.5625,2.3125 -0.1806,0.92739 -0.017,2.01851 0.4688,3.125 0.9708,2.21298 3.281,4.32492 5.3437,4.90625 a 1.4420115,1.4420115 0 0 1 0.062,0 c 11.2515,3.73156 24.1465,2.93253 35.9062,0.5 7.7821,-1.63499 12.8466,-8.87337 12.875,-16.71875 a 1.4420115,1.4420115 0 0 1 0,-0.0937 c 0.2634,-4.15469 0.2008,-8.71518 -0.9374,-12.5625 -1.1383,-3.84732 -3.227,-6.9152 -7.2813,-8.625 a 1.4420115,1.4420115 0 0 1 -0.1563,-0.0937 c -7.233,-4.1955 -16.6908,-2.33856 -25.375,-4.5 a 1.4420115,1.4420115 0 0 1 -0.375,-0.15625 c -7.593,-4.38022 -5.364,-17.27483 3.5,-18.15625 l 0,-0.0312 c 0.1153,-0.0364 0.2288,-0.0291 0.3438,-0.0625 4.5012,-1.3064 8.8395,-0.37995 12.875,0.59375 4.0804,0.98454 7.88,1.92841 11.4688,1.1875 5.4755,-2.31046 4.4951,-10.8333 -1.1876,-12.40625 a 1.4420115,1.4420115 0 0 1 -0.2812,-0.0937 c -6.5535,-3.28332 -14.4405,-2.57842 -22.1875,-2.625 -0.021,-1.3e-4 -0.042,1.4e-4 -0.062,0 z"
469 id="path4442"
470 style="fill:#484848;fill-opacity:1;stroke:none" />
471 <path
472 id="path4218"
473 d="m 334.91414,52.45217 -0.5624,0.0312 c -10.692,0.64182 -26.7608,2.35866 -35.4063,16.28126 l -0.375,0.59375 -0.2813,0.625 c -2.6168,5.92672 -0.4865,12.63582 3.8126,16.24999 2.47,2.0766 6.1544,2.97511 9.8124,2.75 -12.1731,7.16212 -18.9579,21.29295 -17.0937,35.5 -0.9321,10.0329 5.7963,19.42583 15.4375,21.90625 l 0,0.0312 c 13.5839,4.67628 27.0449,3.11875 38.7812,0.90625 1.4491,0.98507 3.2876,2.06677 5.5626,3 2.2748,0.93323 5.2583,1.74964 8.75,1.34375 3.4915,-0.40589 7.1195,-2.30283 9.625,-4.875 l 0.375,-0.34375 0.3124,-0.40625 c 5.3642,-6.74967 5.6479,-14.75709 5.2188,-20.5625 -0.4291,-5.80541 -1.211,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.75 c -0.9297,-14.08097 -0.732,-30.77734 -7.9062,-46.62499 -0.4593,-1.65783 -1.3753,-2.43205 -2.625,-3.4999 -10.8288,-9.19166 -23.8588,-8.03267 -31.8438,-8.50001 l -0.5938,-0.0312 z m 22.0626,47.46875 c 0.2983,4.01025 0.663,7.89337 0.9374,12.09375 -0.3619,6.15055 0.7536,11.18085 1.0313,14.9375 0.091,1.23358 -3e-4,1.89681 -0.031,2.71875 -0.7261,-0.49389 -0.8804,-0.56988 -1.7812,-1.1875 l -3.5,-2.40625 -4.1562,0.84375 c -11.8502,2.42474 -23.4896,3.77093 -32.7188,0.59375 l -0.75,-0.25 -0.8125,-0.15625 c -0.7563,-0.12889 -0.7437,-0.008 -0.5937,-0.75 l 0.375,-1.875 -0.3438,-1.875 c -1.3223,-7.37497 4.0726,-16.31882 11.1562,-18.03125 l 0.5626,-0.15625 0.5312,-0.1875 c 1.5591,-0.56829 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.48444 15.6563,0.0312 l 1.4687,-0.34375 1.3125,-0.75 c 1.5458,-0.8862 2.8481,-1.95265 3.9688,-3.125 z"
474 style="color:#000000;fill:url(#linearGradient4445);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
475 <path
476 d="m 442.8461,65.50261 c -9.9417,-0.25223 -20.0112,1.83054 -27.125,8.78125 a 1.4249747,1.4249747 0 0 1 -0.1876,0.125 c -0.4923,0.34955 -1.0141,0.64308 -1.6874,0.65625 -0.6734,0.0132 -1.3402,-0.39879 -1.6876,-0.8125 -0.6947,-0.82743 -0.7686,-1.5945 -0.9687,-2.34375 -0.2001,-0.74925 -0.4246,-1.47139 -0.6563,-1.84375 -0.2316,-0.37236 -0.2624,-0.39819 -0.6874,-0.40625 a 1.4249747,1.4249747 0 0 1 -0.6563,-0.1875 c -2.1511,-1.16691 -4.3134,-0.58174 -5.9063,0.90625 -1.5928,1.48799 -2.4145,3.81205 -1.5937,6.125 a 1.4249747,1.4249747 0 0 1 0.094,0.46875 c 0.099,20.08519 -1.9054,40.73856 3.75,59.71875 1.2377,1.74956 4.0539,2.66609 6.4063,2.28125 1.2075,-0.19755 2.2216,-0.71247 2.8437,-1.40625 0.6222,-0.69378 0.9615,-1.54589 0.75,-2.96875 a 1.4249747,1.4249747 0 0 1 0,-0.375 c 1.5091,-15.16756 -3.1254,-31.94343 3.25,-47.28125 a 1.4249747,1.4249747 0 0 1 0.031,-0.0625 c 2.3884,-4.77662 7.2847,-8.50018 12.5937,-10.03125 5.3091,-1.53107 11.2689,-0.75156 15.1563,3.84375 a 1.4249747,1.4249747 0 0 1 0.1563,0.1875 c 2.0694,3.60071 1.6918,8.0153 1.9687,11.75 0.1385,1.86735 0.4194,3.54061 1.0313,4.875 0.5916,1.2904 1.4751,2.25734 3.0312,3 1.4606,0.20734 2.5297,-0.051 3.4375,-0.6875 0.9587,-0.67214 1.771,-1.81376 2.375,-3.21875 1.2079,-2.80999 1.508,-6.6831 1.1563,-9.25 -1.6601,-6.82503 -2.269,-14.23556 -6.2813,-19.1875 -2.6943,-2.32961 -6.6692,-2.77567 -10.5313,-2.65625 a 1.4249747,1.4249747 0 0 1 -0.062,0 z"
477 id="path4436"
478 style="fill:#484848;fill-opacity:1;stroke:none" />
479 <path
480 id="path4224"
481 d="m 548.52594,68.07721 -1.2187,0.25 c -8.6956,1.82574 -14.1425,9.53796 -15.9688,15.68749 -1.8263,6.14954 -1.7462,11.84707 -1.8125,15.71875 l 0,0.125 0,0.125 c 0.1092,10.79916 -0.5536,24.0134 4.9063,37 0.01,0.0225 0.022,0.0401 0.031,0.0625 2.7726,6.62078 9.3817,9.9621 15.5625,9.5625 5.6001,-0.36206 11.8353,-5.2195 13.5,-11.53125 5.3924,-17.21633 5.3013,-35.62075 1.75,-52.53125 l -0.1563,-0.6875 -0.2187,-0.62499 c -0.7814,-2.19128 -1.853,-4.62969 -3.9375,-7.1875 -2.0845,-2.55781 -5.8401,-5.71667 -11.1875,-5.9375 l -1.25,-0.0312 z"
482 style="color:#000000;fill:url(#linearGradient4443);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
483 <path
484 d="m 550.1139,78.59636 c -4.5226,0.97522 -6.7823,4.26272 -8,8.375 -1.2232,4.13111 -1.3087,9.03503 -1.375,12.90625 0.1123,11.09592 -0.2043,22.90976 4.0938,33.09375 0.9213,2.22841 3.1731,3.32073 5.25,3.1875 2.0769,-0.13323 3.906,-1.39 4.1562,-4.09375 a 0.46475483,0.46475483 0 0 1 0.031,-0.0937 c 4.7332,-15.11164 4.7084,-31.85462 1.4687,-47.28125 -0.4788,-1.32581 -1.2248,-2.85305 -2.1874,-4.03125 -0.9629,-1.17844 -2.1146,-1.98485 -3.4376,-2.0625 z"
485 id="path4438"
486 style="fill:#484848;fill-opacity:1;stroke:none" />
487 <path
488 id="path4229"
489 d="m 242.87094,52.92092 -0.5938,0.0312 c -10.6919,0.64192 -26.7607,2.35873 -35.4062,16.28131 l -0.375,0.59375 -0.2813,0.65625 c -2.6168,5.92671 -0.4864,12.60456 3.8125,16.21874 2.4771,2.0825 6.1757,2.98309 9.8438,2.75 -12.176,7.14722 -18.9659,21.26849 -17.125,35.46875 -0.9665,10.0609 5.7999,19.48906 15.4687,21.96875 l -0.031,0.0312 c 13.5891,4.67806 27.073,3.12012 38.8125,0.90625 1.4445,0.97996 3.2715,2.07302 5.5313,3 2.2749,0.93323 5.2585,1.71839 8.75,1.3125 3.4915,-0.40589 7.1509,-2.27156 9.6562,-4.84375 l 0.3438,-0.375 0.3125,-0.40625 c 5.3641,-6.74969 5.6478,-14.72585 5.2187,-20.53125 -0.4291,-5.8054 -1.2109,-10.50221 -1,-12.84375 l 0.062,-0.78125 -0.062,-0.78125 c -0.9297,-14.081 -0.7006,-30.74608 -7.875,-46.59374 l -0.9375,-2.0625 -1.7187,-1.4375 c -10.8287,-9.19167 -23.8276,-8.06392 -31.8125,-8.53126 l -0.5938,-0.0312 z m 22.0312,47.5 c 0.2974,4.00059 0.6637,7.87292 0.9375,12.0625 -0.3619,6.15055 0.7536,11.2121 1.0313,14.96875 0.091,1.22812 0,1.86766 -0.031,2.6875 -0.7261,-0.49388 -0.8805,-0.56989 -1.7813,-1.1875 l -3.5,-2.40625 -4.1562,0.875 c -11.8502,2.42475 -23.4582,3.77094 -32.6875,0.59375 l -0.7813,-0.28125 -0.8125,-0.125 c -0.7563,-0.12888 -0.7437,-0.0396 -0.5938,-0.78125 l 0.375,-1.84375 -0.3437,-1.875 c -1.3223,-7.37494 4.0726,-16.35008 11.1562,-18.0625 l 0.5625,-0.125 0.5313,-0.1875 c 1.5591,-0.56828 3.7957,-0.58273 7.6875,-0.125 3.8918,0.45773 9.2275,1.45313 15.6562,0 l 1.4688,-0.3125 1.3125,-0.75 c 1.5458,-0.8862 2.8482,-1.95265 3.9687,-3.125 z"
490 style="color:#000000;fill:url(#linearGradient4441);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
491 <path
492 d="m 243.6361,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z"
493 id="path4426"
494 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
495 <path
496 d="m 252.9376,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z"
497 id="path5306"
498 style="color:#000000;fill:url(#linearGradient4439);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22" />
499 <path
500 id="text4338"
501 d="m 550.24144,11.97714 c -4.7431,8e-5 -9.3884,1.94508 -12.1562,5.65625 -2.3938,3.20927 -3.2655,7.28209 -3.5,11.84374 -5.2417,0.10768 -9.658,0.71067 -13.2813,2.53125 -3.7519,1.88519 -6.5576,5.75636 -6.9063,9.9375 l -0.062,0 c -0.013,0.1027 0.011,0.20947 0,0.3125 0,0.043 -0.03,0.0819 -0.031,0.125 l 0.031,0 c -0.383,3.94189 0.8037,8.08581 3.625,10.84375 1.7434,1.70445 3.9242,2.79035 6.3124,3.59375 l -0.875,2.4375 -0.062,0.125 -0.031,0.125 c -1.0239,3.32791 -0.9882,7.09444 0.8437,10.15625 1.8322,3.06181 4.9132,4.85334 8.3438,5.90625 l 0.7188,0.21875 0.75,0 2.2812,0 c 4.1038,5e-5 8.0184,-1.11288 11.1562,-3.5 1.388,-1.05587 2.5677,-2.38102 3.5938,-3.8125 2.738,2.5559 6.0541,4.80834 10,6.78125 l 0.5,0.25 0.5312,0.15625 c 3.235,0.79227 6.3972,0.95306 9.4063,-0.1875 2.9956,-1.13542 5.3523,-3.78973 6.4375,-6.71875 l 0.031,0 0,-0.0312 c 1.3188,-3.58119 1.0754,-7.65809 -0.4687,-11.1875 -0.3593,-0.82136 -0.9637,-1.56048 -1.4375,-2.34375 0.7988,-0.35352 1.5774,-0.75006 2.3125,-1.28125 3.1456,-2.2731 4.4669,-6.43958 4.1563,-10.25 l 0.031,0 c 0,-0.12851 -0.061,-0.24691 -0.062,-0.375 -0.017,-0.15367 0.023,-0.31671 0,-0.46875 l -0.062,0 c -0.2506,-3.85862 -2.6242,-7.47641 -5.875,-9.5625 -3.1968,-2.05143 -7.2278,-3.19745 -12.0625,-4.03124 -0.5947,-4.02941 -1.4462,-7.64148 -3.125,-10.53125 -2.2702,-3.9078 -6.5646,-6.71865 -11.0625,-6.71875 z m 18.3125,50.62499 c 0.2654,0.97712 0.2969,1.7705 -0.031,2.65625 l 0,0.0312 c -0.3181,0.86918 -0.3036,0.72198 -0.625,0.84375 -0.2585,0.098 -1.2073,0.14918 -2.5624,-0.0625 0.3313,-0.1475 0.7366,-0.14338 1.0312,-0.34375 l 0.4375,-0.28125 0.375,-0.40625 c 0.5814,-0.62017 0.9776,-1.55372 1.375,-2.4375 z"
502 style="color:#000000;fill:#305f00;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:10" />
503 <g
504 id="text4342"
505 style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:165.01513672px;line-height:125%;font-family:'comic andy';-inkscape-font-specification:'comic andy';letter-spacing:0px;word-spacing:0px;fill:url(#linearGradient4437);fill-opacity:1;stroke:none">
506 <path
507 id="path101"
508 style="fill:url(#linearGradient4437);fill-opacity:1"
509 d="m 550.24549,16.984496 q 8.54083,0 9.83001,16.920498 l 2.33664,0 q 15.22844,2.33664 15.0673,9.668855 1.28918,8.621397 -11.03861,7.976806 9.42713,8.299101 6.7682,15.470169 -2.09492,5.72074 -9.99116,3.786969 -8.70197,-4.350985 -12.32779,-9.991151 l -1.5309,0 q -3.3841,9.991151 -13.13353,9.991151 l -2.25606,0 q -8.13796,-2.497788 -5.88189,-9.830003 l 2.82008,-7.815659 -0.80574,0 q -11.92492,-1.692049 -10.79688,-10.555167 0.32229,-8.137954 16.35648,-8.218527 4.43155,-0.483443 3.70639,-2.820083 0,-14.583858 10.87746,-14.583858 z m -4.5927,16.034186 -0.16115,4.512133 q -0.24172,3.384099 -2.17549,3.384099 l -12.73066,0.725164 q -2.98123,0.08057 -2.98123,2.417214 0,2.256067 3.22295,2.417214 11.19976,-0.564016 10.47459,1.530902 l -2.25606,4.834428 q -5.72074,8.621396 -2.82009,10.152299 3.86754,2.33664 10.95804,-12.08607 1.69205,-1.530902 2.82008,0 4.99558,5.317871 8.21853,8.70197 3.30353,3.3841 5.31787,2.014345 2.41721,-2.578361 -1.28918,-5.559592 -3.62582,-3.061804 -8.2991,-8.379675 -0.48344,-1.772623 0.24172,-1.772623 15.79246,1.047459 15.14787,-2.014345 0.48345,-3.3841 -13.69754,-3.3841 -2.17549,0.402869 -3.54525,-1.047459 l 0,-7.896232 q 0,-6.607052 -3.14238,-6.526478 -3.3841,-0.805738 -3.30352,7.976806 z" />
510 </g>
511 <path
512 style="fill:#484848;fill-opacity:1;stroke:#484848;stroke-width:3;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
513 id="path4714"
514 d="m 335.7911,64.63031 c -9.6363,0.58398 -20.9336,2.59484 -26.0312,10.625 -0.4035,0.99026 -0.045,1.9107 0.6562,2.5 0.717,0.60234 1.4896,0.85243 2.5626,0 a 1.684398,1.684398 0 0 1 0.625,-0.3125 c 5.775,-1.5733 12.3167,-3.78461 18.9374,-4.625 6.6208,-0.84039 13.4444,-0.25925 19.4063,3.84375 a 1.684398,1.684398 0 0 1 0.375,0.375 c 2.0281,2.75755 2.9112,6.50666 2.5937,10.125 -0.3174,3.61834 -1.9072,7.25777 -5.2187,9.15625 a 1.684398,1.684398 0 0 1 -0.4687,0.1875 c -4.4561,1.00721 -8.7953,0.29068 -12.875,-0.1875 -4.0798,-0.47818 -7.8868,-0.73461 -11.5313,0.59375 a 1.684398,1.684398 0 0 1 -0.1563,0.0312 c -11.7884,2.8498 -19.5228,15.78804 -17.4062,27.59375 a 1.684398,1.684398 0 0 1 0,0.65625 c -1.0407,5.14641 2.2557,9.72666 7.3438,10.59375 a 1.684398,1.684398 0 0 1 0.2812,0.0625 c 11.7498,4.04484 24.8758,2.18109 37.0625,-0.3125 a 1.684398,1.684398 0 0 1 1.2813,0.28125 c 2.0816,1.42722 4.4575,3.29235 6.625,4.1875 1.0837,0.44757 2.0633,0.63094 2.9374,0.53125 0.8627,-0.0984 1.6764,-0.44585 2.5938,-1.375 0.01,-0.0118 0.022,-0.0195 0.031,-0.0312 2.6608,-3.43997 2.9705,-7.61463 2.625,-12.3125 -0.3431,-4.66636 -1.3766,-9.66321 -1,-14.46875 -0.9524,-14.4251 -1.1073,-29.45823 -6.7187,-42.15625 -6.4124,-5.22259 -15.7954,-5.06556 -24.4687,-5.5625 -0.021,-10e-4 -0.042,0.001 -0.063,0 z" />
515 <path
516 style="color:#000000;fill:url(#linearGradient4435);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:22"
517 id="path5310"
518 d="m 345.6192,106.30395 c -3.4993,0.0307 -6.9607,-0.0581 -10.375,0.0312 -4.1004,0.36044 -9.0376,1.69024 -12.625,4.09375 -3.614,2.42133 -5.8704,5.68864 -5.2813,10.4375 0.4935,4.61527 3.5645,7.56447 7.6876,9.21875 4.123,1.65428 9.2633,1.8209 13.1562,0.65625 a 1.3611835,1.3611835 0 0 1 0.1562,-0.0312 c 2.8688,-0.49834 6.5939,-1.2529 9.2813,-2.71875 1.3437,-0.73292 2.3836,-1.63683 3.0313,-2.6875 0.6476,-1.05067 0.9604,-2.26047 0.6874,-3.96875 a 1.3611835,1.3611835 0 0 1 0,-0.28125 c 0.1564,-2.76724 0.3451,-6.68524 -0.375,-9.71875 -0.36,-1.51676 -0.9264,-2.77474 -1.75,-3.625 -0.8176,-0.8442 -1.8698,-1.36151 -3.5624,-1.40625 -0.012,-3.2e-4 -0.019,2.7e-4 -0.031,0 z" />
519 </g>
520 </g>
521 </g>
522</svg>
diff --git a/doc/sidebar.html b/doc/sidebar.html
index 826e4cb2..8603ecac 100644
--- a/doc/sidebar.html
+++ b/doc/sidebar.html
@@ -6,18 +6,26 @@
6<li><a href="Download.html">Download</a></li> 6<li><a href="Download.html">Download</a></li>
7<li><a href="Server-requirements.html">Server requirements</a></li> 7<li><a href="Server-requirements.html">Server requirements</a></li>
8<li><a href="Server-configuration.html">Server configuration</a></li> 8<li><a href="Server-configuration.html">Server configuration</a></li>
9<li><a href="Server-security.html">Server security</a></li>
10<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
9<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 11<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
12<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
10</ul></li> 13</ul></li>
14<li><a href="Docker.html">Docker</a></li>
15<li><a href="Plugin-list.html">Plugin list</a></li>
11<li><a href="Usage.html">Usage</a> 16<li><a href="Usage.html">Usage</a>
12<ul> 17<ul>
13<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 18<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
19<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
14<li><a href="Firefox-share.html">Firefox share</a></li> 20<li><a href="Firefox-share.html">Firefox share</a></li>
15<li><a href="RSS-feeds.html">RSS feeds</a></li> 21<li><a href="RSS-feeds.html">RSS feeds</a></li>
16</ul></li> 22</ul></li>
17<li>How To 23<li>How To
18<ul> 24<ul>
19<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 25<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
26<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
20<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 27<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
28<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
21<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 29<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
22<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 30<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
23</ul></li> 31</ul></li>
@@ -29,6 +37,7 @@
29<li><a href="Directory-structure.html">Directory structure</a></li> 37<li><a href="Directory-structure.html">Directory structure</a></li>
30<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 38<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
31<li><a href="Plugin-System.html">Plugin System</a></li> 39<li><a href="Plugin-System.html">Plugin System</a></li>
40<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
32<li><a href="Security.html">Security</a></li> 41<li><a href="Security.html">Security</a></li>
33<li><a href="Static-analysis.html">Static analysis</a></li> 42<li><a href="Static-analysis.html">Static analysis</a></li>
34<li><a href="Theming.html">Theming</a></li> 43<li><a href="Theming.html">Theming</a></li>
diff --git a/inc/awesomplete-multiple-tags.js b/inc/awesomplete-multiple-tags.js
index e0f889b1..4cc8429f 100644
--- a/inc/awesomplete-multiple-tags.js
+++ b/inc/awesomplete-multiple-tags.js
@@ -1,5 +1,5 @@
1$ = Awesomplete.$; 1var awp = Awesomplete.$;
2awesomplete = new Awesomplete($('input[data-multiple]'), { 2awesomplete = new Awesomplete(awp('input[data-multiple]'), {
3 filter: function(text, input) { 3 filter: function(text, input) {
4 return Awesomplete.FILTER_CONTAINS(text, input.match(/[^ ]*$/)[0]); 4 return Awesomplete.FILTER_CONTAINS(text, input.match(/[^ ]*$/)[0]);
5 }, 5 },
diff --git a/index.php b/index.php
index 01122ebf..47bae6e8 100644
--- a/index.php
+++ b/index.php
@@ -161,6 +161,7 @@ require_once 'application/HttpUtils.php';
161require_once 'application/LinkDB.php'; 161require_once 'application/LinkDB.php';
162require_once 'application/LinkFilter.php'; 162require_once 'application/LinkFilter.php';
163require_once 'application/LinkUtils.php'; 163require_once 'application/LinkUtils.php';
164require_once 'application/NetscapeBookmarkUtils.php';
164require_once 'application/TimeZone.php'; 165require_once 'application/TimeZone.php';
165require_once 'application/Url.php'; 166require_once 'application/Url.php';
166require_once 'application/Utils.php'; 167require_once 'application/Utils.php';
@@ -1522,7 +1523,7 @@ function renderPage()
1522 1523
1523 // -------- User want to post a new link: Display link edit form. 1524 // -------- User want to post a new link: Display link edit form.
1524 if (isset($_GET['post'])) { 1525 if (isset($_GET['post'])) {
1525 $url = cleanup_url(escape($_GET['post'])); 1526 $url = cleanup_url($_GET['post']);
1526 1527
1527 $link_is_new = false; 1528 $link_is_new = false;
1528 // Check if URL is not already in database (in this case, we will edit the existing link) 1529 // Check if URL is not already in database (in this case, we will edit the existing link)
@@ -1547,8 +1548,8 @@ function renderPage()
1547 // Extract title. 1548 // Extract title.
1548 $title = html_extract_title($content); 1549 $title = html_extract_title($content);
1549 // Re-encode title in utf-8 if necessary. 1550 // Re-encode title in utf-8 if necessary.
1550 if (! empty($title) && $charset != 'utf-8') { 1551 if (! empty($title) && strtolower($charset) != 'utf-8') {
1551 $title = mb_convert_encoding($title, $charset, 'utf-8'); 1552 $title = mb_convert_encoding($title, 'utf-8', $charset);
1552 } 1553 }
1553 } 1554 }
1554 } 1555 }
@@ -1557,6 +1558,8 @@ function renderPage()
1557 $url = '?' . smallHash($linkdate); 1558 $url = '?' . smallHash($linkdate);
1558 $title = 'Note: '; 1559 $title = 'Note: ';
1559 } 1560 }
1561 $url = escape($url);
1562 $title = escape($title);
1560 1563
1561 $link = array( 1564 $link = array(
1562 'linkdate' => $linkdate, 1565 'linkdate' => $linkdate,
@@ -1588,44 +1591,36 @@ function renderPage()
1588 } 1591 }
1589 1592
1590 // -------- Export as Netscape Bookmarks HTML file. 1593 // -------- Export as Netscape Bookmarks HTML file.
1591 if ($targetPage == Router::$PAGE_EXPORT) 1594 if ($targetPage == Router::$PAGE_EXPORT) {
1592 { 1595 if (empty($_GET['selection'])) {
1593 if (empty($_GET['what']))
1594 {
1595 $PAGE->assign('linkcount',count($LINKSDB)); 1596 $PAGE->assign('linkcount',count($LINKSDB));
1596 $PAGE->renderPage('export'); 1597 $PAGE->renderPage('export');
1597 exit; 1598 exit;
1598 } 1599 }
1599 $exportWhat=$_GET['what'];
1600 if (!array_intersect(array('all','public','private'),array($exportWhat))) die('What are you trying to export???');
1601 1600
1602 header('Content-Type: text/html; charset=utf-8'); 1601 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1603 header('Content-disposition: attachment; filename=bookmarks_'.$exportWhat.'_'.strval(date('Ymd_His')).'.html'); 1602 $selection = $_GET['selection'];
1604 $currentdate=date('Y/m/d H:i:s'); 1603 try {
1605 echo <<<HTML 1604 $PAGE->assign(
1606<!DOCTYPE NETSCAPE-Bookmark-file-1> 1605 'links',
1607<!-- This is an automatically generated file. 1606 NetscapeBookmarkUtils::filterAndFormat($LINKSDB, $selection)
1608 It will be read and overwritten. 1607 );
1609 DO NOT EDIT! --> 1608 } catch (Exception $exc) {
1610<!-- Shaarli {$exportWhat} bookmarks export on {$currentdate} --> 1609 header('Content-Type: text/plain; charset=utf-8');
1611<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"> 1610 echo $exc->getMessage();
1612<TITLE>Bookmarks</TITLE> 1611 exit;
1613<H1>Bookmarks</H1>
1614HTML;
1615 foreach($LINKSDB as $link)
1616 {
1617 if ($exportWhat=='all' ||
1618 ($exportWhat=='private' && $link['private']!=0) ||
1619 ($exportWhat=='public' && $link['private']==0))
1620 {
1621 $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
1622 echo '<DT><A HREF="'.$link['url'].'" ADD_DATE="'.$date->getTimestamp().'" PRIVATE="'.$link['private'].'"';
1623 if ($link['tags']!='') echo ' TAGS="'.str_replace(' ',',',$link['tags']).'"';
1624 echo '>'.$link['title']."</A>\n";
1625 if ($link['description']!='') echo '<DD>'.$link['description']."\n";
1626 }
1627 } 1612 }
1628 exit; 1613 $now = new DateTime();
1614 header('Content-Type: text/html; charset=utf-8');
1615 header(
1616 'Content-disposition: attachment; filename=bookmarks_'
1617 .$selection.'_'.$now->format(LinkDB::LINK_DATE_FORMAT).'.html'
1618 );
1619 $PAGE->assign('date', $now->format(DateTime::RFC822));
1620 $PAGE->assign('eol', PHP_EOL);
1621 $PAGE->assign('selection', $selection);
1622 $PAGE->renderPage('export.bookmarks');
1623 exit;
1629 } 1624 }
1630 1625
1631 // -------- User is uploading a file for import 1626 // -------- User is uploading a file for import
diff --git a/tests/HttpUtils/GetHttpUrlTest.php b/tests/HttpUtils/GetHttpUrlTest.php
index fd293505..ea53de5f 100644
--- a/tests/HttpUtils/GetHttpUrlTest.php
+++ b/tests/HttpUtils/GetHttpUrlTest.php
@@ -35,4 +35,31 @@ class GetHttpUrlTest extends PHPUnit_Framework_TestCase
35 $this->assertFalse($headers); 35 $this->assertFalse($headers);
36 $this->assertFalse($content); 36 $this->assertFalse($content);
37 } 37 }
38
39 /**
40 * Test getAbsoluteUrl with relative target URL.
41 */
42 public function testGetAbsoluteUrlWithRelative()
43 {
44 $origin = 'http://non.existent/blabla/?test';
45 $target = '/stuff.php';
46
47 $expected = 'http://non.existent/stuff.php';
48 $this->assertEquals($expected, getAbsoluteUrl($origin, $target));
49
50 $target = 'stuff.php';
51 $expected = 'http://non.existent/blabla/stuff.php';
52 $this->assertEquals($expected, getAbsoluteUrl($origin, $target));
53 }
54
55 /**
56 * Test getAbsoluteUrl with absolute target URL.
57 */
58 public function testGetAbsoluteUrlWithAbsolute()
59 {
60 $origin = 'http://non.existent/blabla/?test';
61 $target = 'http://other.url/stuff.php';
62
63 $this->assertEquals($target, getAbsoluteUrl($origin, $target));
64 }
38} 65}
diff --git a/tests/NetscapeBookmarkUtilsTest.php b/tests/NetscapeBookmarkUtilsTest.php
new file mode 100644
index 00000000..b7472d92
--- /dev/null
+++ b/tests/NetscapeBookmarkUtilsTest.php
@@ -0,0 +1,104 @@
1<?php
2
3require_once 'application/NetscapeBookmarkUtils.php';
4
5/**
6 * Netscape bookmark import and export
7 */
8class NetscapeBookmarkUtilsTest extends PHPUnit_Framework_TestCase
9{
10 /**
11 * @var string datastore to test write operations
12 */
13 protected static $testDatastore = 'sandbox/datastore.php';
14
15 /**
16 * @var ReferenceLinkDB instance.
17 */
18 protected static $refDb = null;
19
20 /**
21 * @var LinkDB private LinkDB instance.
22 */
23 protected static $linkDb = null;
24
25 /**
26 * Instantiate reference data
27 */
28 public static function setUpBeforeClass()
29 {
30 self::$refDb = new ReferenceLinkDB();
31 self::$refDb->write(self::$testDatastore);
32 self::$linkDb = new LinkDB(self::$testDatastore, true, false);
33 }
34
35 /**
36 * Attempt to export an invalid link selection
37 * @expectedException Exception
38 * @expectedExceptionMessageRegExp /Invalid export selection/
39 */
40 public function testFilterAndFormatInvalid()
41 {
42 NetscapeBookmarkUtils::filterAndFormat(self::$linkDb, 'derp');
43 }
44
45 /**
46 * Prepare all links for export
47 */
48 public function testFilterAndFormatAll()
49 {
50 $links = NetscapeBookmarkUtils::filterAndFormat(self::$linkDb, 'all');
51 $this->assertEquals(self::$refDb->countLinks(), sizeof($links));
52 foreach ($links as $link) {
53 $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
54 $this->assertEquals(
55 $date->getTimestamp(),
56 $link['timestamp']
57 );
58 $this->assertEquals(
59 str_replace(' ', ',', $link['tags']),
60 $link['taglist']
61 );
62 }
63 }
64
65 /**
66 * Prepare private links for export
67 */
68 public function testFilterAndFormatPrivate()
69 {
70 $links = NetscapeBookmarkUtils::filterAndFormat(self::$linkDb, 'private');
71 $this->assertEquals(self::$refDb->countPrivateLinks(), sizeof($links));
72 foreach ($links as $link) {
73 $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
74 $this->assertEquals(
75 $date->getTimestamp(),
76 $link['timestamp']
77 );
78 $this->assertEquals(
79 str_replace(' ', ',', $link['tags']),
80 $link['taglist']
81 );
82 }
83 }
84
85 /**
86 * Prepare public links for export
87 */
88 public function testFilterAndFormatPublic()
89 {
90 $links = NetscapeBookmarkUtils::filterAndFormat(self::$linkDb, 'public');
91 $this->assertEquals(self::$refDb->countPublicLinks(), sizeof($links));
92 foreach ($links as $link) {
93 $date = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
94 $this->assertEquals(
95 $date->getTimestamp(),
96 $link['timestamp']
97 );
98 $this->assertEquals(
99 str_replace(' ', ',', $link['tags']),
100 $link['taglist']
101 );
102 }
103 }
104}
diff --git a/tests/Url/UrlTest.php b/tests/Url/UrlTest.php
index a64a73ea..5fdc8617 100644
--- a/tests/Url/UrlTest.php
+++ b/tests/Url/UrlTest.php
@@ -181,4 +181,19 @@ class UrlTest extends PHPUnit_Framework_TestCase
181 $url = new Url('ftp://save.tld/mysave'); 181 $url = new Url('ftp://save.tld/mysave');
182 $this->assertFalse($url->isHttp()); 182 $this->assertFalse($url->isHttp());
183 } 183 }
184
185 /**
186 * Test IndToAscii.
187 */
188 function testIndToAscii()
189 {
190 $ind = 'http://www.académie-française.fr/';
191 $expected = 'http://www.xn--acadmie-franaise-npb1a.fr/';
192 $url = new Url($ind);
193 $this->assertEquals($expected, $url->indToAscii());
194
195 $notInd = 'http://www.academie-francaise.fr/';
196 $url = new Url($notInd);
197 $this->assertEquals($notInd, $url->indToAscii());
198 }
184} 199}
diff --git a/tpl/export.bookmarks.html b/tpl/export.bookmarks.html
new file mode 100644
index 00000000..da733257
--- /dev/null
+++ b/tpl/export.bookmarks.html
@@ -0,0 +1,10 @@
1<!DOCTYPE NETSCAPE-Bookmark-file-1>
2<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
3<!-- This is an automatically generated file.
4 It will be read and overwritten.
5 Do Not Edit! -->{ignore}The RainTPL loop is formatted to avoid generating extra newlines{/ignore}
6<TITLE>{$pagetitle}</TITLE>
7<H1>Shaarli export of {$selection} bookmarks on {$date}</H1>
8<DL><p>{loop="links"}
9<DT><A HREF="{$value.url}" ADD_DATE="{$value.timestamp}" PRIVATE="{$value.private}" TAGS="{$value.taglist}">{$value.title}</A>{if="$value.description"}{$eol}<DD>{$value.description}{/if}{/loop}
10</DL><p>
diff --git a/tpl/export.html b/tpl/export.html
index 9d101db4..9582627a 100644
--- a/tpl/export.html
+++ b/tpl/export.html
@@ -2,15 +2,21 @@
2<html> 2<html>
3<head>{include="includes"}</head> 3<head>{include="includes"}</head>
4<body> 4<body>
5<div id="pageheader"> 5 <div id="pageheader">
6 {include="page.header"} 6 {include="page.header"}
7 <div id="toolsdiv"> 7 <div id="toolsdiv">
8 <a href="?do=export&amp;what=all"><b>Export all</b> <span>: Export all links</span></a><br><br> 8 <a href="?do=export&amp;selection=all">
9 <a href="?do=export&amp;what=public"><b>Export public</b> <span>: Export public links only</span></a><br><br> 9 <b>Export all</b><span>: Export all links</span>
10 <a href="?do=export&amp;what=private"><b>Export private</b> <span>: Export private links only</span></a> 10 </a><br>
11 <div class="clear"></div> 11 <a href="?do=export&amp;selection=public">
12 </div> 12 <b>Export public</b><span>: Only export public links</span>
13</div> 13 </a><br>
14{include="page.footer"} 14 <a href="?do=export&amp;selection=private">
15 <b>Export private</b><span>: Only export private links</span>
16 </a>
17 <div class="clear"></div>
18 </div>
19 </div>
20 {include="page.footer"}
15</body> 21</body>
16</html> 22</html>