diff options
| author | ArthurHoaro <arthur@hoa.ro> | 2016-10-12 12:36:59 +0200 |
|---|---|---|
| committer | ArthurHoaro <arthur@hoa.ro> | 2016-10-12 12:36:59 +0200 |
| commit | fdf88d194874a533cf3a8de3d317d70018aa8a62 (patch) | |
| tree | f204fb8ba9e589d4e063c57da01716c487b6e891 /doc/Shaarli-configuration.html | |
| parent | dc8e03bfc415d3771a45ccd324078a48b7466cbe (diff) | |
| download | Shaarli-fdf88d194874a533cf3a8de3d317d70018aa8a62.tar.gz Shaarli-fdf88d194874a533cf3a8de3d317d70018aa8a62.tar.zst Shaarli-fdf88d194874a533cf3a8de3d317d70018aa8a62.zip | |
Bump version to v0.8.0
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
Diffstat (limited to 'doc/Shaarli-configuration.html')
| -rw-r--r-- | doc/Shaarli-configuration.html | 277 |
1 files changed, 156 insertions, 121 deletions
diff --git a/doc/Shaarli-configuration.html b/doc/Shaarli-configuration.html index 74947578..6d717c65 100644 --- a/doc/Shaarli-configuration.html +++ b/doc/Shaarli-configuration.html | |||
| @@ -52,13 +52,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 52 | <div id="local-sidebar"> | 52 | <div id="local-sidebar"> |
| 53 | <ul> | 53 | <ul> |
| 54 | <li><a href="Home.html">Home</a></li> | 54 | <li><a href="Home.html">Home</a></li> |
| 55 | <li>Installation | 55 | <li>Setup |
| 56 | <ul> | 56 | <ul> |
| 57 | <li><a href="Download.html">Download</a></li> | 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> | ||
| 58 | <li><a href="Server-requirements.html">Server requirements</a></li> | 59 | <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-configuration.html">Server configuration</a></li> |
| 60 | <li><a href="Server-security.html">Server security</a></li> | 61 | <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> | 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> |
| 63 | <li><a href="Plugins.html">Plugins</a></li> | 63 | <li><a href="Plugins.html">Plugins</a></li> |
| 64 | </ul></li> | 64 | </ul></li> |
| @@ -73,7 +73,6 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 73 | <li>How To | 73 | <li>How To |
| 74 | <ul> | 74 | <ul> |
| 75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | 75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> |
| 76 | <li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li> | ||
| 77 | <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> | 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> |
| 78 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | 77 | <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> | 78 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> |
| @@ -97,18 +96,19 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 97 | <ul> | 96 | <ul> |
| 98 | <li><a href="FAQ.html">FAQ</a></li> | 97 | <li><a href="FAQ.html">FAQ</a></li> |
| 99 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | 98 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> |
| 100 | <li><a href="TODO.html">TODO</a></li> | ||
| 101 | </ul></li> | 99 | </ul></li> |
| 102 | </ul> | 100 | </ul> |
| 103 | </div> | 101 | </div> |
| 104 | <h1 id="shaarli-configuration">Shaarli configuration</h1> | 102 | <h1 id="shaarli-configuration">Shaarli configuration</h1> |
| 103 | <h1 id="shaarli-configuration-1">Shaarli configuration</h1> | ||
| 105 | <h2 id="foreword">Foreword</h2> | 104 | <h2 id="foreword">Foreword</h2> |
| 106 | <p><strong>Do not edit configuration options in index.php! Your changes would be lost.</strong></p> | 105 | <p><strong>Do not edit configuration options in index.php! Your changes would be lost.</strong></p> |
| 107 | <p>Once your Shaarli instance is installed, the file <code>data/config.php</code> is generated:</p> | 106 | <p>Once your Shaarli instance is installed, the file <code>data/config.json.php</code> is generated:</p> |
| 108 | <ul> | 107 | <ul> |
| 109 | <li>it contains all settings, and can be edited to customize values</li> | 108 | <li>it contains all settings in JSON format, and can be edited to customize values</li> |
| 110 | <li>it defines which <a href="Plugin-System">plugins</a> are enabled<a href=".html"></a></li> | 109 | <li>it defines which <a href="Plugin-System">plugins</a> are enabled<a href="(.html).html">(.html)</a></li> |
| 111 | <li>its values override those defined in <code>index.php</code></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> | 112 | </ul> |
| 113 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> | 113 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> |
| 114 | <p>The server process running Shaarli must have:</p> | 114 | <p>The server process running Shaarli must have:</p> |
| @@ -141,120 +141,155 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 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> | 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> | 142 | <li>put users in the same group as the web server, and set the appropriate access rights</li> |
| 143 | </ul></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"></a></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> | 145 | </ul> |
| 146 | <h2 id="example-dataconfig.php">Example <code>data/config.php</code></h2> | 146 | <h2 id="configuration">Configuration</h2> |
| 147 | <p>See also <a href="Plugin-System.html">Plugin System</a>.</p> | 147 | <p>In <code>data/config.json.php</code>.</p> |
| 148 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw"><?php</span> | 148 | <p>See also <a href="Plugin-System.html">Plugin System</a>.<a href=".html"></a></p> |
| 149 | <span class="co">// User login</span> | 149 | <h3 id="credentials">Credentials</h3> |
| 150 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'login'</span><span class="ot">]</span> = <span class="st">'<login>'</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 150 | <blockquote> |
| 151 | 151 | <p>You shouldn't edit those.</p> | |
| 152 | <span class="co">// User password hash</span> | 152 | </blockquote> |
| 153 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'hash'</span><span class="ot">]</span> = <span class="st">'200c452da46c2f889e5e48c49ef044bcacdcb095'</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 153 | <p><strong>login</strong>: Login username.<br /> |
| 154 | 154 | <strong>hash</strong>: Generated password hash.<br /> | |
| 155 | <span class="co">// Password salt</span> | 155 | <strong>salt</strong>: Password salt.</p> |
| 156 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'salt'</span><span class="ot">]</span> = <span class="st">'13b654102321576033d8473b63a275a1bf94c0f0'</span><span class="ot">;</span> <span class="ot">[](</span>.html<span class="ot">)</span> | 156 | <h3 id="general">General</h3> |
| 157 | 157 | <p><strong>title</strong>: Shaarli's instance title.<br /> | |
| 158 | <span class="co">// Local timezone</span> | 158 | <strong>header_link</strong>: Link to the homepage.<br /> |
| 159 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'timezone'</span><span class="ot">]</span> = <span class="st">'Africa/Abidjan'</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 159 | <strong>links_per_page</strong>: Number of shaares displayed per page.<br /> |
| 160 | <span class="fu">date_default_timezone_set</span><span class="ot">(</span><span class="st">'Africa/Abidjan'</span><span class="ot">);</span> | 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 | 161 | <strong>enabled_plugins</strong>: List of enabled plugins.</p> | |
| 162 | <span class="co">// Shaarli title</span> | 162 | <h3 id="security">Security</h3> |
| 163 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'title'</span><span class="ot">]</span> = <span class="st">'My Little Shaarly'</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 163 | <p><strong>session_protection_disabled</strong>: Disable session cookie hijacking protection (not recommended).<br /> |
| 164 | 164 | It might be useful if your IP adress often changes.<br /> | |
| 165 | <span class="co">// Link the Shaarli title points to</span> | 165 | <strong>ban_after</strong>: Failed login attempts before being IP banned.<br /> |
| 166 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'titleLink'</span><span class="ot">]</span> = <span class="st">'?'</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 166 | <strong>ban_duration</strong>: IP ban duration in seconds.<br /> |
| 167 | 167 | <strong>open_shaarli</strong>: Anyone can add a new link while logged out if enabled.<br /> | |
| 168 | <span class="co">// HTTP referer redirector</span> | 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 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'redirector'</span><span class="ot">]</span> = <span class="st">''</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 169 | <h3 id="resources">Resources</h3> |
| 170 | 170 | <p><strong>data_dir</strong>: Data directory.<br /> | |
| 171 | <span class="co">// Disable session hijacking</span> | 171 | <strong>datastore</strong>: Shaarli's links database file path.<br /> |
| 172 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'disablesessionprotection'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;</span> <span class="ot">[](</span>.html<span class="ot">)</span> | 172 | <strong>updates</strong>: File path for the ran updates file.<br /> |
| 173 | 173 | <strong>log</strong>: Log file path.<br /> | |
| 174 | <span class="co">// Whether new links are private by default</span> | 174 | <strong>update_check</strong>: Last update check file path.<br /> |
| 175 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'privateLinkByDefault'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;[](</span>.html<span class="ot">)</span> | 175 | <strong>raintpl_tpl</strong>: Templates directory.<br /> |
| 176 | 176 | <strong>raintpl_tmp</strong>: Template engine cache directory.<br /> | |
| 177 | <span class="co">// Enabled plugins</span> | 177 | <strong>thumbnails_cache</strong>: Thumbnails cache directory.<br /> |
| 178 | <span class="co">// Note: each plugin may provide further settings through its own "config.php"</span> | 178 | <strong>page_cache</strong>: Shaarli's internal cache directory.<br /> |
| 179 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(</span><span class="st">'addlink_toolbar'</span><span class="ot">,</span> <span class="st">'qrcode'</span><span class="ot">);](</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span><span class="st">'addlink_toolbar'</span><span class="ot">,</span>-<span class="st">'qrcode'</span><span class="ot">);</span>.html<span class="ot">)</span> | 179 | <strong>ban_file</strong>: Banned IP file path.</p> |
| 180 | 180 | <h3 id="updates">Updates</h3> | |
| 181 | <span class="co">// Subdirectory where Shaarli stores its data files.</span> | 181 | <p><strong>check_updates</strong>: Enable or disable update check to the git repository.<br /> |
| 182 | <span class="co">// You can change it for better security.</span> | 182 | <strong>check_updates_branch</strong>: Git branch used to check updates (e.g. <code>stable</code> or <code>master</code>).<br /> |
| 183 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'DATADIR'</span><span class="ot">]</span> = <span class="st">'data'</span><span class="ot">;](</span><span class="st">'DATADIR'</span><span class="ot">]</span>-=-<span class="st">'data'</span><span class="ot">;</span>.html<span class="ot">)</span> | 183 | <strong>check_updates_interval</strong>: Look for new version every N seconds (default: every day).</p> |
| 184 | 184 | <h3 id="privacy">Privacy</h3> | |
| 185 | <span class="co">// File used to store settings</span> | 185 | <p><strong>default_private_links</strong>: Check the private checkbox by default for every new link.<br /> |
| 186 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'CONFIG_FILE'</span><span class="ot">]</span> = <span class="st">'data/config.php'</span><span class="ot">;](</span><span class="st">'CONFIG_FILE'</span><span class="ot">]</span>-=-<span class="st">'data/config.php'</span><span class="ot">;</span>.html<span class="ot">)</span> | 186 | <strong>hide_public_links</strong>: All links are hidden while logged out.<br /> |
| 187 | 187 | <strong>hide_timestamps</strong>: Timestamps are hidden.</p> | |
| 188 | <span class="co">// File containing the link database</span> | 188 | <h3 id="feed">Feed</h3> |
| 189 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'DATASTORE'</span><span class="ot">]</span> = <span class="st">'data/datastore.php'</span><span class="ot">;](</span><span class="st">'DATASTORE'</span><span class="ot">]</span>-=-<span class="st">'data/datastore.php'</span><span class="ot">;</span>.html<span class="ot">)</span> | 189 | <p><strong>rss_permalinks</strong>: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.<br /> |
| 190 | 190 | <strong>show_atom</strong>: Display ATOM feed button.</p> | |
| 191 | <span class="co">// Number of links displayed per page</span> | 191 | <h3 id="thumbnail">Thumbnail</h3> |
| 192 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'LINKS_PER_PAGE'</span><span class="ot">]</span> = <span class="dv">20</span><span class="ot">;](</span><span class="st">'LINKS_PER_PAGE'</span><span class="ot">]</span>-=-<span class="dv">20</span><span class="ot">;</span>.html<span class="ot">)</span> | 192 | <p><strong>enable_thumbnails</strong>: Enable or disable thumbnail display.<br /> |
| 193 | 193 | <strong>enable_localcache</strong>: Enable or disable local cache.</p> | |
| 194 | <span class="co">// File recording failed login attempts and IP bans</span> | 194 | <h3 id="redirector">Redirector</h3> |
| 195 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'IPBANS_FILENAME'</span><span class="ot">]</span> = <span class="st">'data/ipbans.php'</span><span class="ot">;](</span><span class="st">'IPBANS_FILENAME'</span><span class="ot">]</span>-=-<span class="st">'data/ipbans.php'</span><span class="ot">;</span>.html<span class="ot">)</span> | 195 | <p><strong>url</strong>: Redirector URL, such as <code>anonym.to</code>.<br /> |
| 196 | 196 | <strong>encode_url</strong>: Enable this if the redirector needs encoded URL to work properly.</p> | |
| 197 | <span class="co">// Failed login attempts before being banned</span> | 197 | <h2 id="configuration-file-example">Configuration file example</h2> |
| 198 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'BAN_AFTER'</span><span class="ot">]</span> = <span class="dv">4</span><span class="ot">;](</span><span class="st">'BAN_AFTER'</span><span class="ot">]</span>-=-<span class="dv">4</span><span class="ot">;</span>.html<span class="ot">)</span> | 198 | <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="er"><?php</span> <span class="er">/*</span> |
| 199 | 199 | <span class="fu">{</span> | |
| 200 | <span class="co">// Duration of an IP ban, in seconds (30 minutes)</span> | 200 | <span class="dt">"credentials"</span><span class="fu">:</span> <span class="fu">{</span> |
| 201 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'BAN_DURATION'</span><span class="ot">]</span> = <span class="dv">1800</span><span class="ot">;](</span><span class="st">'BAN_DURATION'</span><span class="ot">]</span>-=-<span class="dv">1800</span><span class="ot">;</span>.html<span class="ot">)</span> | 201 | <span class="dt">"login"</span><span class="fu">:</span> <span class="st">"<login>"</span><span class="fu">,</span> |
| 202 | 202 | <span class="dt">"hash"</span><span class="fu">:</span> <span class="st">"<password hash>"</span><span class="fu">,</span> | |
| 203 | <span class="co">// If set to true, everyone will be able to add, edit and remove links,</span> | 203 | <span class="dt">"salt"</span><span class="fu">:</span> <span class="st">"<password salt>"</span> |
| 204 | <span class="co">// as well as change configuration</span> | 204 | <span class="fu">},</span> |
| 205 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'OPEN_SHAARLI'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">'OPEN_SHAARLI'</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> | 205 | <span class="dt">"security"</span><span class="fu">:</span> <span class="fu">{</span> |
| 206 | 206 | <span class="dt">"ban_after"</span><span class="fu">:</span> <span class="dv">4</span><span class="fu">,</span> | |
| 207 | <span class="co">// Do not show link timestamps</span> | 207 | <span class="dt">"session_protection_disabled"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> |
| 208 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'HIDE_TIMESTAMPS'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">'HIDE_TIMESTAMPS'</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> | 208 | <span class="dt">"ban_duration"</span><span class="fu">:</span> <span class="dv">1800</span><span class="fu">,</span> |
| 209 | 209 | <span class="dt">"trusted_proxies"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> | |
| 210 | <span class="co">// Set to false to disable local thumbnail cache, e.g. due to limited disk quotas</span> | 210 | <span class="st">"1.2.3.4"</span><span class="ot">,</span> |
| 211 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLE_THUMBNAILS'</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">'ENABLE_THUMBNAILS'</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span> | 211 | <span class="st">"5.6.7.8"</span> |
| 212 | 212 | <span class="ot">]</span> | |
| 213 | <span class="co">// Thumbnail cache directory</span> | 213 | <span class="fu">},</span> |
| 214 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'CACHEDIR'</span><span class="ot">]</span> = <span class="st">'cache'</span><span class="ot">;](</span><span class="st">'CACHEDIR'</span><span class="ot">]</span>-=-<span class="st">'cache'</span><span class="ot">;</span>.html<span class="ot">)</span> | 214 | <span class="dt">"resources"</span><span class="fu">:</span> <span class="fu">{</span> |
| 215 | 215 | <span class="dt">"data_dir"</span><span class="fu">:</span> <span class="st">"data"</span><span class="fu">,</span> | |
| 216 | <span class="co">// Enable feed (rss, atom, dailyrss) cache</span> | 216 | <span class="dt">"config"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">config.php"</span><span class="fu">,</span> |
| 217 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLE_LOCALCACHE'</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">'ENABLE_LOCALCACHE'</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span> | 217 | <span class="dt">"datastore"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">datastore.php"</span><span class="fu">,</span> |
| 218 | 218 | <span class="dt">"ban_file"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">ipbans.php"</span><span class="fu">,</span> | |
| 219 | <span class="co">// Feed cache directory</span> | 219 | <span class="dt">"updates"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">updates.txt"</span><span class="fu">,</span> |
| 220 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'PAGECACHE'</span><span class="ot">]</span> = <span class="st">'pagecache'</span><span class="ot">;](</span><span class="st">'PAGECACHE'</span><span class="ot">]</span>-=-<span class="st">'pagecache'</span><span class="ot">;</span>.html<span class="ot">)</span> | 220 | <span class="dt">"log"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">log.txt"</span><span class="fu">,</span> |
| 221 | 221 | <span class="dt">"update_check"</span><span class="fu">:</span> <span class="st">"data</span><span class="ch">\/</span><span class="st">lastupdatecheck.txt"</span><span class="fu">,</span> | |
| 222 | <span class="co">// RainTPL cache directory (keep the trailing slash!)</span> | 222 | <span class="dt">"raintpl_tmp"</span><span class="fu">:</span> <span class="st">"tmp</span><span class="ch">\/</span><span class="st">"</span><span class="fu">,</span> |
| 223 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'RAINTPL_TMP'</span><span class="ot">]</span> = <span class="st">'tmp/'</span><span class="ot">;](</span><span class="st">'RAINTPL_TMP'</span><span class="ot">]</span>-=-<span class="st">'tmp/'</span><span class="ot">;</span>.html<span class="ot">)</span> | 223 | <span class="dt">"raintpl_tpl"</span><span class="fu">:</span> <span class="st">"tpl</span><span class="ch">\/</span><span class="st">"</span><span class="fu">,</span> |
| 224 | 224 | <span class="dt">"thumbnails_cache"</span><span class="fu">:</span> <span class="st">"cache"</span><span class="fu">,</span> | |
| 225 | <span class="co">// RainTPL template directory (keep the trailing slash!)</span> | 225 | <span class="dt">"page_cache"</span><span class="fu">:</span> <span class="st">"pagecache"</span> |
| 226 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span> = <span class="st">'tpl/'</span><span class="ot">;](</span><span class="st">'RAINTPL_TPL'</span><span class="ot">]</span>-=-<span class="st">'tpl/'</span><span class="ot">;</span>.html<span class="ot">)</span> | 226 | <span class="fu">},</span> |
| 227 | 227 | <span class="dt">"general"</span><span class="fu">:</span> <span class="fu">{</span> | |
| 228 | <span class="co">// Whether Shaarli checks for new releases at https://github.com/shaarli/Shaarli</span> | 228 | <span class="dt">"check_updates"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> |
| 229 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLE_UPDATECHECK'</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">'ENABLE_UPDATECHECK'</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span> | 229 | <span class="dt">"rss_permalinks"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> |
| 230 | 230 | <span class="dt">"links_per_page"</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span> | |
| 231 | <span class="co">// File to store the latest Shaarli version</span> | 231 | <span class="dt">"default_private_links"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> |
| 232 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'UPDATECHECK_FILENAME'</span><span class="ot">]</span> = <span class="st">'data/lastupdatecheck.txt'</span><span class="ot">;](</span><span class="st">'UPDATECHECK_FILENAME'</span><span class="ot">]</span>-=-<span class="st">'data/lastupdatecheck.txt'</span><span class="ot">;</span>.html<span class="ot">)</span> | 232 | <span class="dt">"enable_thumbnails"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> |
| 233 | 233 | <span class="dt">"enable_localcache"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | |
| 234 | <span class="co">// Delay between version checks (requires to be logged in) (24 hours)</span> | 234 | <span class="dt">"check_updates_branch"</span><span class="fu">:</span> <span class="st">"stable"</span><span class="fu">,</span> |
| 235 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'UPDATECHECK_INTERVAL'</span><span class="ot">]</span> = <span class="dv">86400</span><span class="ot">;](</span><span class="st">'UPDATECHECK_INTERVAL'</span><span class="ot">]</span>-=-<span class="dv">86400</span><span class="ot">;</span>.html<span class="ot">)</span> | 235 | <span class="dt">"check_updates_interval"</span><span class="fu">:</span> <span class="dv">86400</span><span class="fu">,</span> |
| 236 | 236 | <span class="dt">"enabled_plugins"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> | |
| 237 | <span class="co">// For each link, display a link to an archived version on archive.org</span> | 237 | <span class="st">"markdown"</span><span class="ot">,</span> |
| 238 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ARCHIVE_ORG'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">'ARCHIVE_ORG'</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> | 238 | <span class="st">"wallabag"</span><span class="ot">,</span> |
| 239 | 239 | <span class="st">"archiveorg"</span> | |
| 240 | <span class="co">// The RSS item links point:</span> | 240 | <span class="ot">]</span><span class="fu">,</span> |
| 241 | <span class="co">// true => directly to the link</span> | 241 | <span class="dt">"timezone"</span><span class="fu">:</span> <span class="st">"Europe</span><span class="ch">\/</span><span class="st">Paris"</span><span class="fu">,</span> |
| 242 | <span class="co">// false => to the entry on Shaarli (permalink)</span> | 242 | <span class="dt">"title"</span><span class="fu">:</span> <span class="st">"My Shaarli"</span><span class="fu">,</span> |
| 243 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLE_RSS_PERMALINKS'</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">'ENABLE_RSS_PERMALINKS'</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span> | 243 | <span class="dt">"header_link"</span><span class="fu">:</span> <span class="st">"?"</span> |
| 244 | 244 | <span class="fu">},</span> | |
| 245 | <span class="co">// Hide all links to non-logged users</span> | 245 | <span class="dt">"extras"</span><span class="fu">:</span> <span class="fu">{</span> |
| 246 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'HIDE_PUBLIC_LINKS'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">'HIDE_PUBLIC_LINKS'</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> | 246 | <span class="dt">"show_atom"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> |
| 247 | 247 | <span class="dt">"hide_public_links"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | |
| 248 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'PUBSUBHUB_URL'</span><span class="ot">]</span> = <span class="st">''</span><span class="ot">;](</span><span class="st">'PUBSUBHUB_URL'</span><span class="ot">]</span>-=-<span class="st">''</span><span class="ot">;</span>.html<span class="ot">)</span> | 248 | <span class="dt">"hide_timestamps"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> |
| 249 | 249 | <span class="dt">"open_shaarli"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | |
| 250 | <span class="co">// Show an ATOM Feed button next to the Subscribe (RSS) button.</span> | 250 | <span class="dt">"redirector"</span><span class="fu">:</span> <span class="st">"http://anonym.to/?"</span><span class="fu">,</span> |
| 251 | <span class="co">// ATOM feeds are available at the address ?do=atom regardless of this option.</span> | 251 | <span class="dt">"redirector_encode_url"</span><span class="fu">:</span> <span class="kw">false</span> |
| 252 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'SHOW_ATOM'</span><span class="ot">]</span> = <span class="kw">false</span><span class="ot">;](</span><span class="st">'SHOW_ATOM'</span><span class="ot">]</span>-=-<span class="kw">false</span><span class="ot">;</span>.html<span class="ot">)</span> | 252 | <span class="fu">},</span> |
| 253 | 253 | <span class="dt">"general"</span><span class="fu">:</span> <span class="fu">{</span> | |
| 254 | <span class="co">// Set this to true if the redirector requires encoded URL, false otherwise.</span> | 254 | <span class="dt">"header_link"</span><span class="fu">:</span> <span class="st">"?"</span><span class="fu">,</span> |
| 255 | <span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'REDIRECTOR_URLENCODE'</span><span class="ot">]</span> = <span class="kw">true</span><span class="ot">;](</span><span class="st">'REDIRECTOR_URLENCODE'</span><span class="ot">]</span>-=-<span class="kw">true</span><span class="ot">;</span>.html<span class="ot">)</span> | 255 | <span class="dt">"links_per_page"</span><span class="fu">:</span> <span class="dv">20</span><span class="fu">,</span> |
| 256 | <span class="kw">?></span></code></pre></div> | 256 | <span class="dt">"enabled_plugins"</span><span class="fu">:</span> <span class="ot">[[]</span><span class="er">(.html)</span> |
| 257 | <span class="st">"markdown"</span><span class="ot">,</span> | ||
| 258 | <span class="st">"wallabag"</span> | ||
| 259 | <span class="ot">]</span><span class="fu">,</span> | ||
| 260 | <span class="dt">"timezone"</span><span class="fu">:</span> <span class="st">"Europe</span><span class="ch">\/</span><span class="st">Paris"</span><span class="fu">,</span> | ||
| 261 | <span class="dt">"title"</span><span class="fu">:</span> <span class="st">"My Shaarli"</span> | ||
| 262 | <span class="fu">},</span> | ||
| 263 | <span class="dt">"updates"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 264 | <span class="dt">"check_updates"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 265 | <span class="dt">"check_updates_branch"</span><span class="fu">:</span> <span class="st">"stable"</span><span class="fu">,</span> | ||
| 266 | <span class="dt">"check_updates_interval"</span><span class="fu">:</span> <span class="dv">86400</span> | ||
| 267 | <span class="fu">},</span> | ||
| 268 | <span class="dt">"feed"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 269 | <span class="dt">"rss_permalinks"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 270 | <span class="dt">"show_atom"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 271 | <span class="fu">},</span> | ||
| 272 | <span class="dt">"privacy"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 273 | <span class="dt">"default_private_links"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 274 | <span class="dt">"hide_public_links"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span> | ||
| 275 | <span class="dt">"hide_timestamps"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 276 | <span class="fu">},</span> | ||
| 277 | <span class="dt">"thumbnail"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 278 | <span class="dt">"enable_thumbnails"</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span> | ||
| 279 | <span class="dt">"enable_localcache"</span><span class="fu">:</span> <span class="kw">true</span> | ||
| 280 | <span class="fu">},</span> | ||
| 281 | <span class="dt">"redirector"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 282 | <span class="dt">"url"</span><span class="fu">:</span> <span class="st">"http://anonym.to/?"</span><span class="fu">,</span> | ||
| 283 | <span class="dt">"encode_url"</span><span class="fu">:</span> <span class="kw">false</span> | ||
| 284 | <span class="fu">},</span> | ||
| 285 | <span class="dt">"plugins"</span><span class="fu">:</span> <span class="fu">{</span> | ||
| 286 | <span class="dt">"WALLABAG_URL"</span><span class="fu">:</span> <span class="st">"http://demo.wallabag.org"</span><span class="fu">,</span> | ||
| 287 | <span class="dt">"WALLABAG_VERSION"</span><span class="fu">:</span> <span class="st">"1"</span> | ||
| 288 | <span class="fu">}</span> | ||
| 289 | <span class="fu">}</span> <span class="er">?></span></code></pre></div> | ||
| 257 | <h2 id="additional-configuration">Additional configuration</h2> | 290 | <h2 id="additional-configuration">Additional configuration</h2> |
| 258 | <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> | 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> | ||
| 259 | </body> | 294 | </body> |
| 260 | </html> | 295 | </html> |