diff options
Diffstat (limited to 'doc/md/Shaarli-configuration.md')
-rw-r--r-- | doc/md/Shaarli-configuration.md | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 920c7e27..664e36dd 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | Once your Shaarli instance is installed, the file `data/config.json.php` is generated: | 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 | 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) | 7 | * it defines which [plugins](Plugin-System) are enabled |
8 | * its values override those defined in `index.php` | 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 | 9 | * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration |
10 | 10 | ||
@@ -32,13 +32,13 @@ On a Linux distribution: | |||
32 | - to give it access to Shaarli, either: | 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 | 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 | 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) | 35 | - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly |
36 | 36 | ||
37 | ## Configuration | 37 | ## Configuration |
38 | 38 | ||
39 | In `data/config.json.php`. | 39 | In `data/config.json.php`. |
40 | 40 | ||
41 | See also [Plugin System](Plugin-System.html). | 41 | See also [Plugin System](Plugin-System). |
42 | 42 | ||
43 | ### Credentials | 43 | ### Credentials |
44 | 44 | ||
@@ -56,6 +56,8 @@ _These settings should not be edited_ | |||
56 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). | 56 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). |
57 | - **enabled_plugins**: List of enabled plugins. | 57 | - **enabled_plugins**: List of enabled plugins. |
58 | - **default_note_title**: Default title of a new note. | 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. | ||
59 | 61 | ||
60 | ### Security | 62 | ### Security |
61 | 63 | ||
@@ -120,11 +122,6 @@ Must be an associative array: `translation domain => translation path`. | |||
120 | - **enable_thumbnails**: Enable or disable thumbnail display. | 122 | - **enable_thumbnails**: Enable or disable thumbnail display. |
121 | - **enable_localcache**: Enable or disable local cache. | 123 | - **enable_localcache**: Enable or disable local cache. |
122 | 124 | ||
123 | ### Redirector | ||
124 | |||
125 | - **url**: Redirector URL, such as `anonym.to`. | ||
126 | - **encode_url**: Enable this if the redirector needs encoded URL to work properly. | ||
127 | |||
128 | ## Configuration file example | 125 | ## Configuration file example |
129 | 126 | ||
130 | ```json | 127 | ```json |
@@ -185,8 +182,6 @@ Must be an associative array: `translation domain => translation path`. | |||
185 | "hide_public_links": false, | 182 | "hide_public_links": false, |
186 | "hide_timestamps": false, | 183 | "hide_timestamps": false, |
187 | "open_shaarli": false, | 184 | "open_shaarli": false, |
188 | "redirector": "http://anonym.to/?", | ||
189 | "redirector_encode_url": false | ||
190 | }, | 185 | }, |
191 | "general": { | 186 | "general": { |
192 | "header_link": "?", | 187 | "header_link": "?", |
@@ -218,10 +213,6 @@ Must be an associative array: `translation domain => translation path`. | |||
218 | "enable_thumbnails": true, | 213 | "enable_thumbnails": true, |
219 | "enable_localcache": true | 214 | "enable_localcache": true |
220 | }, | 215 | }, |
221 | "redirector": { | ||
222 | "url": "http://anonym.to/?", | ||
223 | "encode_url": false | ||
224 | }, | ||
225 | "plugins": { | 216 | "plugins": { |
226 | "WALLABAG_URL": "http://demo.wallabag.org", | 217 | "WALLABAG_URL": "http://demo.wallabag.org", |
227 | "WALLABAG_VERSION": "1" | 218 | "WALLABAG_VERSION": "1" |