X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FShaarli-configuration.md;h=664e36ddb48e5add03ab2390376bfcb3db3932a1;hb=3b04d19a6265b43d8593d53b682072643f12853a;hp=99b25ba785a98976c713ace111e3cbe9e55ff1ed;hpb=be9ddff2fb8706ce575e95e8cd64458411895dbe;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 99b25ba7..664e36dd 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,13 +32,13 @@ 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 @@ -56,6 +56,8 @@ _These settings should not be edited_ - **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 @@ -81,6 +83,20 @@ _These settings should not be edited_ - **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. @@ -106,11 +122,6 @@ _These settings should not be edited_ - **enable_thumbnails**: Enable or disable thumbnail display. - **enable_localcache**: Enable or disable local cache. -### Redirector - -- **url**: Redirector URL, such as `anonym.to`. -- **encode_url**: Enable this if the redirector needs encoded URL to work properly. - ## Configuration file example ```json @@ -171,8 +182,6 @@ _These settings should not be edited_ "hide_public_links": false, "hide_timestamps": false, "open_shaarli": false, - "redirector": "http://anonym.to/?", - "redirector_encode_url": false }, "general": { "header_link": "?", @@ -204,13 +213,16 @@ _These settings should not be edited_ "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/" + } } } ?> ```