doc/md/Shaarli-configuration.md

   1 # Shaarli configuration
   2
   3 Once your Shaarli instance is installed, the file `data/config.json.php` is generated:
   4
   5 - it contains all settings in JSON format, and can be edited to customize values
   6 - it defines which [plugins](Plugins.md) are enabled
   7 - its values override those defined in `index.php`
   8 - it is wrapped in a PHP comment so that its contents are never served by the web server, regardless of configuration
   9
  10 **Do not edit configuration options in index.php! Your changes would be lost.**
  11
  12 ## Tools menu
  13
  14 Some settings can be configured directly from a web browser by accesing the `Tools` menu. Values are read/written to/from the configuration file.
  15
  16 ![](https://i.imgur.com/boaaibC.png)
  17
  18 ### LDAP
  19
  20 - **host**: LDAP host used for user authentication
  21 - **dn**: user DN template (`sprintf` format, `%s` being replaced by user login)
  22
  23 ## Configuration file example
  24
  25 ```json
  26 <?php /*
  27 {
  28     "credentials": {
  29         "login": "<login>",
  30         "hash": "<password hash>",
  31         "salt": "<password salt>"
  32     },
  33     "security": {
  34         "ban_after": 4,
  35         "session_protection_disabled": false,
  36         "ban_duration": 1800,
  37         "trusted_proxies": [
  38             "1.2.3.4",
  39             "5.6.7.8"
  40         ],
  41         "allowed_protocols": [
  42             "ftp",
  43             "ftps",
  44             "magnet"
  45         ]
  46     },
  47     "resources": {
  48         "data_dir": "data",
  49         "config": "data\/config.php",
  50         "datastore": "data\/datastore.php",
  51         "ban_file": "data\/ipbans.php",
  52         "updates": "data\/updates.txt",
  53         "log": "data\/log.txt",
  54         "update_check": "data\/lastupdatecheck.txt",
  55         "raintpl_tmp": "tmp\/",
  56         "raintpl_tpl": "tpl\/",
  57         "thumbnails_cache": "cache",
  58         "page_cache": "pagecache"
  59     },
  60     "general": {
  61         "check_updates": true,
  62         "rss_permalinks": true,
  63         "links_per_page": 20,
  64         "default_private_links": true,
  65         "enable_thumbnails": true,
  66         "enable_localcache": true,
  67         "check_updates_branch": "stable",
  68         "check_updates_interval": 86400,
  69         "enabled_plugins": [
  70             "markdown",
  71             "wallabag",
  72             "archiveorg"
  73         ],
  74         "timezone": "Europe\/Paris",
  75         "title": "My Shaarli",
  76         "header_link": "?"
  77     },
  78     "dev": {
  79         "debug": false,
  80     }
  81     "extras": {
  82         "show_atom": false,
  83         "hide_public_links": false,
  84         "hide_timestamps": false,
  85         "open_shaarli": false,
  86     },
  87     "general": {
  88         "header_link": "?",
  89         "links_per_page": 20,
  90         "enabled_plugins": [
  91             "markdown",
  92             "wallabag"
  93         ],
  94         "timezone": "Europe\/Paris",
  95         "title": "My Shaarli"
  96     },
  97     "updates": {
  98         "check_updates": true,
  99         "check_updates_branch": "stable",
 100         "check_updates_interval": 86400
 101     },
 102     "feed": {
 103         "rss_permalinks": true,
 104         "show_atom": false
 105     },
 106     "privacy": {
 107         "default_private_links": true,
 108         "hide_public_links": false,
 109         "force_login": false,
 110         "hide_timestamps": false,
 111         "remember_user_default": true
 112     },
 113     "thumbnail": {
 114         "enable_thumbnails": true,
 115         "enable_localcache": true
 116     },
 117     "plugins": {
 118         "WALLABAG_URL": "http://demo.wallabag.org",
 119         "WALLABAG_VERSION": "1"
 120     },
 121     "translation": {
 122         "language": "fr",
 123         "mode": "php",
 124         "extensions": {
 125             "demo": "plugins/demo_plugin/languages/"
 126         }
 127     },
 128     "ldap": {
 129         "host": "ldap://localhost",
 130         "dn": "uid=%s,ou=people,dc=example,dc=org"
 131     }
 132 } ?>
 133 ```
 134
 135 ## Settings
 136
 137 ### Credentials
 138
 139 _These settings should not be edited_
 140
 141 - **login**: Login username.
 142 - **hash**: Generated password hash.
 143 - **salt**: Password salt.
 144
 145 ### General
 146
 147 - **title**: Shaarli's instance title.
 148 - **header_link**: Link to the homepage.
 149 - **links_per_page**: Number of Shaares displayed per page.
 150 - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php).
 151 - **enabled_plugins**: List of enabled plugins.
 152 - **default_note_title**: Default title of a new note.
 153 - **enable_async_metadata** (boolean): Retrieve external bookmark metadata asynchronously to prevent bookmark creation slowdown.
 154 - **retrieve_description** (boolean): If set to true, for every new Shaare Shaarli will try to retrieve the description and keywords from the HTML meta tags.
 155 - **root_url**: Overrides automatic discovery of Shaarli instance's URL (e.g.) `https://sub.domain.tld/shaarli-folder/`.
 156
 157 ### Security
 158
 159 - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended).
 160   It might be useful if your IP adress often changes.
 161 - **ban_after**: Failed login attempts before being IP banned.
 162 - **ban_duration**: IP ban duration in seconds.
 163 - **open_shaarli**: Anyone can add a new Shaare while logged out if enabled.
 164 - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.
 165 - **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"]`).
 166
 167 ### Resources
 168
 169 - **data_dir**: Data directory.
 170 - **datastore**: Shaarli's Shaares database file path.
 171 - **history**: Shaarli's operation history file path.
 172 - **updates**: File path for the ran updates file.
 173 - **log**: Log file path.
 174 - **update_check**: Last update check file path.
 175 - **raintpl_tpl**: Templates directory.
 176 - **raintpl_tmp**: Template engine cache directory.
 177 - **thumbnails_cache**: Thumbnails cache directory.
 178 - **page_cache**: Shaarli's internal cache directory.
 179 - **ban_file**: Banned IP file path.
 180
 181 ### Translation
 182
 183 - **language**: translation language (also see [Translations](Translations))
 184     - **auto** (default): The translation language is chosen from the browser locale.
 185     It means that the language can be different for 2 different visitors depending on their locale.
 186     - **en**: Use the English translation.
 187     - **fr**: Use the French translation.
 188 - **mode**:
 189     - **auto** or **php** (default): Use the PHP implementation of gettext (slower)
 190     - **gettext**: Use PHP builtin gettext extension
 191     (faster, but requires `php-gettext` to be installed and to reload the web server on update)
 192 - **extension**: Translation extensions for custom themes or plugins.
 193 Must be an associative array: `translation domain => translation path`.
 194
 195 ### Updates
 196
 197 - **check_updates**: Enable or disable update check to the git repository.
 198 - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).
 199 - **check_updates_interval**: Look for new version every N seconds (default: every day).
 200
 201 ### Privacy
 202
 203 - **default_private_links**: Check the private checkbox by default for every new Shaare.
 204 - **hide_public_links**: All Shaares are hidden while logged out.
 205 - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page.
 206 - **hide_timestamps**: Timestamps are hidden.
 207 - **remember_user_default**: Default state of the login page's *remember me* checkbox
 208     - `true`: checked by default, `false`: unchecked by default
 209
 210 ### Feed
 211
 212 - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
 213 - **show_atom**: Display ATOM feed button.
 214
 215 ### Thumbnail
 216
 217 - **enable_thumbnails**: Enable or disable thumbnail display.
 218 - **enable_localcache**: Enable or disable local cache.
 219
 220 ## Plugins configuration
 221
 222 See [Plugins](Plugins.md)