X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FShaarli-configuration.md;h=2462e20e51dba615ca4d2b0b71395640e2398db3;hb=cc2ded54e12e3f3140b895067af086cd71cc5dc6;hp=0c6054596841ed255d450a782fa642e804050fdf;hpb=1fdb40fc169b42af7622610c4f088688de231118;p=github%2Fshaarli%2FShaarli.git

diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md
index 0c605459..2462e20e 100644
--- a/doc/md/Shaarli-configuration.md
+++ b/doc/md/Shaarli-configuration.md
@@ -4,7 +4,7 @@
 
 Once your Shaarli instance is installed, the file `data/config.json.php` is generated:
 * it contains all settings in JSON format, and can be edited to customize values
-* it defines which [plugins](Plugin-System) are enabled[](.html)
+* it defines which [plugins](Plugin-System) are enabled
 * its values override those defined in `index.php`
 * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration
 
@@ -32,80 +32,100 @@ On a Linux distribution:
 - to give it access to Shaarli, either:
     - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner
     - put users in the same group as the web server, and set the appropriate access rights
-- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html)
+- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly
 
 ## Configuration
 
 In `data/config.json.php`.
 
-See also [Plugin System](Plugin-System.html).
+See also [Plugin System](Plugin-System).
 
 ### Credentials
  
-> You shouldn't edit those.
+_These settings should not be edited_
 
-**login**: Login username.  
-**hash**: Generated password hash.  
-**salt**: Password salt.
+- **login**: Login username.  
+- **hash**: Generated password hash.  
+- **salt**: Password salt.
 
 ### General
 
-**title**: Shaarli's instance title.  
-**header_link**: Link to the homepage.  
-**links_per_page**: Number of shaares displayed per page.  
-**timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php).  
-**enabled_plugins**: List of enabled plugins.
+- **title**: Shaarli's instance title.  
+- **header_link**: Link to the homepage.  
+- **links_per_page**: Number of shaares displayed per page.  
+- **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php).  
+- **enabled_plugins**: List of enabled plugins.
+- **default_note_title**: Default title of a new note.
+- **retrieve_description** (boolean): If set to true, for every new links Shaarli will try
+to retrieve the description and keywords from the HTML meta tags.
 
 ### Security
 
-**session_protection_disabled**: Disable session cookie hijacking protection (not recommended). 
-It might be useful if your IP adress often changes.  
-**ban_after**: Failed login attempts before being IP banned.  
-**ban_duration**: IP ban duration in seconds.  
-**open_shaarli**: Anyone can add a new link while logged out if enabled.  
-**trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.  
-**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"]`).
+- **session_protection_disabled**: Disable session cookie hijacking protection (not recommended). 
+  It might be useful if your IP adress often changes.  
+- **ban_after**: Failed login attempts before being IP banned.  
+- **ban_duration**: IP ban duration in seconds.  
+- **open_shaarli**: Anyone can add a new link while logged out if enabled.  
+- **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.  
+- **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"]`).
 
 ### Resources
 
-**data_dir**: Data directory.  
-**datastore**: Shaarli's links database file path.  
-**history**: Shaarli's operation history file path.
-**updates**: File path for the ran updates file.  
-**log**: Log file path.  
-**update_check**: Last update check file path.  
-**raintpl_tpl**: Templates directory.  
-**raintpl_tmp**: Template engine cache directory.  
-**thumbnails_cache**: Thumbnails cache directory.  
-**page_cache**: Shaarli's internal cache directory.  
-**ban_file**: Banned IP file path.
+- **data_dir**: Data directory.  
+- **datastore**: Shaarli's links database file path.  
+- **history**: Shaarli's operation history file path.
+- **updates**: File path for the ran updates file.  
+- **log**: Log file path.  
+- **update_check**: Last update check file path.  
+- **raintpl_tpl**: Templates directory.  
+- **raintpl_tmp**: Template engine cache directory.  
+- **thumbnails_cache**: Thumbnails cache directory.  
+- **page_cache**: Shaarli's internal cache directory.  
+- **ban_file**: Banned IP file path.
+
+### Translation
+
+- **language**: translation language (also see [Translations](Translations))
+    - **auto** (default): The translation language is chosen from the browser locale. 
+    It means that the language can be different for 2 different visitors depending on their locale.  
+    - **en**: Use the English translation.
+    - **fr**: Use the French translation.
+- **mode**: 
+    - **auto** or **php** (default): Use the PHP implementation of gettext (slower)
+    - **gettext**: Use PHP builtin gettext extension 
+    (faster, but requires `php-gettext` to be installed and to reload the web server on update)
+- **extension**: Translation extensions for custom themes or plugins. 
+Must be an associative array: `translation domain => translation path`.
 
 ### Updates
 
