doc/Shaarli-configuration.html

   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 configuration</title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <style type="text/css">
  10 div.sourceCode { overflow-x: auto; }
  11 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  12   margin: 0; padding: 0; vertical-align: baseline; border: none; }
  13 table.sourceCode { width: 100%; line-height: 100%; }
  14 td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
  15 td.sourceCode { padding-left: 5px; }
  16 code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
  17 code > span.dt { color: #902000; } /* DataType */
  18 code > span.dv { color: #40a070; } /* DecVal */
  19 code > span.bn { color: #40a070; } /* BaseN */
  20 code > span.fl { color: #40a070; } /* Float */
  21 code > span.ch { color: #4070a0; } /* Char */
  22 code > span.st { color: #4070a0; } /* String */
  23 code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
  24 code > span.ot { color: #007020; } /* Other */
  25 code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
  26 code > span.fu { color: #06287e; } /* Function */
  27 code > span.er { color: #ff0000; font-weight: bold; } /* Error */
  28 code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
  29 code > span.cn { color: #880000; } /* Constant */
  30 code > span.sc { color: #4070a0; } /* SpecialChar */
  31 code > span.vs { color: #4070a0; } /* VerbatimString */
  32 code > span.ss { color: #bb6688; } /* SpecialString */
  33 code > span.im { } /* Import */
  34 code > span.va { color: #19177c; } /* Variable */
  35 code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
  36 code > span.op { color: #666666; } /* Operator */
  37 code > span.bu { } /* BuiltIn */
  38 code > span.ex { } /* Extension */
  39 code > span.pp { color: #bc7a00; } /* Preprocessor */
  40 code > span.at { color: #7d9029; } /* Attribute */
  41 code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
  42 code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
  43 code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
  44 code > 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>Setup
  56 <ul>
  57 <li><a href="Download-and-Installation.html">Download and Installation</a></li>
  58 <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
  59 <li><a href="Server-requirements.html">Server requirements</a></li>
  60 <li><a href="Server-configuration.html">Server configuration</a></li>
  61 <li><a href="Server-security.html">Server security</a></li>
  62 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  63 <li><a href="Plugins.html">Plugins</a></li>
  64 </ul></li>
  65 <li><a href="Docker.html">Docker</a></li>
  66 <li><a href="Usage.html">Usage</a>
  67 <ul>
  68 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  69 <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
  70 <li><a href="Firefox-share.html">Firefox share</a></li>
  71 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  72 </ul></li>
  73 <li>How To
  74 <ul>
  75 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  76 <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>
  77 <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
  78 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  79 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  80 </ul></li>
  81 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  82 <li><a href="Development.html">Development</a>
  83 <ul>
  84 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  85 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  86 <li><a href="Directory-structure.html">Directory structure</a></li>
  87 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  88 <li><a href="Plugin-System.html">Plugin System</a></li>
  89 <li><a href="Release-Shaarli.html">Release Shaarli</a></li>
  90 <li><a href="Security.html">Security</a></li>
  91 <li><a href="Static-analysis.html">Static analysis</a></li>
  92 <li><a href="Theming.html">Theming</a></li>
  93 <li><a href="Unit-tests.html">Unit tests</a></li>
  94 </ul></li>
  95 <li>About
  96 <ul>
  97 <li><a href="FAQ.html">FAQ</a></li>
  98 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  99 </ul></li>
 100 </ul>
 101 </div>
 102 <h1 id="shaarli-configuration">Shaarli configuration</h1>
 103 <h1 id="shaarli-configuration-1">Shaarli configuration</h1>
 104 <h2 id="foreword">Foreword</h2>
 105 <p><strong>Do not edit configuration options in index.php! Your changes would be lost.</strong></p>
 106 <p>Once your Shaarli instance is installed, the file <code>data/config.json.php</code> is generated:</p>
 107 <ul>
 108 <li>it contains all settings in JSON format, and can be edited to customize values</li>
 109 <li>it defines which <a href="Plugin-System">plugins</a> are enabled<a href="(.html).html">(.html)</a></li>
 110 <li>its values override those defined in <code>index.php</code></li>
 111 <li>it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</li>
 112 </ul>
 113 <h2 id="file-and-directory-permissions">File and directory permissions</h2>
 114 <p>The server process running Shaarli must have:</p>
 115 <ul>
 116 <li><code>read</code> access to the following resources:
 117 <ul>
 118 <li>PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code></li>
 119 <li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code></li>
 120 <li>static assets:
 121 <ul>
 122 <li>CSS stylesheets: <code>inc/*.css</code></li>
 123 <li><code>images/*</code></li>
 124 </ul></li>
 125 <li>RainTPL templates: <code>tpl/*.html</code></li>
 126 </ul></li>
 127 <li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories:
 128 <ul>
 129 <li><code>cache</code> - thumbnail cache</li>
 130 <li><code>data</code> - link data store, configuration options</li>
 131 <li><code>pagecache</code> - Atom/RSS feed cache</li>
 132 <li><code>tmp</code> - RainTPL page cache</li>
 133 </ul></li>
 134 </ul>
 135 <p>On a Linux distribution:</p>
 136 <ul>
 137 <li>the web server user will likely be <code>www</code> or <code>http</code> (for Apache2)</li>
 138 <li>it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code></li>
 139 <li>to give it access to Shaarli, either:
 140 <ul>
 141 <li>unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner</li>
 142 <li>put users in the same group as the web server, and set the appropriate access rights</li>
 143 </ul></li>
 144 <li>if you have a domain / subdomain to serve Shaarli, <a href="Server-configuration">configure the server</a> accordingly<a href="(.html).html">(.html)</a></li>
 145 </ul>
 146 <h2 id="configuration">Configuration</h2>
 147 <p>In <code>data/config.json.php</code>.</p>
 148 <p>See also <a href="Plugin-System.html">Plugin System</a>.<a href=".html"></a></p>
 149 <h3 id="credentials">Credentials</h3>
 150 <blockquote>
 151 <p>You shouldn't edit those.</p>
 152 </blockquote>
 153 <p><strong>login</strong>: Login username.<br />
 154 <strong>hash</strong>: Generated password hash.<br />
 155 <strong>salt</strong>: Password salt.</p>
 156 <h3 id="general">General</h3>
 157 <p><strong>title</strong>: Shaarli's instance title.<br />
 158 <strong>header_link</strong>: Link to the homepage.<br />
 159 <strong>links_per_page</strong>: Number of shaares displayed per page.<br />
 160 <strong>timezone</strong>: See <a href="http://php.net/manual/en/timezones.php">the list of supported timezones</a>. <a href=".html"></a><br />
 161 <strong>enabled_plugins</strong>: List of enabled plugins.</p>
 162 <h3 id="security">Security</h3>
 163 <p><strong>session_protection_disabled</strong>: Disable session cookie hijacking protection (not recommended).<br />
 164 It might be useful if your IP adress often changes.<br />
 165 <strong>ban_after</strong>: Failed login attempts before being IP banned.<br />
 166 <strong>ban_duration</strong>: IP ban duration in seconds.<br />
 167 <strong>open_shaarli</strong>: Anyone can add a new link while logged out if enabled.<br />
 168 <strong>trusted_proxies</strong>: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.</p>
 169 <h3 id="resources">Resources</h3>
 170 <p><strong>data_dir</strong>: Data directory.<br />
 171 <strong>datastore</strong>: Shaarli's links database file path.<br />
 172 <strong>updates</strong>: File path for the ran updates file.<br />
 173 <strong>log</strong>: Log file path.<br />
 174 <strong>update_check</strong>: Last update check file path.<br />
 175 <strong>raintpl_tpl</strong>: Templates directory.<br />
 176 <strong>raintpl_tmp</strong>: Template engine cache directory.<br />
 177 <strong>thumbnails_cache</strong>: Thumbnails cache directory.<br />
 178 <strong>page_cache</strong>: Shaarli's internal cache directory.<br />
 179 <strong>ban_file</strong>: Banned IP file path.</p>
 180 <h3 id="updates">Updates</h3>
 181 <p><strong>check_updates</strong>: Enable or disable update check to the git repository.<br />
 182 <strong>check_updates_branch</strong>: Git branch used to check updates (e.g. <code>stable</code> or <code>master</code>).<br />
 183 <strong>check_updates_interval</strong>: Look for new version every N seconds (default: every day).</p>
 184 <h3 id="privacy">Privacy</h3>
 185 <p><strong>default_private_links</strong>: Check the private checkbox by default for every new link.<br />
 186 <strong>hide_public_links</strong>: All links are hidden while logged out.<br />
 187 <strong>hide_timestamps</strong>: Timestamps are hidden.</p>
 188 <h3 id="feed">Feed</h3>
 189 <p><strong>rss_permalinks</strong>: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.<br />
 190 <strong>show_atom</strong>: Display ATOM feed button.</p>
 191 <h3 id="thumbnail">Thumbnail</h3>
 192 <p><strong>enable_thumbnails</strong>: Enable or disable thumbnail display.<br />
 193 <strong>enable_localcache</strong>: Enable or disable local cache.</p>
 194 <h3 id="redirector">Redirector</h3>
 195 <p><strong>url</strong>: Redirector URL, such as <code>anonym.to</code>.<br />
 196 <strong>encode_url</strong>: Enable this if the redirector needs encoded URL to work properly.</p>
 197 <h2 id="configuration-file-example">Configuration file example</h2>
 198 <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="er">&lt;?php</span> <span class="er">/*</span>
 199 <span class="fu">{</span>
 200     <span class="dt">&quot;credentials&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 201         <span class="dt">&quot;login&quot;</span><span class="fu">:</span> <span class="st">&quot;&lt;login&gt;&quot;</span><span class="fu">,</span>
 202         <span class="dt">&quot;hash&quot;</span><span class="fu">:</span> <span class="st">&quot;&lt;password hash&gt;&quot;</span><span class="fu">,</span>
 203         <span class="dt">&quot;salt&quot;</span><span class="fu">:</span> <span class="st">&quot;&lt;password salt&gt;&quot;</span>
 204     <span class="fu">},</span>
 205     <span class="dt">&quot;security&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 206         <span class="dt">&quot;ban_after&quot;</span><span class="fu">:</span> <span class="dv">4</span><span class="fu">,</span>
 207         <span class="dt">&quot;session_protection_disabled&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 208         <span class="dt">&quot;ban_duration&quot;</span><span class="fu">:</span> <span class="dv">1800</span><span class="fu">,</span>
 209         <span class="dt">&quot;trusted_proxies&quot;</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span>
 210             <span class="st">&quot;1.2.3.4&quot;</span><span class="ot">,</span>
 211             <span class="st">&quot;5.6.7.8&quot;</span>
 212         <span class="ot">]</span>
 213     <span class="fu">},</span>
 214     <span class="dt">&quot;resources&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 215         <span class="dt">&quot;data_dir&quot;</span><span class="fu">:</span> <span class="st">&quot;data&quot;</span><span class="fu">,</span>
 216         <span class="dt">&quot;config&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">config.php&quot;</span><span class="fu">,</span>
 217         <span class="dt">&quot;datastore&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">datastore.php&quot;</span><span class="fu">,</span>
 218         <span class="dt">&quot;ban_file&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">ipbans.php&quot;</span><span class="fu">,</span>
 219         <span class="dt">&quot;updates&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">updates.txt&quot;</span><span class="fu">,</span>
 220         <span class="dt">&quot;log&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">log.txt&quot;</span><span class="fu">,</span>
 221         <span class="dt">&quot;update_check&quot;</span><span class="fu">:</span> <span class="st">&quot;data</span><span class="ch">\/</span><span class="st">lastupdatecheck.txt&quot;</span><span class="fu">,</span>
 222         <span class="dt">&quot;raintpl_tmp&quot;</span><span class="fu">:</span> <span class="st">&quot;tmp</span><span class="ch">\/</span><span class="st">&quot;</span><span class="fu">,</span>
 223         <span class="dt">&quot;raintpl_tpl&quot;</span><span class="fu">:</span> <span class="st">&quot;tpl</span><span class="ch">\/</span><span class="st">&quot;</span><span class="fu">,</span>
 224         <span class="dt">&quot;thumbnails_cache&quot;</span><span class="fu">:</span> <span class="st">&quot;cache&quot;</span><span class="fu">,</span>
 225         <span class="dt">&quot;page_cache&quot;</span><span class="fu">:</span> <span class="st">&quot;pagecache&quot;</span>
 226     <span class="fu">},</span>
 227     <span class="dt">&quot;general&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 228         <span class="dt">&quot;check_updates&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 229         <span class="dt">&quot;rss_permalinks&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 230         <span class="dt">&quot;links_per_page&quot;</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span>
 231         <span class="dt">&quot;default_private_links&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 232         <span class="dt">&quot;enable_thumbnails&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 233         <span class="dt">&quot;enable_localcache&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 234         <span class="dt">&quot;check_updates_branch&quot;</span><span class="fu">:</span> <span class="st">&quot;stable&quot;</span><span class="fu">,</span>
 235         <span class="dt">&quot;check_updates_interval&quot;</span><span class="fu">:</span> <span class="dv">86400</span><span class="fu">,</span>
 236         <span class="dt">&quot;enabled_plugins&quot;</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span>
 237             <span class="st">&quot;markdown&quot;</span><span class="ot">,</span>
 238             <span class="st">&quot;wallabag&quot;</span><span class="ot">,</span>
 239             <span class="st">&quot;archiveorg&quot;</span>
 240         <span class="ot">]</span><span class="fu">,</span>
 241         <span class="dt">&quot;timezone&quot;</span><span class="fu">:</span> <span class="st">&quot;Europe</span><span class="ch">\/</span><span class="st">Paris&quot;</span><span class="fu">,</span>
 242         <span class="dt">&quot;title&quot;</span><span class="fu">:</span> <span class="st">&quot;My Shaarli&quot;</span><span class="fu">,</span>
 243         <span class="dt">&quot;header_link&quot;</span><span class="fu">:</span> <span class="st">&quot;?&quot;</span>
 244     <span class="fu">},</span>
 245     <span class="dt">&quot;extras&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 246         <span class="dt">&quot;show_atom&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 247         <span class="dt">&quot;hide_public_links&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 248         <span class="dt">&quot;hide_timestamps&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 249         <span class="dt">&quot;open_shaarli&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 250         <span class="dt">&quot;redirector&quot;</span><span class="fu">:</span> <span class="st">&quot;http://anonym.to/?&quot;</span><span class="fu">,</span>
 251         <span class="dt">&quot;redirector_encode_url&quot;</span><span class="fu">:</span> <span class="kw">false</span>
 252     <span class="fu">},</span>
 253     <span class="dt">&quot;general&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 254         <span class="dt">&quot;header_link&quot;</span><span class="fu">:</span> <span class="st">&quot;?&quot;</span><span class="fu">,</span>
 255         <span class="dt">&quot;links_per_page&quot;</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span>
 256         <span class="dt">&quot;enabled_plugins&quot;</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span>
 257             <span class="st">&quot;markdown&quot;</span><span class="ot">,</span>
 258             <span class="st">&quot;wallabag&quot;</span>
 259         <span class="ot">]</span><span class="fu">,</span>
 260         <span class="dt">&quot;timezone&quot;</span><span class="fu">:</span> <span class="st">&quot;Europe</span><span class="ch">\/</span><span class="st">Paris&quot;</span><span class="fu">,</span>
 261         <span class="dt">&quot;title&quot;</span><span class="fu">:</span> <span class="st">&quot;My Shaarli&quot;</span>
 262     <span class="fu">},</span>
 263     <span class="dt">&quot;updates&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 264         <span class="dt">&quot;check_updates&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 265         <span class="dt">&quot;check_updates_branch&quot;</span><span class="fu">:</span> <span class="st">&quot;stable&quot;</span><span class="fu">,</span>
 266         <span class="dt">&quot;check_updates_interval&quot;</span><span class="fu">:</span> <span class="dv">86400</span>
 267     <span class="fu">},</span>
 268     <span class="dt">&quot;feed&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 269         <span class="dt">&quot;rss_permalinks&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 270         <span class="dt">&quot;show_atom&quot;</span><span class="fu">:</span> <span class="kw">false</span>
 271     <span class="fu">},</span>
 272     <span class="dt">&quot;privacy&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 273         <span class="dt">&quot;default_private_links&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 274         <span class="dt">&quot;hide_public_links&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span>
 275         <span class="dt">&quot;hide_timestamps&quot;</span><span class="fu">:</span> <span class="kw">false</span>
 276     <span class="fu">},</span>
 277     <span class="dt">&quot;thumbnail&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 278         <span class="dt">&quot;enable_thumbnails&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span>
 279         <span class="dt">&quot;enable_localcache&quot;</span><span class="fu">:</span> <span class="kw">true</span>
 280     <span class="fu">},</span>
 281     <span class="dt">&quot;redirector&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 282         <span class="dt">&quot;url&quot;</span><span class="fu">:</span> <span class="st">&quot;http://anonym.to/?&quot;</span><span class="fu">,</span>
 283         <span class="dt">&quot;encode_url&quot;</span><span class="fu">:</span> <span class="kw">false</span>
 284     <span class="fu">},</span>
 285     <span class="dt">&quot;plugins&quot;</span><span class="fu">:</span> <span class="fu">{</span>
 286         <span class="dt">&quot;WALLABAG_URL&quot;</span><span class="fu">:</span> <span class="st">&quot;http://demo.wallabag.org&quot;</span><span class="fu">,</span>
 287         <span class="dt">&quot;WALLABAG_VERSION&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span>
 288     <span class="fu">}</span>
 289 <span class="fu">}</span> <span class="er">?&gt;</span></code></pre></div>
 290 <h2 id="additional-configuration">Additional configuration</h2>
 291 <p>The playvideos plugin may require that you adapt your server's<br />
 292 <a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting">Content Security Policy</a> <a href=".html"></a><br />
 293 configuration to work properly.<a href="(.html).html">(.html)</a></p>
 294 </body>
 295 </html>