Skip to content

Commit

Permalink
Merge #1030
Browse files Browse the repository at this point in the history
1030: Update user_external example for nextcloud r=mergify[bot] a=kesselb

## What type of PR?

documentation

## What does this PR do?

Update the user_external example for Nextcloud due an upstream change. PHP will remove the imap extension. Newer user_external releases requires a different configuration for imap.

### Related issue(s)
- nextcloud/user_external#52

## Prerequistes
Before we can consider review and merge, please make sure the following list is done and checked.
If an entry in not applicable, you can check it or remove it from the list.

- [x] In case of feature or enhancement: documentation updated accordingly
- [x] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/guide.html#changelog) entry file.


Co-authored-by: Daniel Kesselberg <mail@danielkesselberg.de>
  • Loading branch information
bors[bot] and kesselb committed Jun 24, 2019
2 parents d274179 + 591f00a commit 607799e
Showing 1 changed file with 33 additions and 5 deletions.
38 changes: 33 additions & 5 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,10 +242,37 @@ correct syntax. The following file names will be taken as override configuration

*Issue reference:* `206`_.

I want to integrate Nextcloud with Mailu
I want to integrate Nextcloud 15 (and newer) with Mailu
````````````````````````````````````````

First of all you have to install dependencies required to authenticate users via imap in Nextcloud
1. Enable External user support from Nextcloud Apps interface

2. Configure additional user backends in Nextcloud’s configuration config/config.php using the following syntax if you use at least Nextcloud 15.

.. code-block:: bash
<?php
/** Use this for Nextcloud 15 and newer **/
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array(
'127.0.0.1', 993, 'ssl', 'example.com', true, false
),
),
),
If a domain name (e.g. example.com) is specified, then this makes sure that only users from this domain will be allowed to login.
After successfull login the domain part will be striped and the rest used as username in Nextcloud. e.g. 'username@example.com' will be 'username' in Nextcloud. Disable this behaviour by changing true (the fifth parameter) to false.

*Issue reference:* `575`_.

I want to integrate Nextcloud 14 (and older) with Mailu
````````````````````````````````````````

1. Install dependencies required to authenticate users via imap in Nextcloud

.. code-block:: bash
Expand All @@ -255,14 +282,15 @@ First of all you have to install dependencies required to authenticate users via
&& docker-php-ext-configure imap --with-kerberos --with-imap-ssl \
&& docker-php-ext-install imap
Next, you have to enable External user support from Nextcloud Apps interface
2. Enable External user support from Nextcloud Apps interface

In the end you need to configure additional user backends in Nextcloud’s configuration config/config.php using the following syntax:
3. Configure additional user backends in Nextcloud’s configuration config/config.php using the following syntax for Nextcloud 14 (and below):

.. code-block:: bash
<?php
/** Use this for Nextcloud 14 and older **/
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
Expand All @@ -273,7 +301,7 @@ In the end you need to configure additional user backends in Nextcloud’s confi
),
If a domain name (e.g. example.com) is specified, then this makes sure that only users from this domain will be allowed to login.
After successfull login the domain part will be striped and the rest used as username in NextCloud. e.g. 'username@example.com' will be 'username' in NextCloud.
After successfull login the domain part will be striped and the rest used as username in Nextcloud. e.g. 'username@example.com' will be 'username' in Nextcloud.

*Issue reference:* `575`_.

Expand Down

0 comments on commit 607799e

Please sign in to comment.