aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Shaarli-configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/md/Shaarli-configuration.md')
-rw-r--r--doc/md/Shaarli-configuration.md82
1 files changed, 41 insertions, 41 deletions
diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md
index 0c605459..188a3c09 100644
--- a/doc/md/Shaarli-configuration.md
+++ b/doc/md/Shaarli-configuration.md
@@ -42,70 +42,70 @@ See also [Plugin System](Plugin-System.html).
42 42
43### Credentials 43### Credentials
44 44
45> You shouldn't edit those. 45_These settings should not be edited_
46 46
47**login**: Login username. 47- **login**: Login username.
48**hash**: Generated password hash. 48- **hash**: Generated password hash.
49**salt**: Password salt. 49- **salt**: Password salt.
50 50
51### General 51### General
52 52
53**title**: Shaarli's instance title. 53- **title**: Shaarli's instance title.
54**header_link**: Link to the homepage. 54- **header_link**: Link to the homepage.
55**links_per_page**: Number of shaares displayed per page. 55- **links_per_page**: Number of shaares displayed per page.
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 58
59### Security 59### Security
60 60
61**session_protection_disabled**: Disable session cookie hijacking protection (not recommended). 61- **session_protection_disabled**: Disable session cookie hijacking protection (not recommended).
62It might be useful if your IP adress often changes. 62 It might be useful if your IP adress often changes.
63**ban_after**: Failed login attempts before being IP banned. 63- **ban_after**: Failed login attempts before being IP banned.
64**ban_duration**: IP ban duration in seconds. 64- **ban_duration**: IP ban duration in seconds.
65**open_shaarli**: Anyone can add a new link while logged out if enabled. 65- **open_shaarli**: Anyone can add a new link while logged out if enabled.
66**trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. 66- **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.
67**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"]`). 67- **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"]`).
68 68
69### Resources 69### Resources
70 70
71**data_dir**: Data directory. 71- **data_dir**: Data directory.
72**datastore**: Shaarli's links database file path. 72- **datastore**: Shaarli's links database file path.
73**history**: Shaarli's operation history file path. 73- **history**: Shaarli's operation history file path.
74**updates**: File path for the ran updates file. 74- **updates**: File path for the ran updates file.
75**log**: Log file path. 75- **log**: Log file path.
76**update_check**: Last update check file path. 76- **update_check**: Last update check file path.
77**raintpl_tpl**: Templates directory. 77- **raintpl_tpl**: Templates directory.
78**raintpl_tmp**: Template engine cache directory. 78- **raintpl_tmp**: Template engine cache directory.
79**thumbnails_cache**: Thumbnails cache directory. 79- **thumbnails_cache**: Thumbnails cache directory.
80**page_cache**: Shaarli's internal cache directory. 80- **page_cache**: Shaarli's internal cache directory.
81**ban_file**: Banned IP file path. 81- **ban_file**: Banned IP file path.
82 82
83### Updates 83### Updates
84 84
85**check_updates**: Enable or disable update check to the git repository. 85- **check_updates**: Enable or disable update check to the git repository.
86**check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). 86- **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`).
87**check_updates_interval**: Look for new version every N seconds (default: every day). 87- **check_updates_interval**: Look for new version every N seconds (default: every day).
88 88
89### Privacy 89### Privacy
90 90
91**default_private_links**: Check the private checkbox by default for every new link. 91- **default_private_links**: Check the private checkbox by default for every new link.
92**hide_public_links**: All links are hidden while logged out. 92- **hide_public_links**: All links are hidden while logged out.
93**hide_timestamps**: Timestamps are hidden. 93- **hide_timestamps**: Timestamps are hidden.
94 94
95### Feed 95### Feed
96 96
97**rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. 97- **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
98**show_atom**: Display ATOM feed button. 98- **show_atom**: Display ATOM feed button.
99 99
100### Thumbnail 100### Thumbnail
101 101
102**enable_thumbnails**: Enable or disable thumbnail display. 102- **enable_thumbnails**: Enable or disable thumbnail display.
103**enable_localcache**: Enable or disable local cache. 103- **enable_localcache**: Enable or disable local cache.
104 104
105### Redirector 105### Redirector
106 106
107**url**: Redirector URL, such as `anonym.to`. 107- **url**: Redirector URL, such as `anonym.to`.
108**encode_url**: Enable this if the redirector needs encoded URL to work properly. 108- **encode_url**: Enable this if the redirector needs encoded URL to work properly.
109 109
110## Configuration file example 110## Configuration file example
111 111
@@ -211,7 +211,7 @@ It might be useful if your IP adress often changes.
211 211
212## Additional configuration 212## Additional configuration
213 213
214The playvideos plugin may require that you adapt your server's 214The `playvideos` plugin may require that you adapt your server's
215[Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) 215[Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting)
216configuration to work properly.[](.html) 216configuration to work properly.
217 217