doc/md/Shaarli-configuration.md

   1 ## Foreword
   2
   3 **Do not edit configuration options in index.php! Your changes would be lost.**
   4
   5 Once your Shaarli instance is installed, the file `data/config.json.php` is generated:
   6 * it contains all settings in JSON format, and can be edited to customize values
   7 * it defines which [plugins](Plugin-System) are enabled[](.html)
   8 * its values override those defined in `index.php`
   9 * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration
  10
  11 ## File and directory permissions
  12
  13 The server process running Shaarli must have:
  14
  15 - `read` access to the following resources:
  16     - PHP scripts: `index.php`, `application/*.php`, `plugins/*.php`
  17     - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc/*.js`
  18     - static assets:
  19         - CSS stylesheets: `inc/*.css`
  20         - `images/*`
  21     - RainTPL templates: `tpl/*.html`
  22 - `read`, `write` and `execution` access to the following directories:
  23     - `cache` - thumbnail cache
  24     - `data` - link data store, configuration options
  25     - `pagecache` - Atom/RSS feed cache
  26     - `tmp` - RainTPL page cache
  27
  28 On a Linux distribution:
  29
  30 - the web server user will likely be `www` or `http` (for Apache2)
  31 - it will be a member of a group of the same name: `www:www`, `http:http`
  32 - to give it access to Shaarli, either:
  33     - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner
  34     - put users in the same group as the web server, and set the appropriate access rights
  35 - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html)
  36
  37 ## Configuration
  38
  39 In `data/config.json.php`.
  40
  41 See also [Plugin System](Plugin-System.html).
  42
  43 ### Credentials
  44
  45 _These settings should not be edited_
  46
  47 - **login**: Login username.
  48 - **hash**: Generated password hash.
  49 - **salt**: Password salt.
  50
  51 ### General
  52
  53 - **title**: Shaarli's instance title.
  54 - **header_link**: Link to the homepage.
  55 - **links_per_page**: Number of shaares displayed per page.
  56 - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php).
  57 - **enabled_plugins**: List of enabled plugins.
  58
  59 ### Security
  60
  61 - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended).
  62   It might be useful if your IP adress often changes.
  63 - **ban_after**: Failed login attempts before being IP banned.
  64 - **ban_duration**: IP ban duration in seconds.
  65 - **open_shaarli**: Anyone can add a new link while logged out if enabled.
  66 - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.
  67 - **allowed_protocols**: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store `javascript:` links (bookmarklets) in Shaarli (default: `["ftp", "ftps", "magnet"]`).
  68
  69 ### Resources
  70
  71 - **data_dir**: Data directory.
  72 - **datastore**: Shaarli's links database file path.
  73 - **history**: Shaarli's operation history file path.
  74 - **updates**: File path for the ran updates file.
  75 - **log**: Log file path.
  76 - **update_check**: Last update check file path.
  77 - **raintpl_tpl**: Templates directory.
  78 - **raintpl_tmp**: Template engine cache directory.
  79 - **thumbnails_cache**: Thumbnails cache directory.
  80 - **page_cache**: Shaarli's internal cache directory.
  81 - **ban_file**: Banned IP file path.
  82
  83 ### Updates
  84
  85 - **check_updates**: Enable or disable update check to the git repository.
  86 - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).
  87 - **check_updates_interval**: Look for new version every N seconds (default: every day).
  88
  89 ### Privacy
  90
  91 - **default_private_links**: Check the private checkbox by default for every new link.
  92 - **hide_public_links**: All links are hidden while logged out.
  93 - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page.
  94 - **hide_timestamps**: Timestamps are hidden.
  95 - **remember_user_default**: Default state of the login page's *remember me* checkbox
  96     - `true`: checked by default, `false`: unchecked by default
  97
  98 ### Feed
  99
 100 - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
 101 - **show_atom**: Display ATOM feed button.
 102
 103 ### Thumbnail
 104
 105 - **enable_thumbnails**: Enable or disable thumbnail display.
 106 - **enable_localcache**: Enable or disable local cache.
 107
 108 ### Redirector
 109
 110 - **url**: Redirector URL, such as `anonym.to`.
 111 - **encode_url**: Enable this if the redirector needs encoded URL to work properly.
 112
 113 ## Configuration file example
 114
 115 ```json
 116 <?php /*
 117 {
 118     "credentials": {
 119         "login": "<login>",
 120         "hash": "<password hash>",
 121         "salt": "<password salt>"
 122     },
 123     "security": {
 124         "ban_after": 4,
 125         "session_protection_disabled": false,
 126         "ban_duration": 1800,
 127         "trusted_proxies": [
 128             "1.2.3.4",
 129             "5.6.7.8"
 130         ],
 131         "allowed_protocols": [
 132             "ftp",
 133             "ftps",
 134             "magnet"
 135         ]
 136     },
 137     "resources": {
 138         "data_dir": "data",
 139         "config": "data\/config.php",
 140         "datastore": "data\/datastore.php",
 141         "ban_file": "data\/ipbans.php",
 142         "updates": "data\/updates.txt",
 143         "log": "data\/log.txt",
 144         "update_check": "data\/lastupdatecheck.txt",
 145         "raintpl_tmp": "tmp\/",
 146         "raintpl_tpl": "tpl\/",
 147         "thumbnails_cache": "cache",
 148         "page_cache": "pagecache"
 149     },
 150     "general": {
 151         "check_updates": true,
 152         "rss_permalinks": true,
 153         "links_per_page": 20,
 154         "default_private_links": true,
 155         "enable_thumbnails": true,
 156         "enable_localcache": true,
 157         "check_updates_branch": "stable",
 158         "check_updates_interval": 86400,
 159         "enabled_plugins": [
 160             "markdown",
 161             "wallabag",
 162             "archiveorg"
 163         ],
 164         "timezone": "Europe\/Paris",
 165         "title": "My Shaarli",
 166         "header_link": "?"
 167     },
 168     "extras": {
 169         "show_atom": false,
 170         "hide_public_links": false,
 171         "hide_timestamps": false,
 172         "open_shaarli": false,
 173         "redirector": "http://anonym.to/?",
 174         "redirector_encode_url": false
 175     },
 176     "general": {
 177         "header_link": "?",
 178         "links_per_page": 20,
 179         "enabled_plugins": [
 180             "markdown",
 181             "wallabag"
 182         ],
 183         "timezone": "Europe\/Paris",
 184         "title": "My Shaarli"
 185     },
 186     "updates": {
 187         "check_updates": true,
 188         "check_updates_branch": "stable",
 189         "check_updates_interval": 86400
 190     },
 191     "feed": {
 192         "rss_permalinks": true,
 193         "show_atom": false
 194     },
 195     "privacy": {
 196         "default_private_links": true,
 197         "hide_public_links": false,
 198         "force_login": false,
 199         "hide_timestamps": false,
 200         "remember_user_default": true
 201     },
 202     "thumbnail": {
 203         "enable_thumbnails": true,
 204         "enable_localcache": true
 205     },
 206     "redirector": {
 207         "url": "http://anonym.to/?",
 208         "encode_url": false
 209     },
 210     "plugins": {
 211         "WALLABAG_URL": "http://demo.wallabag.org",
 212         "WALLABAG_VERSION": "1"
 213     }
 214 } ?>
 215 ```
 216
 217 ## Additional configuration
 218
 219 The `playvideos` plugin may require that you adapt your server's
 220 [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting)
 221 configuration to work properly.
 222