1 # Shaarli configuration
3 Once your Shaarli instance is installed, the file `data/config.json.php` is generated:
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
10 **Do not edit configuration options in index.php! Your changes would be lost.**
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.
16 ![](https://i.imgur.com/boaaibC.png)
20 - **host**: LDAP host used for user authentication
21 - **dn**: user DN template (`sprintf` format, `%s` being replaced by user login)
23 ## Configuration file example
30 "hash": "<password hash>",
31 "salt": "<password salt>"
35 "session_protection_disabled": false,
41 "allowed_protocols": [
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"
61 "check_updates": true,
62 "rss_permalinks": true,
64 "default_private_links": true,
65 "enable_thumbnails": true,
66 "enable_localcache": true,
67 "check_updates_branch": "stable",
68 "check_updates_interval": 86400,
74 "timezone": "Europe\/Paris",
75 "title": "My Shaarli",
84 "hide_public_links": false,
85 "hide_timestamps": false,
86 "open_shaarli": false,
95 "timezone": "Europe\/Paris",
99 "check_updates": true,
100 "check_updates_branch": "stable",
101 "check_updates_interval": 86400
104 "rss_permalinks": true,
108 "default_private_links": true,
109 "hide_public_links": false,
110 "force_login": false,
111 "hide_timestamps": false,
112 "remember_user_default": true
115 "enable_thumbnails": true,
116 "enable_localcache": true
119 "WALLABAG_URL": "http://demo.wallabag.org",
120 "WALLABAG_VERSION": "1"
126 "demo": "plugins/demo_plugin/languages/"
130 "host": "ldap://localhost",
131 "dn": "uid=%s,ou=people,dc=example,dc=org"
140 _These settings should not be edited_
142 - **login**: Login username.
143 - **hash**: Generated password hash.
144 - **salt**: Password salt.
148 - **title**: Shaarli's instance title.
149 - **header_link**: Link to the homepage.
150 - **links_per_page**: Number of Shaares displayed per page.
151 - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php).
152 - **enabled_plugins**: List of enabled plugins.
153 - **default_note_title**: Default title of a new note.
154 - **enable_async_metadata** (boolean): Retrieve external bookmark metadata asynchronously to prevent bookmark creation slowdown.
155 - **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.
156 - **root_url**: Overrides automatic discovery of Shaarli instance's URL (e.g.) `https://sub.domain.tld/shaarli-folder/`.
157 - **tags_separator**: Defines your tags separator (default: whitespace).
161 - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended).
162 It might be useful if your IP adress often changes.
163 - **ban_after**: Failed login attempts before being IP banned.
164 - **ban_duration**: IP ban duration in seconds.
165 - **open_shaarli**: Anyone can add a new Shaare while logged out if enabled.
166 - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.
167 - **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"]`).
171 Single string value. Default available:
173 - `default`: supports line breaks, URL and hashtag auto-links.
174 - `markdown`: supports [Markdown](https://daringfireball.net/projects/markdown/syntax).
175 - `markdownExtra`: adds [extra](https://michelf.ca/projects/php-markdown/extra/) flavor to Markdown.
177 ### Formatter Settings
179 Additional settings applied to formatters.
183 - **autolink**: boolean to enable or disable automatic linkification of URL and hashtags.
187 - **data_dir**: Data directory.
188 - **datastore**: Shaarli's Shaares database file path.
189 - **history**: Shaarli's operation history file path.
190 - **updates**: File path for the ran updates file.
191 - **log**: Log file path.
192 - **update_check**: Last update check file path.
193 - **raintpl_tpl**: Templates directory.
194 - **raintpl_tmp**: Template engine cache directory.
195 - **thumbnails_cache**: Thumbnails cache directory.
196 - **page_cache**: Shaarli's internal cache directory.
197 - **ban_file**: Banned IP file path.
201 - **language**: translation language (also see [Translations](Translations))
202 - **auto** (default): The translation language is chosen from the browser locale.
203 It means that the language can be different for 2 different visitors depending on their locale.
204 - **en**: Use the English translation.
205 - **fr**: Use the French translation.
207 - **auto** or **php** (default): Use the PHP implementation of gettext (slower)
208 - **gettext**: Use PHP builtin gettext extension
209 (faster, but requires `php-gettext` to be installed and to reload the web server on update)
210 - **extension**: Translation extensions for custom themes or plugins.
211 Must be an associative array: `translation domain => translation path`.
215 - **check_updates**: Enable or disable update check to the git repository.
216 - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).
217 - **check_updates_interval**: Look for new version every N seconds (default: every day).
221 - **default_private_links**: Check the private checkbox by default for every new Shaare.
222 - **hide_public_links**: All Shaares are hidden while logged out.
223 - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page.
224 - **hide_timestamps**: Timestamps are hidden.
225 - **remember_user_default**: Default state of the login page's *remember me* checkbox
226 - `true`: checked by default, `false`: unchecked by default
230 - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
231 - **show_atom**: Display ATOM feed button.
235 - **enable_thumbnails**: Enable or disable thumbnail display.
236 - **enable_localcache**: Enable or disable local cache.
238 ## Plugins configuration
240 See [Plugins](Plugins.md)