diff options
Diffstat (limited to 'doc/md/Shaarli-configuration.md')
-rw-r--r-- | doc/md/Shaarli-configuration.md | 71 |
1 files changed, 36 insertions, 35 deletions
diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 14eec7b2..263fb761 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md | |||
@@ -7,7 +7,7 @@ Once your Shaarli instance is installed, the file `data/config.json.php` is gene | |||
7 | - its values override those defined in `index.php` | 7 | - its values override those defined in `index.php` |
8 | - it is wrapped in a PHP comment so that its contents are never served by the web server, regardless of configuration | 8 | - it is wrapped in a PHP comment so that its contents are never served by the web server, regardless of configuration |
9 | 9 | ||
10 | **Do not edit configuration options in index.php! Your changes would be lost.** | 10 | **Do not edit configuration options in index.php! Your changes would be lost.** |
11 | 11 | ||
12 | ## Tools menu | 12 | ## Tools menu |
13 | 13 | ||
@@ -135,71 +135,72 @@ Some settings can be configured directly from a web browser by accesing the `Too | |||
135 | ## Settings | 135 | ## Settings |
136 | 136 | ||
137 | ### Credentials | 137 | ### Credentials |
138 | 138 | ||
139 | _These settings should not be edited_ | 139 | _These settings should not be edited_ |
140 | 140 | ||
141 | - **login**: Login username. | 141 | - **login**: Login username. |
142 | - **hash**: Generated password hash. | 142 | - **hash**: Generated password hash. |
143 | - **salt**: Password salt. | 143 | - **salt**: Password salt. |
144 | 144 | ||
145 | ### General | 145 | ### General |
146 | 146 | ||
147 | - **title**: Shaarli's instance title. | 147 | - **title**: Shaarli's instance title. |
148 | - **header_link**: Link to the homepage. | 148 | - **header_link**: Link to the homepage. |
149 | - **links_per_page**: Number of Shaares displayed per page. | 149 | - **links_per_page**: Number of Shaares displayed per page. |
150 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). | 150 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). |
151 | - **enabled_plugins**: List of enabled plugins. | 151 | - **enabled_plugins**: List of enabled plugins. |
152 | - **default_note_title**: Default title of a new note. | 152 | - **default_note_title**: Default title of a new note. |
153 | - **retrieve_description** (boolean): If set to true, for every new Shaare Shaarli will try to retrieve the description and keywords from the HTML meta tags. | 153 | - **retrieve_description** (boolean): If set to true, for every new Shaare Shaarli will try to retrieve the description and keywords from the HTML meta tags. |
154 | - **root_url**: Overrides automatic discovery of Shaarli instance's URL (e.g.) `https://sub.domain.tld/shaarli-folder/`. | ||
154 | 155 | ||
155 | ### Security | 156 | ### Security |
156 | 157 | ||
157 | - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended). | 158 | - **session_protection_disabled**: Disable session cookie hijacking protection (not recommended). |
158 | It might be useful if your IP adress often changes. | 159 | It might be useful if your IP adress often changes. |
159 | - **ban_after**: Failed login attempts before being IP banned. | 160 | - **ban_after**: Failed login attempts before being IP banned. |
160 | - **ban_duration**: IP ban duration in seconds. | 161 | - **ban_duration**: IP ban duration in seconds. |
161 | - **open_shaarli**: Anyone can add a new Shaare while logged out if enabled. | 162 | - **open_shaarli**: Anyone can add a new Shaare while logged out if enabled. |
162 | - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. | 163 | - **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. |
163 | - **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"]`). | 164 | - **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"]`). |
164 | 165 | ||
165 | ### Resources | 166 | ### Resources |
166 | 167 | ||
167 | - **data_dir**: Data directory. | 168 | - **data_dir**: Data directory. |
168 | - **datastore**: Shaarli's Shaares database file path. | 169 | - **datastore**: Shaarli's Shaares database file path. |
169 | - **history**: Shaarli's operation history file path. | 170 | - **history**: Shaarli's operation history file path. |
170 | - **updates**: File path for the ran updates file. | 171 | - **updates**: File path for the ran updates file. |
171 | - **log**: Log file path. | 172 | - **log**: Log file path. |
172 | - **update_check**: Last update check file path. | 173 | - **update_check**: Last update check file path. |
173 | - **raintpl_tpl**: Templates directory. | 174 | - **raintpl_tpl**: Templates directory. |
174 | - **raintpl_tmp**: Template engine cache directory. | 175 | - **raintpl_tmp**: Template engine cache directory. |
175 | - **thumbnails_cache**: Thumbnails cache directory. | 176 | - **thumbnails_cache**: Thumbnails cache directory. |
176 | - **page_cache**: Shaarli's internal cache directory. | 177 | - **page_cache**: Shaarli's internal cache directory. |
177 | - **ban_file**: Banned IP file path. | 178 | - **ban_file**: Banned IP file path. |
178 | 179 | ||
179 | ### Translation | 180 | ### Translation |
180 | 181 | ||
181 | - **language**: translation language (also see [Translations](Translations)) | 182 | - **language**: translation language (also see [Translations](Translations)) |
182 | - **auto** (default): The translation language is chosen from the browser locale. | 183 | - **auto** (default): The translation language is chosen from the browser locale. |
183 | It means that the language can be different for 2 different visitors depending on their locale. | 184 | It means that the language can be different for 2 different visitors depending on their locale. |
184 | - **en**: Use the English translation. | 185 | - **en**: Use the English translation. |
185 | - **fr**: Use the French translation. | 186 | - **fr**: Use the French translation. |
186 | - **mode**: | 187 | - **mode**: |
187 | - **auto** or **php** (default): Use the PHP implementation of gettext (slower) | 188 | - **auto** or **php** (default): Use the PHP implementation of gettext (slower) |
188 | - **gettext**: Use PHP builtin gettext extension | 189 | - **gettext**: Use PHP builtin gettext extension |
189 | (faster, but requires `php-gettext` to be installed and to reload the web server on update) | 190 | (faster, but requires `php-gettext` to be installed and to reload the web server on update) |
190 | - **extension**: Translation extensions for custom themes or plugins. | 191 | - **extension**: Translation extensions for custom themes or plugins. |
191 | Must be an associative array: `translation domain => translation path`. | 192 | Must be an associative array: `translation domain => translation path`. |
192 | 193 | ||
193 | ### Updates | 194 | ### Updates |
194 | 195 | ||
195 | - **check_updates**: Enable or disable update check to the git repository. | 196 | - **check_updates**: Enable or disable update check to the git repository. |
196 | - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). | 197 | - **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). |
197 | - **check_updates_interval**: Look for new version every N seconds (default: every day). | 198 | - **check_updates_interval**: Look for new version every N seconds (default: every day). |
198 | 199 | ||
199 | ### Privacy | 200 | ### Privacy |
200 | 201 | ||
201 | - **default_private_links**: Check the private checkbox by default for every new Shaare. | 202 | - **default_private_links**: Check the private checkbox by default for every new Shaare. |
202 | - **hide_public_links**: All Shaares are hidden while logged out. | 203 | - **hide_public_links**: All Shaares are hidden while logged out. |
203 | - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page. | 204 | - **force_login**: if **hide_public_links** and this are set to `true`, all anonymous users are redirected to the login page. |
204 | - **hide_timestamps**: Timestamps are hidden. | 205 | - **hide_timestamps**: Timestamps are hidden. |
205 | - **remember_user_default**: Default state of the login page's *remember me* checkbox | 206 | - **remember_user_default**: Default state of the login page's *remember me* checkbox |
@@ -207,14 +208,14 @@ Must be an associative array: `translation domain => translation path`. | |||
207 | 208 | ||
208 | ### Feed | 209 | ### Feed |
209 | 210 | ||
210 | - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. | 211 | - **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. |
211 | - **show_atom**: Display ATOM feed button. | 212 | - **show_atom**: Display ATOM feed button. |
212 | 213 | ||
213 | ### Thumbnail | 214 | ### Thumbnail |
214 | 215 | ||
215 | - **enable_thumbnails**: Enable or disable thumbnail display. | 216 | - **enable_thumbnails**: Enable or disable thumbnail display. |
216 | - **enable_localcache**: Enable or disable local cache. | 217 | - **enable_localcache**: Enable or disable local cache. |
217 | 218 | ||
218 | ## Plugins configuration | 219 | ## Plugins configuration |
219 | 220 | ||
220 | See [Plugins](Plugins.md) \ No newline at end of file | 221 | See [Plugins](Plugins.md) |