$$MYSQLAuth External Auth Module$$

||include||charset.htm|| ||include||style.htm|| ||include||body.htm||
||ifdef||user_isdomadmin|| ||include||na_menu.htm|| ||endif|| ||ifequal||x_generate_by_surgemail||true|| ||else||

### $$Warning: The 'mysqlauth.ini' file that as been detected was not written by SurgeMail.$$
$$If you save any changes on this page you can loose setting and values.$$

$$You can manaully edit the file 'mysqlauth.ini' (in surgemail directory) and then updated surgemail.ini file to setup mysqlauth as your authenation module.$$
$$In your surgemail.ini file their will be a line like this$$:
g_authent_process "/usr/local/surgemail/nwauth -path /usr/local/surgemail/"
$$change to$$:
g_authent_process "/usr/local/surgemail/mysqlauth -path /usr/local/surgemail/"
||endif||

$$Configuration for ||module_name||, click "save" to complete the module configuration.$$

$$Click here for help on these settings.$$

### $$Compulsory fields$$
$$Setting$$ | $$Description$$
$$Host$$: |  | $$The IP address or domain of the host to connect to, i.e. the machine where the SQL server is listening.$$
$$Login Name$$: $$Password$$: |  | $$This is the SQL login name and password to bind with.$$
$$Mail DataBase$$: |  | $$The SQL Database name where all the user information is stored.$$
$$Mail Table$$: |  | $$The SQL Table name where all the user information is stored within the database.$$
$$Username Field$$: |  | $$The name of the Field where the username information is stored.$$
$$Password Field$$: |  | $$The name of the Field where the password information is stored.$$
$$Forward Field$$: |  | $$The name of the Field where the forwarding information is stored.$$
$$Password Encoding$$: |  | $$What encoding method passwords are stored in the ldapserver.$$

### $$Grouped Settings$$

$$Setting$$
$$This will enable all the Standard SurgeMail settings$$:
created, quota, smsto, mailaccess, mailstatus.
$$If surgemail is setup as a Proxy you will neeed this setting as well.$$
mailhost(tohost)
$$This will enable all the Standard SurgeFTP settings$$:
ftphome, ftpquota, ftpfromip, ftpgid, ftpuid, accountstatus.

### $$Advanced Settings$$

$$Setting$$ $$Description$$
$$Backup Host$$: $$This is address of the backup sql server if the main host goes down.$$
$$UID Field$$: $$This is the value returned for the UID.$$
$$MailMask Field$$: $$This is the sql field that the IP Mask is stored to verify users access.$$
$$Drop Path Field$$: $$This is the sql field that the Drop Path is stored.$$

### $$Aliasing Settings$$
$$These settings are only setup if you have setup a alias table with in your sql server. mysqlauth will only use these setting and not updated/change the values within the alias table. These settings should only be used by advance users.$$
$$Setting$$ | $$Description$$
$$Alias DataBase$$: |  | $$The SQL Database name where all the alias information is stored.$$
$$Alias Table$$: |  | $$The SQL Table name where all the alias information is stored within the database.$$
$$Alias Field$$: |  | $$The name of the Field the alias name is stored.$$
$$Username Field$$: |  | $$The name of the Field the username is stored.$$

### $$Uncommon Advance Settings$$

$$These settings should only be used by advance users.$$
$$Setting$$ $$Description$$
$$Split Domain$$: $$This is the name of the field the domain is stored.$$
$$Extended Lookup$$: $$This is the extra information atached to any lookup command.$$
$$Extended Check$$: $$This is the extra information atached to any check command.$$
$$Extended Set$$: $$This is the extra information atached to any set command.$$
$$Use SQL Update$$: $$Causes mysqlauth to use an update command when saving a user, as opposed to delete and re-create$$ note
$$Use the '{md5}' prefix for all passwords.$$

### $$Extra Settings$$

$$These settings should only be used by advance users.$$ $$Any setting which is not covered by the above will appear here.$$

use_sqlupdate: $$If you have linked tables then you require this option. Without this option users are deleted and re-added, this breaks ties between tables. Some MySQL servers versions do not support the update command, try disabling this if you cannot add users$$.