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
   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
  36
  37 ## Configuration
  38
  39 In `data/config.json.php`.
  40
  41 See also [Plugin System](Plugin-System).
  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 - **default_note_title**: Default title of a new note.
  59 - **retrieve_description** (boolean): If set to true, for every new links Shaarli will try
  60 to retrieve the description and keywords from the HTML meta tags.
  61
  62 ### Security
  63
  64 - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended).
  65   It might be useful if your IP adress often changes.
  66 - **ban_after**: Failed login attempts before being IP banned.
  67 - **ban_duration**: IP ban duration in seconds.
  68 - **open_shaarli**: Anyone can add a new link while logged out if enabled.
  69 - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.
  70 - **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"]`).
  71
  72 ### Resources
  73
  74 - **data_dir**: Data directory.
  75 - **datastore**: Shaarli's links database file path.
  76 - **history**: Shaarli's operation history file path.
  77 - **updates**: File path for the ran updates file.
  78 - **log**: Log file path.
  79 - **update_check**: Last update check file path.
  80 - **raintpl_tpl**: Templates directory.
  81 - **raintpl_tmp**: Template engine cache directory.
  82 - **thumbnails_cache**: Thumbnails cache directory.
  83 - **page_cache**: Shaarli's internal cache directory.
  84 - **ban_file**: Banned IP file path.
  85
  86 ### Translation
  87
  88 - **language**: translation language (also see [Translations](Translations))
  89     - **auto** (default): The translation language is chosen from the browser locale.
  90     It means that the language can be different for 2 different visitors depending on their locale.
  91     - **en**: Use the English translation.
  92     - **fr**: Use the French translation.
  93 - **mode**:
  94     - **auto** or **php** (default): Use the PHP implementation of gettext (slower)
  95     - **gettext**: Use PHP builtin gettext extension
  96     (faster, but requires `php-gettext` to be installed and to reload the web server on update)
  97 - **extension**: Translation extensions for custom themes or plugins.
  98 Must be an associative array: `translation domain => translation path`.
  99
 100 ### Updates
 101
 102 - **check_updates**: Enable or disable update check to the git repository.
 103 - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).
 104 - **check_updates_interval**: Look for new version every N seconds (default: every day).
 105
 106 ### Privacy
 107
 108 - **default_private_links**: Check the private checkbox by default for every new link.
 109 - **hide_public_links**: All links are hidden while logged out.
 110 - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page.
 111 - **hide_timestamps**: Timestamps are hidden.
 112 - **remember_user_default**: Default state of the login page's *remember me* checkbox
 113     - `true`: checked by default, `false`: unchecked by default
 114
 115 ### Feed
 116
 117 - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
 118 - **show_atom**: Display ATOM feed button.
 119
 120 ### Thumbnail
 121
 122 - **enable_thumbnails**: Enable or disable thumbnail display.
 123 - **enable_localcache**: Enable or disable local cache.
 124
 125 ## Configuration file example
 126
 127 ```json
 128 <?php /*
 129 {
 130     "credentials": {
 131         "login": "<login>",
 132         "hash": "<password hash>",
 133         "salt": "<password salt>"
 134     },
 135     "security": {
 136         "ban_after": 4,
 137         "session_protection_disabled": false,
 138         "ban_duration": 1800,
 139         "trusted_proxies": [
 140             "1.2.3.4",
 141             "5.6.7.8"
 142         ],
 143         "allowed_protocols": [
 144             "ftp",
 145             "ftps",
 146             "magnet"
 147         ]
 148     },
 149     "resources": {
 150         "data_dir": "data",
 151         "config": "data\/config.php",
 152         "datastore": "data\/datastore.php",
 153         "ban_file": "data\/ipbans.php",
 154         "updates": "data\/updates.txt",
 155         "log": "data\/log.txt",
 156         "update_check": "data\/lastupdatecheck.txt",
 157         "raintpl_tmp": "tmp\/",
 158         "raintpl_tpl": "tpl\/",
 159         "thumbnails_cache": "cache",
 160         "page_cache": "pagecache"
 161     },
 162     "general": {
 163         "check_updates": true,
 164         "rss_permalinks": true,
 165         "links_per_page": 20,
 166         "default_private_links": true,
 167         "enable_thumbnails": true,
 168         "enable_localcache": true,
 169         "check_updates_branch": "stable",
 170         "check_updates_interval": 86400,
 171         "enabled_plugins": [
 172             "markdown",
 173             "wallabag",
 174             "archiveorg"
 175         ],
 176         "timezone": "Europe\/Paris",
 177         "title": "My Shaarli",
 178         "header_link": "?"
 179     },
 180     "extras": {
 181         "show_atom": false,
 182         "hide_public_links": false,
 183         "hide_timestamps": false,
 184         "open_shaarli": false,
 185     },
 186     "general": {
 187         "header_link": "?",
 188         "links_per_page": 20,
 189         "enabled_plugins": [
 190             "markdown",
 191             "wallabag"
 192         ],
 193         "timezone": "Europe\/Paris",
 194         "title": "My Shaarli"
 195     },
 196     "updates": {
 197         "check_updates": true,
 198         "check_updates_branch": "stable",
 199         "check_updates_interval": 86400
 200     },
 201     "feed": {
 202         "rss_permalinks": true,
 203         "show_atom": false
 204     },
 205     "privacy": {
 206         "default_private_links": true,
 207         "hide_public_links": false,
 208         "force_login": false,
 209         "hide_timestamps": false,
 210         "remember_user_default": true
 211     },
 212     "thumbnail": {
 213         "enable_thumbnails": true,
 214         "enable_localcache": true
 215     },
 216     "plugins": {
 217         "WALLABAG_URL": "http://demo.wallabag.org",
 218         "WALLABAG_VERSION": "1"
 219     },
 220     "translation": {
 221         "language": "fr",
 222         "mode": "php",
 223         "extensions": {
 224             "demo": "plugins/demo_plugin/languages/"
 225         }
 226     }
 227 } ?>
 228 ```
 229
 230 ## Additional configuration
 231
 232 The `playvideos` plugin may require that you adapt your server's
 233 [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting)
 234 configuration to work properly.
 235