2015-07-22 05:02:10 +02:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "generator" content = "pandoc" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0, user-scalable=yes" >
2016-04-14 14:20:23 +02:00
< title > Shaarli – < / title >
2015-07-22 05:02:10 +02:00
< style type = "text/css" > code { white-space : pre ; } < / style >
< style type = "text/css" >
2016-04-14 14:20:23 +02:00
div.sourceCode { overflow-x: auto; }
2015-07-22 05:02:10 +02:00
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
2016-04-14 14:20:23 +02:00
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
2015-07-22 05:02:10 +02:00
< / style >
< link rel = "stylesheet" href = "github-markdown.css" >
2016-04-14 14:20:23 +02:00
<!-- [if lt IE 9]>
< script src = "//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js" > < / script >
<![endif]-->
2015-07-22 05:02:10 +02:00
< / head >
< body >
< div id = "local-sidebar" >
< ul >
< li > < a href = "Home.html" > Home< / a > < / li >
< li > Installation
< ul >
2015-09-04 21:25:47 +02:00
< li > < a href = "Download.html" > Download< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Server-requirements.html" > Server requirements< / a > < / li >
< li > < a href = "Server-configuration.html" > Server configuration< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Server-security.html" > Server security< / a > < / li >
< li > < a href = "Shaarli-installation.html" > Shaarli installation< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Shaarli-configuration.html" > Shaarli configuration< / a > < / li >
2016-05-14 11:37:28 +02:00
< li > < a href = "Plugins.html" > Plugins< / a > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Docker.html" > Docker< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Usage.html" > Usage< / a >
< ul >
< li > < a href = "Sharing-button.html" > Sharing button< / a > (bookmarklet)< / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Browsing-and-Searching.html" > Browsing and Searching< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Firefox-share.html" > Firefox share< / a > < / li >
< li > < a href = "RSS-feeds.html" > RSS feeds< / a > < / li >
< / ul > < / li >
< li > How To
< ul >
< li > < a href = "Backup,-restore,-import-and-export.html" > Backup, restore, import and export< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Upgrade-from-original-sebsauvage/Shaarli.html" > Upgrade from original sebsauvage/Shaarli< / a > < / li >
2015-07-22 05:02:10 +02:00
< 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 >
2016-04-14 14:20:23 +02:00
< li > < a href = "Create-and-serve-multiple-Shaarlis-(farm).html" > Create and serve multiple Shaarlis (farm)< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Download-CSS-styles-from-an-OPML-list.html" > Download CSS styles from an OPML list< / a > < / li >
2015-08-18 00:33:25 +02:00
< li > < a href = "Datastore-hacks.html" > Datastore hacks< / a > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
< li > < a href = "Troubleshooting.html" > Troubleshooting< / a > < / li >
< li > < a href = "Development.html" > Development< / a >
< ul >
< li > < a href = "GnuPG-signature.html" > GnuPG signature< / a > < / li >
< li > < a href = "Coding-guidelines.html" > Coding guidelines< / a > < / li >
< li > < a href = "Directory-structure.html" > Directory structure< / a > < / li >
< li > < a href = "3rd-party-libraries.html" > 3rd party libraries< / a > < / li >
< li > < a href = "Plugin-System.html" > Plugin System< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Release-Shaarli.html" > Release Shaarli< / a > < / li >
2015-07-22 05:02:10 +02:00
< li > < a href = "Security.html" > Security< / a > < / li >
< li > < a href = "Static-analysis.html" > Static analysis< / a > < / li >
< li > < a href = "Theming.html" > Theming< / a > < / li >
< li > < a href = "Unit-tests.html" > Unit tests< / a > < / li >
< / ul > < / li >
< li > About
< ul >
< li > < a href = "FAQ.html" > FAQ< / a > < / li >
< li > < a href = "Community-&-Related-software.html" > Community & Related software< / a > < / li >
< li > < a href = "TODO.html" > TODO< / a > < / li >
< / ul > < / li >
< / ul >
< / div >
< h1 id = "shaarli-configuration" > Shaarli configuration< / h1 >
< h2 id = "foreword" > Foreword< / h2 >
< p > < strong > Do not edit configuration options in index.php! Your changes would be lost.< / strong > < / p >
< p > Once your Shaarli instance is installed, the file < code > data/config.php< / code > is generated:< / p >
< ul >
< li > it contains all settings, and can be edited to customize values< / li >
2016-04-14 14:20:23 +02:00
< li > it defines which < a href = "Plugin-System" > plugins< / a > are enabled< a href = ".html" > < / a > < / li >
2015-07-22 05:02:10 +02:00
< li > its values override those defined in < code > index.php< / code > < / li >
< / ul >
< h2 id = "file-and-directory-permissions" > File and directory permissions< / h2 >
< p > The server process running Shaarli must have:< / p >
< ul >
< li > < code > read< / code > access to the following resources:
< ul >
2016-04-14 14:20:23 +02:00
< li > PHP scripts: < code > index.php< / code > , < code > application/*.php< / code > , < code > plugins/*.php< / code > < / li >
< li > 3rd party PHP and Javascript libraries: < code > inc/*.php< / code > , < code > inc/*.js< / code > < / li >
2015-07-22 05:02:10 +02:00
< li > static assets:
< ul >
2016-04-14 14:20:23 +02:00
< li > CSS stylesheets: < code > inc/*.css< / code > < / li >
< li > < code > images/*< / code > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
2016-04-14 14:20:23 +02:00
< li > RainTPL templates: < code > tpl/*.html< / code > < / li >
2015-07-22 05:02:10 +02:00
< / ul > < / li >
< li > < code > read< / code > , < code > write< / code > and < code > execution< / code > access to the following directories:
< ul >
< li > < code > cache< / code > - thumbnail cache< / li >
< li > < code > data< / code > - link data store, configuration options< / li >
< li > < code > pagecache< / code > - Atom/RSS feed cache< / li >
< li > < code > tmp< / code > - RainTPL page cache< / li >
< / ul > < / li >
< / ul >
< p > On a Linux distribution:< / p >
< ul >
< li > the web server user will likely be < code > www< / code > or < code > http< / code > (for Apache2)< / li >
< li > it will be a member of a group of the same name: < code > www:www< / code > , < code > http:http< / code > < / li >
< li > to give it access to Shaarli, either:
< ul >
< li > unzip Shaarli in the default web server location (usually < code > /var/www/< / code > ) and set the web server user as the owner< / li >
< li > put users in the same group as the web server, and set the appropriate access rights< / li >
< / ul > < / li >
< li > if you have a domain / subdomain to serve Shaarli, < a href = "Server-configuration" > configure the server< / a > accordingly< a href = ".html" > < / a > < / li >
< / ul >
< h2 id = "example-dataconfig.php" > Example < code > data/config.php< / code > < / h2 >
2016-04-14 14:20:23 +02:00
< p > See also < a href = "Plugin-System.html" > Plugin System< / a > .< / p >
< div class = "sourceCode" > < pre class = "sourceCode php" > < code class = "sourceCode php" > < span class = "kw" > < ?php< / span >
2015-07-22 05:02:10 +02:00
< span class = "co" > // User login< / span >
< 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 >
< span class = "co" > // User password hash< / span >
< 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 >
< span class = "co" > // Password salt< / span >
< 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 >
< span class = "co" > // Local timezone< / span >
< 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 >
< span class = "fu" > date_default_timezone_set< / span > < span class = "ot" > (< / span > < span class = "st" > ' Africa/Abidjan' < / span > < span class = "ot" > );< / span >
< span class = "co" > // Shaarli title< / span >
< 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 >
< span class = "co" > // Link the Shaarli title points to< / span >
< 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 >
< span class = "co" > // HTTP referer redirector< / span >
< 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 >
< span class = "co" > // Disable session hijacking< / span >
< 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 >
< span class = "co" > // Whether new links are private by default< / span >
< 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 >
2016-04-14 14:20:23 +02:00
< span class = "co" > // Enabled plugins< / span >
< span class = "co" > // Note: each plugin may provide further settings through its own " config.php" < / span >
< 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 >
2015-07-22 05:02:10 +02:00
< span class = "co" > // Subdirectory where Shaarli stores its data files.< / span >
< span class = "co" > // You can change it for better security.< / span >
< 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 >
< span class = "co" > // File used to store settings< / span >
< 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 >
< span class = "co" > // File containing the link database< / span >
< 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 >
< span class = "co" > // Number of links displayed per page< / span >
< 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 >
< span class = "co" > // File recording failed login attempts and IP bans< / span >
< 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 >
< span class = "co" > // Failed login attempts before being banned< / span >
< 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 >
< span class = "co" > // Duration of an IP ban, in seconds (30 minutes)< / span >
< 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 >
< span class = "co" > // If set to true, everyone will be able to add, edit and remove links,< / span >
< span class = "co" > // as well as change configuration< / span >
< 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 >
< span class = "co" > // Do not show link timestamps< / span >
< 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 >
< span class = "co" > // Set to false to disable local thumbnail cache, e.g. due to limited disk quotas< / span >
< 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 >
< span class = "co" > // Thumbnail cache directory< / span >
< 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 >
< span class = "co" > // Enable feed (rss, atom, dailyrss) cache< / span >
< 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 >
< span class = "co" > // Feed cache directory< / span >
< 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 >
< span class = "co" > // RainTPL cache directory (keep the trailing slash!)< / span >
< 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 >
< span class = "co" > // RainTPL template directory (keep the trailing slash!)< / span >
< 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 >
< span class = "co" > // Whether Shaarli checks for new releases at https://github.com/shaarli/Shaarli< / span >
< 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 >
< span class = "co" > // File to store the latest Shaarli version< / span >
< 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 >
< span class = "co" > // Delay between version checks (requires to be logged in) (24 hours)< / span >
< 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 >
< span class = "co" > // For each link, display a link to an archived version on archive.org< / span >
< 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 >
< span class = "co" > // The RSS item links point:< / span >
< span class = "co" > // true => directly to the link< / span >
< span class = "co" > // false => to the entry on Shaarli (permalink)< / span >
< 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 >
< span class = "co" > // Hide all links to non-logged users< / span >
< 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 >
< 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 >
< span class = "co" > // Show an ATOM Feed button next to the Subscribe (RSS) button.< / span >
< span class = "co" > // ATOM feeds are available at the address ?do=atom regardless of this option.< / span >
< 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 >
2016-04-14 14:20:23 +02:00
< span class = "co" > // Set this to true if the redirector requires encoded URL, false otherwise.< / span >
< 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 >
< span class = "kw" > ?> < / span > < / code > < / pre > < / div >
< h2 id = "additional-configuration" > Additional configuration< / h2 >
< 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 >
2015-07-22 05:02:10 +02:00
< / body >
< / html >