-**check_updates**: Enable or disable update check to the git repository.  
-**check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).  
-**check_updates_interval**: Look for new version every N seconds (default: every day).
+- **check_updates**: Enable or disable update check to the git repository.  
+- **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).  
+- **check_updates_interval**: Look for new version every N seconds (default: every day).
 
 ### Privacy
 
-**default_private_links**: Check the private checkbox by default for every new link.  
-**hide_public_links**: All links are hidden while logged out.  
-**hide_timestamps**: Timestamps are hidden.
+- **default_private_links**: Check the private checkbox by default for every new link.  
+- **hide_public_links**: All links are hidden while logged out.  
+- **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page.
+- **hide_timestamps**: Timestamps are hidden.
+- **remember_user_default**: Default state of the login page's *remember me* checkbox
+    - `true`: checked by default, `false`: unchecked by default
 
 ### Feed
 
-**rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.  
-**show_atom**: Display ATOM feed button.
+- **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.  
+- **show_atom**: Display ATOM feed button.
 
 ### Thumbnail
 
-**enable_thumbnails**: Enable or disable thumbnail display.  
-**enable_localcache**: Enable or disable local cache.
+- **enable_thumbnails**: Enable or disable thumbnail display.  
+- **enable_localcache**: Enable or disable local cache.
 
-### Redirector
+### LDAP
 
-**url**: Redirector URL, such as `anonym.to`.  
-**encode_url**: Enable this if the redirector needs encoded URL to work properly.
+- **host**: LDAP host used for user authentication
+- **dn**: user DN template (`sprintf` format, `%s` being replaced by user login)
 
 ## Configuration file example
 
@@ -167,8 +187,6 @@ It might be useful if your IP adress often changes.
         "hide_public_links": false,
         "hide_timestamps": false,
         "open_shaarli": false,
-        "redirector": "http://anonym.to/?",
-        "redirector_encode_url": false
     },
     "general": {
         "header_link": "?",
@@ -192,26 +210,35 @@ It might be useful if your IP adress often changes.
     "privacy": {
         "default_private_links": true,
         "hide_public_links": false,
-        "hide_timestamps": false
+        "force_login": false,
+        "hide_timestamps": false,
+        "remember_user_default": true
     },
     "thumbnail": {
         "enable_thumbnails": true,
         "enable_localcache": true
     },
-    "redirector": {
-        "url": "http://anonym.to/?",
-        "encode_url": false
-    },
     "plugins": {
         "WALLABAG_URL": "http://demo.wallabag.org",
         "WALLABAG_VERSION": "1"
+    },
+    "translation": {
+        "language": "fr",
+        "mode": "php",
+        "extensions": {
+            "demo": "plugins/demo_plugin/languages/"
+        }
+    },
+    "ldap": {
+        "host": "ldap://localhost",
+        "dn": "uid=%s,ou=people,dc=example,dc=org"
     }
 } ?>
 ```
 
 ## Additional configuration
 
-The playvideos plugin may require that you adapt your server's 
+The `playvideos` plugin may require that you adapt your server's 
 [Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) 
-configuration to work properly.[](.html)
+configuration to work properly.