diff --git a/README.textile b/README.textile index 056f7af..8c5c039 100644 --- a/README.textile +++ b/README.textile @@ -4,13 +4,13 @@ Permit access to downloads, pages or parts of pages for a certain configurable t h2. Installation / uninstallation -p(important). Requires TXP 4.7.0+ +p(important). Requires Textpattern 4.7.0+ -Download the plugin from either "textpattern.org":http://textpattern.org/plugins/1222/smd_access_keys, or the "software page":http://stefdawson.com/sw, paste the code into the TXP _Admin->Plugins_ pane, install and enable the plugin. The table will be installed automatically unless you use the plugin from the cache directory; in which case, visit the _Extensions->Access keys_ tab and click the _Install table_ button before trying to use the plugin. +Download the plugin from either "the official Textpattern plugin repository":https://plugins.textpattern.com/plugins/smd_access_keys, the "software page":https://stefdawson.com/smd_access_keys, or "GitHub":https://github.com/Bloke/smd_access_keys/releases, paste the code into the TXP _Admin->Plugins_ pane, install and enable the plugin. The table will be installed automatically unless you use the plugin from the cache directory; in which case, visit the _Extensions->Access keys_ tab and click the _Install table_ button before trying to use the plugin. To uninstall the plugin, delete from the _Admin->Plugins_ page. The access keys table will be deleted automatically. -Visit the "forum thread":http://forum.textpattern.com/viewtopic.php?id=35996 for more info or to report on the success or otherwise of the plugin. +Visit the "forum thread":https://forum.textpattern.com/viewtopic.php?id=35996 for more info or to report on the success or otherwise of the plugin. h2. Overview @@ -37,7 +37,7 @@ Generates an access token for a given URL. Configure it using the following attr : This string is added to your url so the plugin knows it is protected content. : Default: @smd_akey@ ; %site_name% -: Whether to automatically add the site name (http://example.org) to the URL or not. Choose from: +: Whether to automatically add the site name (https://example.org) to the URL or not. Choose from: :: 0: leave the site out :: 1: add the site URL (but only if its not in the URL already) : Default: 1 @@ -82,7 +82,7 @@ bc. @ and @&@ in the item. Set @escape=""@ to turn this off. -: Defualt: @html@ +: Default: @html@ ; %format% -: If displaying a time-related item (now, issued, or expires) you can format it using the "strftime() formatting codes":http://php.net/manual/en/function.strftime.php. +: If displaying a time-related item (now, issued, or expires) you can format it using the "strftime() formatting codes":https://php.net/manual/en/function.strftime.php. : Default: @%Y-%m-%d %H:%M:%S@ ; %wraptag% : HTML tag (without angle brackets) to wrap around the output. @@ -240,6 +240,9 @@ The plugin exposes some global preference settings that govern its operation: ; %Salt length% : Number of characters to use as a salt in your secret key. The default is usually fine but if you want to alter this for greater/reduced security then do so. IMPORTANT: if you change this value, all your existing access keys become instantly invalid. : Default: 8 +; %Access key length% +: Number of characters to use as a token in your final key. The default delivers fairly long URLs so if you prefer to shorten this for ease of use, then do so. IMPORTANT notes: a) if you change this value, all your existing access keys become instantly invalid. b) the shorter the value, the easier it will be to crack. +: Default: 32 ; %Log IP addresses% : Whether you wish the plugin to log the IP address of each visitor who tries to access a protected resource : Default: no @@ -356,4 +359,4 @@ p. Ta da! h2. Author -Written by "Stef Dawson":http://stefdawson.com/contact. \ No newline at end of file +Written by "Stef Dawson":https://stefdawson.com/contact. \ No newline at end of file diff --git a/smd_access_keys.php b/smd_access_keys.php index e353f0f..4e71941 100644 --- a/smd_access_keys.php +++ b/smd_access_keys.php @@ -1435,9 +1435,9 @@ function smd_access_info($atts, $thing = null) h2. Installation / uninstallation -p(important). Requires TXP 4.7.0+ +p(important). Requires Textpattern 4.7.0+ -Download the plugin from either "textpattern.org":https://textpattern.org/plugins/1222/smd_access_keys, or the "software page":https://stefdawson.com/sw, paste the code into the TXP _Admin->Plugins_ pane, install and enable the plugin. The table will be installed automatically unless you use the plugin from the cache directory; in which case, visit the _Extensions->Access keys_ tab and click the _Install table_ button before trying to use the plugin. +Download the plugin from either "the official Textpattern plugin repository":https://plugins.textpattern.com/plugins/smd_access_keys, the "software page":https://stefdawson.com/smd_access_keys, or "GitHub":https://github.com/Bloke/smd_access_keys/releases, paste the code into the TXP _Admin->Plugins_ pane, install and enable the plugin. The table will be installed automatically unless you use the plugin from the cache directory; in which case, visit the _Extensions->Access keys_ tab and click the _Install table_ button before trying to use the plugin. To uninstall the plugin, delete from the _Admin->Plugins_ page. The access keys table will be deleted automatically. @@ -1633,7 +1633,7 @@ function smd_access_info($atts, $thing = null) : Default: @page@ ; %escape% : Whether to escape HTML entities such as @<@, @>@ and @&@ in the item. Set @escape=""@ to turn this off. -: Defualt: @html@ +: Default: @html@ ; %format% : If displaying a time-related item (now, issued, or expires) you can format it using the "strftime() formatting codes":https://php.net/manual/en/function.strftime.php. : Default: @%Y-%m-%d %H:%M:%S@