aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Shaarli-configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Shaarli-configuration.md')
-rw-r--r--doc/Shaarli-configuration.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/Shaarli-configuration.md b/doc/Shaarli-configuration.md
index 5bf70a62..d0560d79 100644
--- a/doc/Shaarli-configuration.md
+++ b/doc/Shaarli-configuration.md
@@ -5,17 +5,18 @@
5 5
6Once your Shaarli instance is installed, the file `data/config.php` is generated: 6Once your Shaarli instance is installed, the file `data/config.php` is generated:
7* it contains all settings, and can be edited to customize values 7* it contains all settings, and can be edited to customize values
8* it defines which [plugins](Plugin-System) are enabled[](.html)
8* its values override those defined in `index.php` 9* its values override those defined in `index.php`
9 10
10## File and directory permissions 11## File and directory permissions
11The server process running Shaarli must have: 12The server process running Shaarli must have:
12- `read` access to the following resources: 13- `read` access to the following resources:
13 - PHP scripts: `index.php`, `application/*.php` 14 - PHP scripts: `index.php`, `application/*.php`, `plugins/*.php`
14 - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc\*.js` 15 - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc/*.js`
15 - static assets: 16 - static assets:
16 - CSS stylesheets: `inc\*.css` 17 - CSS stylesheets: `inc/*.css`
17 - `images\*` 18 - `images/*`
18 - RainTPL templates: `tpl\*.html` 19 - RainTPL templates: `tpl/*.html`
19- `read`, `write` and `execution` access to the following directories: 20- `read`, `write` and `execution` access to the following directories:
20 - `cache` - thumbnail cache 21 - `cache` - thumbnail cache
21 - `data` - link data store, configuration options 22 - `data` - link data store, configuration options
@@ -31,6 +32,8 @@ On a Linux distribution:
31- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) 32- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html)
32 33
33## Example `data/config.php` 34## Example `data/config.php`
35See also [Plugin System](Plugin-System.html).
36
34```php 37```php
35<?php 38<?php
36// User login 39// User login
@@ -61,6 +64,10 @@ $GLOBALS['disablesessionprotection'] = false; [](.html)
61// Whether new links are private by default 64// Whether new links are private by default
62$GLOBALS['privateLinkByDefault'] = false;[](.html) 65$GLOBALS['privateLinkByDefault'] = false;[](.html)
63 66
67// Enabled plugins
68// Note: each plugin may provide further settings through its own "config.php"
69$GLOBALS['config'['ENABLED_PLUGINS'] = array('addlink_toolbar', 'qrcode');]('ENABLED_PLUGINS']-=-array('addlink_toolbar',-'qrcode');.html)
70
64// Subdirectory where Shaarli stores its data files. 71// Subdirectory where Shaarli stores its data files.
65// You can change it for better security. 72// You can change it for better security.
66$GLOBALS['config'['DATADIR'] = 'data';]('DATADIR']-=-'data';.html) 73$GLOBALS['config'['DATADIR'] = 'data';]('DATADIR']-=-'data';.html)
@@ -133,5 +140,12 @@ $GLOBALS['config'['PUBSUBHUB_URL'] = '';]('PUBSUBHUB_URL']-=-'';.html)
133// Show an ATOM Feed button next to the Subscribe (RSS) button. 140// Show an ATOM Feed button next to the Subscribe (RSS) button.
134// ATOM feeds are available at the address ?do=atom regardless of this option. 141// ATOM feeds are available at the address ?do=atom regardless of this option.
135$GLOBALS['config'['SHOW_ATOM'] = false;]('SHOW_ATOM']-=-false;.html) 142$GLOBALS['config'['SHOW_ATOM'] = false;]('SHOW_ATOM']-=-false;.html)
143
144// Set this to true if the redirector requires encoded URL, false otherwise.
145$GLOBALS['config'['REDIRECTOR_URLENCODE'] = true;]('REDIRECTOR_URLENCODE']-=-true;.html)
136?> 146?>
137``` 147```
148
149## Additional configuration
150
151The 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)