External Authentication
From ShockvoiceWiki
Contents |
Introduction
Shockvoice contains a system for authentication against external systems since version 0.9.4. The operation mode is matching the internal shockvoice database and the external database. If the user exists in the external Database, it will be applied to the shockvoice database.If you remove the user from the external database, shockvoice will also remove that account from the server. (If it originally came from the external one). This is for relieving administration purposes for Clanadmins. They don't have to remove access from several applications if a user leaves the clan. Remove them in your forums or LDAP and Shockvoice access is removed as well.
To use this, you have to configure the specific module in the config.xml and enable the plugin in the server plugin configuration after logging into your server with the client.
Authentication using a forum
This plugin supports authentication against a forum. Currently supported are vBulletin, Woltlab Burning Board 3 and Simple Machines Forum. To configure this plugin, look for the following section in the server's config.xml:
<plugin name="sv_auth_forum"> <forumtype></forumtype> <dbtype>mysql</dbtype> <dbserver>localhost</dbserver> <dbname></dbname> <dbuser></dbuser> <dbpassword></dbpassword> <tableprefix></tableprefix> <groupmapping></groupmapping> <exactgroups>false</exactgroups> </plugin>
For forumtype, enter "vbulletin", "wbb3" or "smf". Configure your database in the 5 db config fields. For tableprefix, you need to specify which prefix you used when installing your forum. It should be something like smf_ or vb_
Groupmapping is a method for mapping forum groups to shockvoice groups.
Format: <forumgroup>,<svgroup>,<svchannel>;<forumgroup>,<svgroup>,<svchannel>;... Example: 1,5,0;5,8,10 This will map forum group with ID 1 to Shockvoice Group with ID 5 and assign it serverwide (channel 0). Also it will map forum group with ID 5 to Shockvoice Group with ID 8 and assign it in channel with ID 10. The field exactgroups will force SV to use exactly the groups that the forum returns (meaning any additional groups in SV will be removed)
What's that? Well, this is for binding a forums group to a Shockvoice group. This will minimize the clanadmins workload as well. Example: Setup a registered group in Shockvoice. Set the accessrights for this group like chat, whiteboard etc.. You now can map this Shockvoice group with your forumsgroup for "normal" members. No registration for "normal" members will be necessary. They are automatically added to Shockvoice and moved into the defined group.
Authentication using LDAP
This plugin allows you to authenticate using LDAP protocol, for example against an Active Directory. To configure this plugin, locate the following section in the server's config.xml:
<plugin name="sv_auth_ldap"> <ldap_server>LDAP://</ldap_server> <method>secure</method> </plugin>
For ldap_server enter the URL of your server. For an Active Directory server, leave the method on "secure". For others you might need to change it to "ssl"
Authentication using Eve Online
This plugin allows you to authenticate using Eve Online API. It will verify a user using his userID, characterID and ApiKey and check that the user is member of the correct corporation.
To configure this plugin, locate the following section in the config.xml of the server:
<plugin name="sv_auth_eve"> <url>http://api.eve-online.com/char/CharacterSheet.xml.aspx</url> <corpidlist></corpidlist> </plugin>
Leave the URL as it is. It should be correct, unless the Eve API is changed. For the corpidlist enter a comma separated list of corporation IDs that should be allowed on the server. If you leave it empty, any valid Eve Accout has a login on the SV server.
After the plugin is running, you have to use the EVE characterID as your username and your userID;apiKey as password. Don't forget the semicolon to separate the two.
