Access Keys

From PluginWiki

Jump to: navigation, search

Contents

What are Access Keys?

The plugin stores some information on a database server, kindly hosted by Nigel Mundy. The information which is stored is designed carefully for security (and to avoid any Yahoo ToS issues), but access keys ensure that the information about your group is kept even more secure.

The key must be a properly registered key, you cannot just "make one up".

What do I need one for?

You need an access key for:

It is also used by people without the plugin as a  "group password" for submitting spammers to the FCModSpammers Spammers database at https://secure.modplugin.org/submitspammer.php

How do I get one?

Before you can use this, you'll need to get a key for each group you want to monitor in this way. You can still moderate other groups if you don't have a key for them - but you won't get this function.

To get a key, go to https://secure.modplugin.org/groupkey.php . Then see below for what to do next.

How do I replace one?

You might want to do this if one of your moderators steps down to ensure that the data remains protected.

Replacement keys can also be obtained from https://secure.modplugin.org/groupkey.php You will need to provide your old group key in order to request a new key. Please check with whoever set it up in your group in the first place before you attempt this as it will affect all mods using the plugin on your group.

Any data held in the database against the old key, will be migrated to the new key when it is activated.

What if I lose it?

Keys are never reissued. If all moderators of a group (for some reason) manage to lose the group key, then email keyholder@modplugin.org (click here).

After manual verification of your moderator status, your old group key will be revoked so that you can apply for a new one.

What you do after you have your key

After you have your key(s), you must configure the plugin to use the keys for your groups. You'll need keys for each group you want to monitor messages for or to report spammers from. You access this configuration from the Features tab:

Image:ModDBButton.jpg

You'll see this configuration:

Image:ModDBConfig-Keys.jpg


  • To add a key:
    • Enter the group name in the name box. Just use the short form of the group name (e.g. EdinburghFreegle not the whole http://... name).
    • Enter the access key in the key box.
    • Click Add'..
  • To delete a key:
    • Select it in the list.
    • Click Delete.

Please note, you cannot EDIT a key - you must first delete, then add as new, your replacement key!!

Personal tools