WordPress.org
Get WordPress

Plugin Directory

Changeset 1716423


Ignore:
Timestamp:
08/19/2017 07:38:06 PM (9 years ago)
Author:
igrp
Message:

Readme file update

File:
1 edited

Legend:

Unmodified
Added
Removed

  • vk-lock/trunk/readme.txt

    r1716396 r1716423  
    33333. Go to https://vk.com/editapp?act=create, and create new "VKontakte application" - set its type to 'Web-site' and specify address of your Wordpress site. Its wise to specify application Name, Description and Icon (better to match your wordpress site) - because this information will be presented by VK.COM to the user during authorization process. User will be asked if he\she trust this application to provide information about his\her name and VK groups he\she belongs to.
    3434
    35 4. Write down some VK application params: ApplicationID (its a number), and SecureKey (its a set of letters like JKdasAKdaKLKsklsjndas)
     354. Write down the following VK application params: ApplicationID (its a number), and SecureKey (its a set of letters like JKdasAKdaKLKsklsjndas)
    3636
    37 5. Go to Plugin settings at Wordpress console (Plugings -> VK Lock) and enter ApplicationID & SecureKey in proper fields
     375. Go to Plugin settings at Wordpress admin console (Plugings -> VK Lock) and enter ApplicationID & SecureKey in proper fields
     38
     396. Thats all - you may setup access for your posts\pages now
    3840
    3941
    4042== Frequently Asked Questions ==
    4143
     44= How to use plugin ? =
     45
     46Open WP admin console and go to the page\post. Go to [VK Lock] section on page edit screen (meta-box at bottom of the page).
     47Within [VK Lock] section specify:
     48
     491. URL to the VKontakte group (just copy&paste http address from your browser of the VK group main page - its like https://vk.com/club123456789), if it is not specified - plugin won't affect your page at all
     50
     512. Timelimit (date in YYYY-MM-DD format after which the access to the page will be blocked even for proper VK group members), you may leave it empty
     52
     53= How to configure plugin ? =
     54
     55Plugin has the following parameters (see at Plugings -> VK Lock menu) :
     56
     571. 'VK Application ID' - the ID of the application you have to create in VK
     58
     592. 'VK SecureKey' - security key of your VK application
     60
     613. 'Show default Password box' - as the plugin works for password protected pages, you may either show (1) or not (0) the default password box the the page
     62
     634. 'No access notice Header' - header text that be shown to the user (usually its ATTENSION or AUTHENTICATION)
     64
     655. 'No access notice text' - text that show to the user as no-access description \ explanation (there is %s param that will be replaced by VK group URL)
     66
     676. 'SingIn Button Text' - text that will be put on 'SingIn' button below the notice
     68
     697. 'No access after expiration time notice' - text that shown to the user in case timelimit was reached (there are two %s params - first one will be replaced by VK group URL, the second - by Timelimit-date)
     70
     718. 'CSS class for SingIn <div> area' - CSS classes to put set in <div> section of the no-access notice
     72
     739. 'CSS class for VK SingIn anchor' - CSS class to VK SingIn URL <a href= ...>, usually its 'button'
     74
     75= Does it slow down my site ? =
     76
     77The short answer is NO. During page load VK-Lock Plugin checks if VK URL is set, if not - nothing will happen. So the overhead is very very small. Additionally, to minimize load on VK.COM and speed up page load VK-Lock also rely on vk_lock private cookies. VK Lock set secured cookie that confirms user was properly authorized in VK.COM (cookie valid for 2-hours max).
    4278
    4379== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.