This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation.

Difference between revisions of "IMAP or LDAP authentication"

From Group-Office Groupware and CRM Documentation
Jump to: navigation, search
Line 1: Line 1:
<b>type</b>
+
Group-Office supports IMAP authentication. This means it will check an IMAP server for a valid account and will add/update the corresponding Group-Office account. To set this up you must install the "imapauth" module and rename "config.inc.php.example" to "config.php".
  
The type of the authentication source. In this case '”mail”. It can also be “ldap” but this is still in expirimental stages.
+
Then you must edit the values in the file. Here's a list of parameters:
 
+
<b>name</b>
+
 
+
The name of the authentication source as it will appear in a pulldown menu when there are more then one authentication sources defined.
+
 
+
<b>user_manager</b>
+
 
+
The type of user management you wish to use. This can be “sql”, 'passwd” en “ldap” zijn. By default “sql” is used. It can however be very useful to use “passwd”. With this option system accounts are changed when you change the password in Group-Office.
+
This is only possible when the mailserver runs on the local machine (“localhost”) and you must allow the Apache system users to execute the command “chpasswd”. This can be done with the program “sudo”. add the following line to /etc/sudoers using the “visudo” command:
+
apache ALL=NOPASSWD:/usr/sbin/chpasswd
+
Replace the apache username if nessecary. Also check the path of chpasswd. If this path is different then you must also change this path in “config.php”.
+
  
 
<b>proto</b>
 
<b>proto</b>
Line 28: Line 17:
 
<b>port</b>
 
<b>port</b>
  
The port . For IMAP usually 143 and for POP-3 usually 110.
+
The port. For IMAP usually 143 and for POP-3 usually 110.
  
 
<b>ssl</b>
 
<b>ssl</b>
Line 44: Line 33:
 
<b>add_domain_to_username</b>
 
<b>add_domain_to_username</b>
  
Enable this option if you need to login with the full e-mail address at the mailserver.
+
Enable this option if you want to add the domain to the username. When you enable a user with e-mail john@example.com will login with "john" but GO will send "john@example.com" to the IMAP server.
 +
 
 +
<b>go_username_without_domain</b>
 +
 
 +
When enabled the user in GO will be stored as "john". When disabled it will be stored as "john@example.com".
  
 
<b>create_email_account</b>
 
<b>create_email_account</b>
  
 
If you want to create an e-mail account in Group-Office automatically when a user logs in the first time enable this option.
 
If you want to create an e-mail account in Group-Office automatically when a user logs in the first time enable this option.
 
<b>auto_check_email</b>
 
 
Check the automatic e-mail account for new messages automatically.
 
  
 
<b>groups</b>
 
<b>groups</b>

Revision as of 11:47, 14 October 2008

Group-Office supports IMAP authentication. This means it will check an IMAP server for a valid account and will add/update the corresponding Group-Office account. To set this up you must install the "imapauth" module and rename "config.inc.php.example" to "config.php".

Then you must edit the values in the file. Here's a list of parameters:

proto

The protocol. Can be IMAP or POP-3. IMAP is highly recommended. POP-3 is slow and doesn't offer the use of multiple e-mail folders.

domain

The domain of the e-mail addresses.

host

The hostname of the machine where the mailserver runs.

port

The port. For IMAP usually 143 and for POP-3 usually 110.

ssl

SSL mode on or off

novalidate_cert

Validate the SSL certificate yes or no. with some mailservers you must enable this feature always even if you don't use SSL.

mbroot

The mailbox root. In most cases you can leave this value empty. It could be that you must enter “INBOX” or “mail” here.

add_domain_to_username

Enable this option if you want to add the domain to the username. When you enable a user with e-mail john@example.com will login with "john" but GO will send "john@example.com" to the IMAP server.

go_username_without_domain

When enabled the user in GO will be stored as "john". When disabled it will be stored as "john@example.com".

create_email_account

If you want to create an e-mail account in Group-Office automatically when a user logs in the first time enable this option.

groups

Add the new users to these user groups automatically.

visible_groups

Make new users automatically visible to these user groups.

modules_read

Grant new users read permissions to these modules.

modules_write

Grant new users administrator permissions to these modules.