diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/md/Plugin-System.md | 4 | ||||
-rw-r--r-- | doc/md/Plugins.md | 2 | ||||
-rw-r--r-- | doc/md/Release-Shaarli.md | 6 | ||||
-rw-r--r-- | doc/md/Security.md | 3 | ||||
-rw-r--r-- | doc/md/Shaarli-configuration.md | 5 | ||||
-rw-r--r-- | doc/md/index.md | 2 |
6 files changed, 14 insertions, 8 deletions
diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md index 30f0ae74..cbec04c0 100644 --- a/doc/md/Plugin-System.md +++ b/doc/md/Plugin-System.md | |||
@@ -49,10 +49,10 @@ hook_<plugin_name>_<hook_name>($data, $conf) | |||
49 | 49 | ||
50 | Parameters: | 50 | Parameters: |
51 | 51 | ||
52 | - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data) | 52 | - data: see [$data section](https://shaarli.readthedocs.io/en/master/Plugin-System/#plugins-data) |
53 | - conf: the `ConfigManager` instance. | 53 | - conf: the `ConfigManager` instance. |
54 | 54 | ||
55 | For exemple, if my plugin want to add data to the header, this function is needed: | 55 | For example, if my plugin want to add data to the header, this function is needed: |
56 | 56 | ||
57 | hook_demo_plugin_render_header | 57 | hook_demo_plugin_render_header |
58 | 58 | ||
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md index 7d40637f..463dae17 100644 --- a/doc/md/Plugins.md +++ b/doc/md/Plugins.md | |||
@@ -72,4 +72,4 @@ Usage of each plugin is documented in it's README file: | |||
72 | 72 | ||
73 | #### Third party plugins | 73 | #### Third party plugins |
74 | 74 | ||
75 | See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins) | 75 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/) |
diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md index 974a7438..e22eabc9 100644 --- a/doc/md/Release-Shaarli.md +++ b/doc/md/Release-Shaarli.md | |||
@@ -46,6 +46,12 @@ TBA | |||
46 | 46 | ||
47 | 47 | ||
48 | ## Increment the version code, update docs, create and push a signed tag | 48 | ## Increment the version code, update docs, create and push a signed tag |
49 | ### Update the list of Git contributors | ||
50 | ```bash | ||
51 | $ make authors | ||
52 | $ git commit -s -m "Update AUTHORS" | ||
53 | ``` | ||
54 | |||
49 | ### Create and merge a Pull Request | 55 | ### Create and merge a Pull Request |
50 | This one is pretty straightforward ;-) | 56 | This one is pretty straightforward ;-) |
51 | 57 | ||
diff --git a/doc/md/Security.md b/doc/md/Security.md index 36f629af..65db4225 100644 --- a/doc/md/Security.md +++ b/doc/md/Security.md | |||
@@ -1,9 +1,6 @@ | |||
1 | ## Client browser | 1 | ## Client browser |
2 | - Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work | 2 | - Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work |
3 | 3 | ||
4 | ## PHP | ||
5 | - `magic_quotes` is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with `magic_quotes` on, so you should not be bothered even on crappy hosts. | ||
6 | |||
7 | ## Server and sessions | 4 | ## Server and sessions |
8 | - Directories are protected using `.htaccess` files | 5 | - Directories are protected using `.htaccess` files |
9 | - Forms are protected against XSRF (Cross-site requests forgery): | 6 | - Forms are protected against XSRF (Cross-site requests forgery): |
diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 188a3c09..d90e95eb 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md | |||
@@ -91,6 +91,8 @@ _These settings should not be edited_ | |||
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 | - **remember_user_default**: Default state of the login page's *remember me* checkbox | ||
95 | - `true`: checked by default, `false`: unchecked by default | ||
94 | 96 | ||
95 | ### Feed | 97 | ### Feed |
96 | 98 | ||
@@ -192,7 +194,8 @@ _These settings should not be edited_ | |||
192 | "privacy": { | 194 | "privacy": { |
193 | "default_private_links": true, | 195 | "default_private_links": true, |
194 | "hide_public_links": false, | 196 | "hide_public_links": false, |
195 | "hide_timestamps": false | 197 | "hide_timestamps": false, |
198 | "remember_user_default": true | ||
196 | }, | 199 | }, |
197 | "thumbnail": { | 200 | "thumbnail": { |
198 | "enable_thumbnails": true, | 201 | "enable_thumbnails": true, |
diff --git a/doc/md/index.md b/doc/md/index.md index b10e3cf4..24ada6c7 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -37,7 +37,7 @@ Login: `demo`; Password: `demo` | |||
37 | - daily RSS feed | 37 | - daily RSS feed |
38 | - permalinks for easy reference | 38 | - permalinks for easy reference |
39 | - links can be public or private | 39 | - links can be public or private |
40 | - extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) | 40 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) |
41 | 41 | ||
42 | ### Tag, view and search your links! | 42 | ### Tag, view and search your links! |
43 | - add a custom title and description to archived links | 43 | - add a custom title and description to archived links |