aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2015-03-31 20:21:21 +0200
committernodiscc <nodiscc@gmail.com>2015-03-31 20:21:21 +0200
commit2f4ab7cae2d3b1f13641a61c03d3b159b2c77379 (patch)
treefbf6fc049c43e842869b3edfd52e49b08ebc2260
parentd3b2b456e174a7a4de67bf39460749cc35a6e382 (diff)
downloadShaarli-2f4ab7cae2d3b1f13641a61c03d3b159b2c77379.tar.gz
Shaarli-2f4ab7cae2d3b1f13641a61c03d3b159b2c77379.tar.zst
Shaarli-2f4ab7cae2d3b1f13641a61c03d3b159b2c77379.zip
update doc
-rw-r--r--doc/Home.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/doc/Home.md b/doc/Home.md
index d68656e9..c80b8c92 100644
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -84,7 +84,8 @@ To change the configuration, create the file `data/options.php`, example:
84 $GLOBALS['config']['ENABLE_THUMBNAILS'] = false; 84 $GLOBALS['config']['ENABLE_THUMBNAILS'] = false;
85 ?> 85 ?>
86``` 86```
87 The following parameters are available (parameters (default value)): 87
88**Do not edit config options in index.php! Your changes would be lost when you upgrade.** The following parameters are available (parameters (default value)):
88 89
89 * `DATADIR ('data')` : This is the name of the subdirectory where Shaarli stores is data file. You can change it for better security. 90 * `DATADIR ('data')` : This is the name of the subdirectory where Shaarli stores is data file. You can change it for better security.
90 * `CONFIG_FILE ($GLOBALS['config']['DATADIR'].'/config.php')` : Name of file which is used to store login/password. 91 * `CONFIG_FILE ($GLOBALS['config']['DATADIR'].'/config.php')` : Name of file which is used to store login/password.
@@ -96,6 +97,8 @@ To change the configuration, create the file `data/options.php`, example:
96 * `OPEN_SHAARLI (false)` : If you set this option to true, anyone will be able to add/modify/delete/import/exports links without having to login. 97 * `OPEN_SHAARLI (false)` : If you set this option to true, anyone will be able to add/modify/delete/import/exports links without having to login.
97 * `HIDE_TIMESTAMPS (false)` : If you set this option to true, the date/time of each link will not be displayed (including in RSS Feed). 98 * `HIDE_TIMESTAMPS (false)` : If you set this option to true, the date/time of each link will not be displayed (including in RSS Feed).
98 * `ENABLE_THUMBNAILS (true)` : Enable/disable thumbnails. 99 * `ENABLE_THUMBNAILS (true)` : Enable/disable thumbnails.
100 * `RAINTPL_TMP (tmp/)` : Raintpl cache directory (keep the trailing slash!)
101 * `RAINTPL_TPL (tpl/) : Raintpl template directory (keep the trailing slash!). Edit this option if you want to change the rendering template (page structure) used by Shaarli. See [Changing template](#changing-template)
99 * `CACHEDIR ('cache')` : Directory where the thumbnails are stored. 102 * `CACHEDIR ('cache')` : Directory where the thumbnails are stored.
100 * `ENABLE_LOCALCACHE (true)` : If you have a limited quota on your webspace, you can set this option to false: Shaarli will not generate thumbnails which need to be cached locally (vimeo, flickr, etc.). Thumbnails will still be visible for the services which do not use the local cache (youtube.com, imgur.com, dailymotion.com, imageshack.us) 103 * `ENABLE_LOCALCACHE (true)` : If you have a limited quota on your webspace, you can set this option to false: Shaarli will not generate thumbnails which need to be cached locally (vimeo, flickr, etc.). Thumbnails will still be visible for the services which do not use the local cache (youtube.com, imgur.com, dailymotion.com, imageshack.us)
101 * `UPDATECHECK_FILENAME ($GLOBALS['config']['DATADIR'].'/lastupdatecheck.txt')` : name of the file used to store available shaarli version. 104 * `UPDATECHECK_FILENAME ($GLOBALS['config']['DATADIR'].'/lastupdatecheck.txt')` : name of the file used to store available shaarli version.
@@ -114,6 +117,18 @@ To change the configuration, create the file `data/options.php`, example:
114See also: 117See also:
115 * [Download CSS styles for shaarlis listed in an opml file](https://github.com/shaarli/Shaarli/wiki/Download-CSS-styles-for-shaarlis-listed-in-an-opml-file) 118 * [Download CSS styles for shaarlis listed in an opml file](https://github.com/shaarli/Shaarli/wiki/Download-CSS-styles-for-shaarlis-listed-in-an-opml-file)
116 119
120### Changing template
121
122| 💥 | This feature is currently being worked on and will be improved in the next releases. Experimental. |
123|---------|---------|
124
125 * Find the template you'd like to install. See the list of available templates (TODO). Find it's git clone URL or download the zip archive for the template.
126 * In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive. There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files.
127 * Edit `data/options.php` to have Shaarli use this template. Eg.
128
129`$GLOBALS['config']['RAINTPL_TPL'] = 'tpl/my-template/' ;`
130
131You can find a list of compatible templates in [Related Software](#Related-software)
117 132
118# Backup 133# Backup
119 134
@@ -205,7 +220,7 @@ Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clien
205 220
206 * [Example patch: add a new "via" field for links](Example-patch---add-new-via-field-for-links) 221 * [Example patch: add a new "via" field for links](Example-patch---add-new-via-field-for-links)
207 * [Copy a Shaarli installation over SSH SCP, serve it locally with php cli](Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli) 222 * [Copy a Shaarli installation over SSH SCP, serve it locally with php cli](Copy-a-Shaarli-installation-over-SSH-SCP,-serve-it-locally-with-php-cli)
208 * To display the array representing the data saved in datastore.php, use the following snippet 223 * To display the array representing the data saved in datastore.php, use the following snippet (TODO where is it gone?)
209 224
210### Changing timestamp for a link 225### Changing timestamp for a link
211 * Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14) 226 * Look for `<input type="hidden" name="lf_linkdate" value="{$link.linkdate}">` in `tpl/editlink.tpl` (line 14)
@@ -228,20 +243,24 @@ Unofficial but relatedd work on Shaarli. If you maintain one of these, please ge
228 243
229 * [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content 244 * [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content
230 * [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider 245 * [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider
246 * [Shaarlier for Android](https://play.google.com/store/apps/details?id=com.dimtion.shaarlier) - Android application to simply add links directly into your Shaarli
231 * [shaarli-river](https://github.com/mknexen/shaarli-river) - an aggregator for shaarlis with many features 247 * [shaarli-river](https://github.com/mknexen/shaarli-river) - an aggregator for shaarlis with many features
232 * [Shaarlo](https://github.com/DMeloni/shaarlo) - an aggregator for shaarlis with many features ([Demo](http://shaarli.fr/)) 248 * [Shaarlo](https://github.com/DMeloni/shaarlo) - an aggregator for shaarlis with many features ([Demo](http://shaarli.fr/))
233 * [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli 249 * [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli
234 * [Vinm/Blue-theme-for Shaarli](https://github.com/Vinm/Blue-theme-for-Shaarli) - A template/theme for Shaarli 250 * [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) -
251A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.
252 * [Vinm/Blue-theme-for Shaarli](https://github.com/Vinm/Blue-theme-for-Shaarli) - A template/theme for Shaarli ([unmaintained](https://github.com/Vinm/Blue-theme-for-Shaarli/issues/2), compatibility unknown)
235 * [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance 253 * [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance
236 * [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli 254 * [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli
237 * [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli 255 * [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli
238 * [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - a REST API for Shaarli 256 * [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - a REST API for Shaarli
239 * [Shaarli-Albinomouse](https://github.com/alexisju/Shaarli-AlbinoMouse) - A fork of Shaarli with a different template 257 * [Albinomouse](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli
240 * [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis 258 * [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis
241 * [Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli 259 * [Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli
242 * [Limonade](https://github.com/misterair/limonade) - A fork of Shaarli with a new template 260 * [Limonade](https://github.com/misterair/limonade) - A fork of Shaarli with a new template
243 * [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - octoprress plugin to retrieve SHaarli links on the sidebara 261 * [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - octoprress plugin to retrieve SHaarli links on the sidebara
244 * [Bookie](https://github.com/bookieio/bookie) - Another self-hostable, Free bookmark sharing software, written in Python 262 * [Bookie](https://github.com/bookieio/bookie) - Another self-hostable, Free bookmark sharing software, written in Python
263 * [Unmark](https://github.com/plainmade/unmark) - An open source to do app for bookmarks ([Homepage](https://unmark.it/))
245 264
246 265
247 266
@@ -251,7 +270,6 @@ Unofficial but relatedd work on Shaarli. If you maintain one of these, please ge
251 * [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) 270 * [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json)
252 * [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) 271 * [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list)
253 * [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ 272 * [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_
254 * [Mentions of Shaarli in the press](Mentions-of-Shaarli-in-%22the-press%22)
255 * [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) 273 * [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas)
256 * [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) 274 * [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr)
257 * [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) 275 * [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history)