mirror of
https://github.com/mail-in-a-box/mailinabox.git
synced 2025-04-05 00:27:25 +00:00
Additional remote Nextcloud support for port and prefix plus z-push
This commit is contained in:
downtownallday
parent
8082b06bd2
commit
844ea08845
@ -5,9 +5,9 @@
|
||||
* Descr : CalDAV backend configuration file
|
||||
************************************************/
|
||||
|
||||
define('CALDAV_PROTOCOL', 'https');
|
||||
define('CALDAV_SERVER', '127.0.0.1');
|
||||
define('CALDAV_PORT', '443');
|
||||
define('CALDAV_PROTOCOL', 'NC_PROTO');
|
||||
define('CALDAV_SERVER', 'NC_HOST');
|
||||
define('CALDAV_PORT', 'NC_PORT');
|
||||
define('CALDAV_PATH', 'NC_PREFIX/remote.php/dav/calendars/%u/');
|
||||
define('CALDAV_PERSONAL', 'PRINCIPAL');
|
||||
define('CALDAV_SUPPORTS_SYNC', false);
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
************************************************/
|
||||
|
||||
|
||||
define('CARDDAV_PROTOCOL', 'https'); /* http or https */
|
||||
define('CARDDAV_SERVER', '127.0.0.1');
|
||||
define('CARDDAV_PORT', '443');
|
||||
define('CARDDAV_PROTOCOL', 'NC_PROTO'); /* http or https */
|
||||
define('CARDDAV_SERVER', 'NC_HOST');
|
||||
define('CARDDAV_PORT', 'NC_PORT');
|
||||
define('CARDDAV_PATH', 'NC_PREFIX/remote.php/dav/addressbooks/users/%u/');
|
||||
define('CARDDAV_DEFAULT_PATH', 'NC_PREFIX/remote.php/dav/addressbooks/users/%u/contacts/'); /* subdirectory of the main path */
|
||||
define('CARDDAV_GAL_PATH', ''); /* readonly, searchable, not syncd */
|
||||
|
||||
@ -12,6 +12,7 @@
|
||||
#
|
||||
VERBOSE=0
|
||||
|
||||
|
||||
usage() {
|
||||
cat <<EOF
|
||||
Usage: $0 <NCDIR> <NC_ADMIN_USER> <NC_ADMIN_PASSWORD> <MIAB_HOSTNAME> <LDAP_NEXTCLOUD_PASS> [ <SSMTP_ALERTS_EMAIL> <SSMTP_AUTH_USER> <SSMTP_AUTH_PASS> ]
|
||||
@ -45,8 +46,8 @@ Arguments:
|
||||
1000. SSMTP_AUTH_USER / SSMTP_AUTH_PASS is the email address
|
||||
that will be used to authenticate with MiaB-LDAP (the sender
|
||||
or envelope FROM address). You probably want a new/dedicated
|
||||
email address for this - create on in the MiaB-LDAP admin
|
||||
interface. More information on ssmtp is available at
|
||||
email address for this - create a new account in the MiaB-LDAP
|
||||
admin interface. More information on ssmtp is available at
|
||||
https://help.ubuntu.com/community/EmailAlerts.
|
||||
|
||||
The script must be run as root.
|
||||
@ -140,6 +141,25 @@ LDAP_BASE="dc=mailinabox"
|
||||
LDAP_USERS_BASE="ou=Users,dc=mailinabox"
|
||||
PRIMARY_HOSTNAME="$(hostname --fqdn)"
|
||||
|
||||
#
|
||||
# get the url used to access nextcloud as NC_ADMIN_USER
|
||||
#
|
||||
NC_CONFIG_CLI_URL="$(cd "$NCDIR/config"; php -n -r 'include "config.php"; print $CONFIG["overwrite.cli.url"];')"
|
||||
case "$NC_CONFIG_CLI_URL" in
|
||||
http:* | https:* )
|
||||
urlproto=$(awk -F/ '{print $1}' <<< "$NC_CONFIG_CLI_URL")
|
||||
urlhost=$(awk -F/ '{print $3}' <<< "$NC_CONFIG_CLI_URL")
|
||||
urlprefix=$(awk -F/ "{ print substr(\$0,length(\"$urlproto\")+length(\"\
|
||||
$urlhost\")+4) }" <<<"$NC_CONFIG_CLI_URL")
|
||||
NC_AUTH_URL="$urlproto//${NC_ADMIN_USER}:${NC_ADMIN_PASSWORD}@$urlhost/\
|
||||
$urlprefix"
|
||||
;;
|
||||
* )
|
||||
NC_AUTH_URL="https://${NC_ADMIN_USER}:${NC_ADMIN_PASSWORD}@$PRIMARY_HOS\
|
||||
TNAME${NC_CONFIG_CLI_URL:-/}"
|
||||
;;
|
||||
esac
|
||||
|
||||
|
||||
say() {
|
||||
echo "$@"
|
||||
@ -159,7 +179,7 @@ die() {
|
||||
|
||||
|
||||
#
|
||||
# configure nextcloud's user-ldap to access the local ldap server
|
||||
# configure Nextcloud's user-ldap for MiaB-LDAP
|
||||
#
|
||||
# See: https://docs.nextcloud.com/server/17/admin_manual/configuration_user/user_auth_ldap_api.html
|
||||
#
|
||||
@ -181,6 +201,7 @@ config_user_ldap() {
|
||||
"--data-urlencode configData[ldapUserDisplayName]=cn"
|
||||
"--data-urlencode configData[ldapUserDisplayName2]="
|
||||
"--data-urlencode configData[ldapUserFilter]=(&(objectClass=inetOrgPerson)(objectClass=mailUser))"
|
||||
"--data-urlencode configData[ldapUserFilterMode]=1"
|
||||
"--data-urlencode configData[ldapLoginFilter]=(&(objectClass=inetOrgPerson)(objectClass=mailUser)(|(mail=%uid)(uid=%uid)))"
|
||||
"--data-urlencode configData[ldapEmailAttribute]=mail"
|
||||
|
||||
@ -200,26 +221,30 @@ config_user_ldap() {
|
||||
# apply the settings - note: we can't use localhost because nginx
|
||||
# will route to the wrong virtual host
|
||||
local xml
|
||||
say_verbose "curl \"https://${NC_ADMIN_USER}:${NC_ADMIN_PASSWORD}@$PRIMARY_HOSTNAME/ocs/v2.php/apps/user_ldap/api/v1/config/$id\""
|
||||
xml="$(curl -s -S --insecure -X PUT "https://${NC_ADMIN_USER}:${NC_ADMIN_PASSWORD}@$PRIMARY_HOSTNAME/ocs/v2.php/apps/user_ldap/api/v1/config/$id" -H "OCS-APIREQUEST: true" ${c[@]})"
|
||||
say_verbose "curl \"${NC_AUTH_URL%/}/ocs/v2.php/apps/user_ldap/api/v1/config/$id\""
|
||||
xml="$(curl -s -S --insecure -X PUT "${NC_AUTH_URL%/}/ocs/v2.php/apps/user_ldap/api/v1/config/$id" -H "OCS-APIREQUEST: true" ${c[@]})"
|
||||
[ $? -ne 0 ] &&
|
||||
die "Unable to issue a REST call as $NC_ADMIN_USER to nextcloud"
|
||||
die "Unable to issue a REST call as $NC_ADMIN_USER to nextcloud. url=$NC_AUTH_URL/ocs/v2.php/apps/user_ldap/api/v1/config/$id"
|
||||
|
||||
# did it work?
|
||||
if [ -z "$xml" ]; then
|
||||
die "Invalid response from Nextcloud using url '$NC_AUTH_URL'. reponse was '$xml'. Cannot continue."
|
||||
fi
|
||||
|
||||
local statuscode
|
||||
statuscode=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring('''$xml''').findall('meta')[0].findall('statuscode')[0].text)")
|
||||
statuscode=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring(r'''$xml''').findall('meta')[0].findall('statuscode')[0].text)")
|
||||
|
||||
if [ "$statuscode" == "404" -a "$first_call" == "yes" ]; then
|
||||
# got a 404 so maybe this is the first time -- we have to create
|
||||
# an initial blank ldap configuration and try again
|
||||
xml="$(curl -s -S --insecure -X POST "https://${NC_ADMIN_USER}:${NC_ADMIN_PASSWORD}@$PRIMARY_HOSTNAME/ocs/v2.php/apps/user_ldap/api/v1/config" -H "OCS-APIREQUEST: true")"
|
||||
xml="$(curl -s -S --insecure -X POST "${NC_AUTH_URL%/}/ocs/v2.php/apps/user_ldap/api/v1/config" -H "OCS-APIREQUEST: true")"
|
||||
[ $? -ne 0 ] &&
|
||||
die "Unable to issue a REST call as $NC_ADMIN_USER to nextcloud: $xml"
|
||||
statuscode=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring('''$xml''').findall('meta')[0].findall('statuscode')[0].text)")
|
||||
statuscode=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring(r'''$xml''').findall('meta')[0].findall('statuscode')[0].text)")
|
||||
[ $? -ne 0 -o "$statuscode" != "200" ] &&
|
||||
die "Error creating initial ldap configuration: $xml"
|
||||
|
||||
id=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring('''$xml''').findall('data')[0].findall('configID')[0].text)" 2>/dev/null)
|
||||
id=$(python3 -c "import xml.etree.ElementTree as ET; print(ET.fromstring(r'''$xml''').findall('data')[0].findall('configID')[0].text)" 2>/dev/null)
|
||||
[ $? -ne 0 ] &&
|
||||
die "Error creating initial ldap configuration: $xml"
|
||||
|
||||
@ -238,19 +263,31 @@ config_user_ldap() {
|
||||
|
||||
|
||||
enable_user_ldap() {
|
||||
# install prerequisite package
|
||||
say_verbose "Installing system package php-ldap"
|
||||
apt-get install -y -qq php-ldap || die "Could not install php-ldap package"
|
||||
#restart_service php7.2-fpm
|
||||
# install prerequisite package php-ldap
|
||||
# if using Docker Hub's php image, don't install at all
|
||||
if [ ! -e /etc/apt/preferences.d/no-debian-php ]; then
|
||||
say_verbose "Installing system package php-ldap"
|
||||
apt-get install -y -qq php-ldap || die "Could not install php-ldap package"
|
||||
#restart_service php7.2-fpm
|
||||
fi
|
||||
|
||||
# enable user_ldap
|
||||
sudo -E -u www-data php $NCDIR/occ app:enable user_ldap -q
|
||||
[ $? -ne 0 ] && die "Unable to enable user_ldap nextcloud app"
|
||||
if [ ! -x /usr/bin/sudo ]; then
|
||||
say "WARNING: sudo is not installed: Unable to run occ to check and/or enable Nextcloud app \"user-ldap\"."
|
||||
else
|
||||
say_verbose "Enable user-ldap"
|
||||
sudo -E -u www-data php $NCDIR/occ app:enable user_ldap -q
|
||||
[ $? -ne 0 ] && die "Unable to enable user_ldap nextcloud app"
|
||||
fi
|
||||
}
|
||||
|
||||
install_app() {
|
||||
local app="$1"
|
||||
if [ -z "$(sudo -E -u www-data php $NCDIR/occ app:list | grep $app)" ]; then
|
||||
if [ ! -x /usr/bin/sudo ]; then
|
||||
say "WARNING: sudo is not installed: Unable to run occ to check and/or install Nextcloud app \"$app\"."
|
||||
|
||||
elif [ -z "$(sudo -E -u www-data php $NCDIR/occ app:list | grep $app)" ]; then
|
||||
say_verbose "Install app '$app'"
|
||||
sudo -E -u www-data php $NCDIR/occ app:install $app
|
||||
[ $? -ne 0 ] && die "Unable to install Nextcloud app '$app'"
|
||||
fi
|
||||
@ -260,6 +297,11 @@ install_app() {
|
||||
setup_ssmtp() {
|
||||
# sendmail-like mailer with a mailhub to remote mail-in-a-box
|
||||
# see: https://help.ubuntu.com/community/EmailAlerts
|
||||
|
||||
if [ "$(. /etc/os-release; echo $NAME)" != "Ubuntu" ]; then
|
||||
die "Sorry, ssmtp is only supported on Ubuntu"
|
||||
fi
|
||||
|
||||
say_verbose "Installing system package ssmtp"
|
||||
apt-get install -y -qq ssmtp
|
||||
|
||||
@ -291,16 +333,18 @@ EOF
|
||||
|
||||
|
||||
remote_mailinabox_handler() {
|
||||
|
||||
say_verbose "Installing system package ldap-utils"
|
||||
apt-get install -y -qq ldap-utils || die "Could not install ldap-utils package"
|
||||
apt-get install -y -qq ldap-utils python3 || die "Could not install required packages"
|
||||
|
||||
local count=0
|
||||
local ldap_debug=""
|
||||
|
||||
while /bin/true; do
|
||||
# ensure we can search
|
||||
local output
|
||||
say ""
|
||||
say "Testing MiaB-LDAP connection..."
|
||||
output="$(ldapsearch -H $LDAP_URL -x -D "$LDAP_NEXTCLOUD_DN" -w "$LDAP_NEXTCLOUD_PASSWORD" -b "$LDAP_BASE" -s base 2>&1)"
|
||||
output="$(ldapsearch $ldap_debug -v -H $LDAP_URL -x -D "$LDAP_NEXTCLOUD_DN" -w "$LDAP_NEXTCLOUD_PASSWORD" -b "$LDAP_BASE" -s base 2>&1)"
|
||||
local code=$?
|
||||
if [ $code -ne 0 ]; then
|
||||
say "Unable to contact $LDAP_URL"
|
||||
@ -316,10 +360,16 @@ remote_mailinabox_handler() {
|
||||
say " \$ ufw allow proto tcp from $ip to any port ldaps"
|
||||
done
|
||||
say ""
|
||||
let count+=1
|
||||
if [ $count -gt 5 ]; then
|
||||
die "Giving up"
|
||||
fi
|
||||
read -p "Press [enter] when ready, or \"no\" to quit: " ans
|
||||
[ "$ans" == "no" ] && die "Quit"
|
||||
ldap_debug="-d 9"
|
||||
|
||||
else
|
||||
say "Test successful - able to bind and search as $LDAP_NEXTCLOUD_DN"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
@ -18,29 +18,22 @@ ZPUSH_DIR=/usr/local/lib/z-push
|
||||
configure_zpush() {
|
||||
# have zpush use the remote nextcloud for carddav/caldav
|
||||
# instead of the nextcloud that comes with mail-in-a-box
|
||||
local nc_host="$1"
|
||||
local nc_prefix="$2"
|
||||
[ "$nc_prefix" == "/" ] && nc_prefix=""
|
||||
|
||||
# Configure CardDav
|
||||
if [ ! -z "$nc_host" ]
|
||||
then
|
||||
cp setup/mods.available/conf/zpush/backend_carddav.php $ZPUSH_DIR/backend/carddav/config.php
|
||||
cp setup/mods.available/conf/zpush/backend_caldav.php $ZPUSH_DIR/backend/caldav/config.php
|
||||
sed -i "s/127\.0\.0\.1/$nc_host/g" $ZPUSH_DIR/backend/carddav/config.php
|
||||
sed -i "s^NC_PREFIX^$nc_prefix^g" $ZPUSH_DIR/backend/carddav/config.php
|
||||
sed -i "s/127\.0\.0\.1/$nc_host/g" $ZPUSH_DIR/backend/caldav/config.php
|
||||
sed -i "s^NC_PREFIX^$nc_prefix^g" $ZPUSH_DIR/backend/caldav/config.php
|
||||
fi
|
||||
cp setup/mods.available/conf/zpush/backend_carddav.php $ZPUSH_DIR/backend/carddav/config.php
|
||||
cp setup/mods.available/conf/zpush/backend_caldav.php $ZPUSH_DIR/backend/caldav/config.php
|
||||
local var val
|
||||
for var in NC_PROTO NC_HOST NC_PORT NC_PREFIX; do
|
||||
eval "val=\$$var"
|
||||
sed -i "s^$var^${val%/}^g" $ZPUSH_DIR/backend/carddav/config.php
|
||||
sed -i "s^$var^${val%/}^g" $ZPUSH_DIR/backend/caldav/config.php
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
configure_roundcube() {
|
||||
# replace the plugin configuration from the default Mail-In-A-Box
|
||||
local name="$1"
|
||||
local nc_host="$2"
|
||||
local nc_prefix="$3"
|
||||
[ "$nc_prefix" == "/" ] && nc_prefix=""
|
||||
local name="${1:-$NC_HOST}"
|
||||
local baseurl="$NC_PROTO://$NC_HOST:$NC_PORT$NC_PREFIX"
|
||||
|
||||
# Configure CardDav
|
||||
cat > ${RCM_PLUGIN_DIR}/carddav/config.inc.php <<EOF
|
||||
@ -52,7 +45,7 @@ configure_roundcube() {
|
||||
'name' => '$name',
|
||||
'username' => '%u', // login username
|
||||
'password' => '%p', // login password
|
||||
'url' => 'https://${nc_host}${nc_prefix}/remote.php/carddav/addressbooks/%u/contacts',
|
||||
'url' => '${baseurl%/}/remote.php/carddav/addressbooks/%u/contacts',
|
||||
'active' => true,
|
||||
'readonly' => false,
|
||||
'refresh_time' => '02:00:00',
|
||||
@ -67,57 +60,85 @@ EOF
|
||||
|
||||
|
||||
remote_nextcloud_handler() {
|
||||
echo ""
|
||||
echo "============================"
|
||||
echo "Configure a remote Nextcloud"
|
||||
echo "============================"
|
||||
echo 'Enter the hostname and web prefix of your remote Nextcloud'
|
||||
echo 'Enter the url or hostname and web prefix of your remote Nextcloud'
|
||||
echo 'For example:'
|
||||
echo ' "cloud.mydomain.com/" - Nextcloud server with no prefix'
|
||||
echo ' "cloud.mydomain.com" - same as above'
|
||||
echo ' "www.mydomain.com/cloud" - a Nextcloud server having a prefix /cloud'
|
||||
echo ''
|
||||
|
||||
local ans
|
||||
local current_url=""
|
||||
|
||||
local ans_hostname
|
||||
local ans_prefix
|
||||
|
||||
if [ -z "${NC_HOST:-}" ]; then
|
||||
if [ -z "${NONINTERACTIVE:-}" ]; then
|
||||
read -p "[your Nextcloud's hostname/prefix] " ans_hostname
|
||||
read -p "[your Nextcloud's hostname/prefix] " ans
|
||||
fi
|
||||
[ -z "$ans_hostname" ] && return 0
|
||||
[ -z "$ans" ] && return 0
|
||||
else
|
||||
current_url="$NC_PROTO://$NC_HOST:$NC_PORT$NC_PREFIX"
|
||||
if [ -z "${NONINTERACTIVE:-}" ]; then
|
||||
read -p "[$NC_HOST/$NC_PREFIX] " ans_hostname
|
||||
if [ -z "$ans_hostname" ]; then
|
||||
ans_hostname="$NC_HOST/$NC_PREFIX"
|
||||
read -p "[$current_url] " ans
|
||||
if [ -z "$ans" ]; then
|
||||
ans="$current_url"
|
||||
|
||||
elif [ "$ans_hostname" == "none" ]; then
|
||||
ans_hostname=""
|
||||
elif [ "$ans" == "none" ]; then
|
||||
ans=""
|
||||
fi
|
||||
else
|
||||
ans_hostname="${NC_HOST}${NC_PREFIX}"
|
||||
ans="$current_url"
|
||||
fi
|
||||
fi
|
||||
|
||||
ans_prefix="/$(awk -F/ '{print substr($0,length($1)+2)}' <<< "$ans_hostname")"
|
||||
ans_hostname="$(awk -F/ '{print $1}' <<< "$ans_hostname")"
|
||||
case "$ans" in
|
||||
https://* )
|
||||
NC_PROTO="https"
|
||||
NC_PORT="443"
|
||||
ans="$(awk -F: '{print substr($0,9)}' <<< "$ans")"
|
||||
;;
|
||||
http://* )
|
||||
NC_PROTO="http"
|
||||
NC_PORT="80"
|
||||
ans="$(awk -F: '{print substr($0,8)}' <<< "$ans")"
|
||||
;;
|
||||
* )
|
||||
NC_PROTO="https"
|
||||
NC_PORT="443"
|
||||
;;
|
||||
esac
|
||||
|
||||
NC_PREFIX="/$(awk -F/ '{print substr($0,length($1)+2)}' <<< "$ans")"
|
||||
NC_HOST="$(awk -F/ '{print $1}' <<< "$ans")"
|
||||
|
||||
if grep ":" <<< "$NC_HOST" >/dev/null; then
|
||||
NC_PORT="$(awk -F: '{print $2}' <<< "$NC_HOST")"
|
||||
NC_HOST="$(awk -F: '{print $1}' <<< "$NC_HOST")"
|
||||
fi
|
||||
|
||||
local new_url="$NC_PROTO://$NC_HOST:$NC_PORT$NC_PREFIX"
|
||||
|
||||
if [ ! -z "$ans_hostname" ]; then
|
||||
echo "Using Nextcloud ${ans_hostname}${ans_prefix}"
|
||||
if [ ! -z "$NC_HOST" ]; then
|
||||
echo "Using Nextcloud ${new_url}"
|
||||
|
||||
# configure roundcube contacts
|
||||
configure_roundcube "$ans_hostname" "$ans_hostname" "$ans_prefix"
|
||||
configure_roundcube "$NC_HOST"
|
||||
|
||||
# configure zpush (which links to contacts & calendar)
|
||||
configure_zpush "$ans_hostname" "$ans_prefix"
|
||||
configure_zpush
|
||||
|
||||
# prevent nginx from serving any miab-installed nextcloud files
|
||||
chmod 000 /usr/local/lib/owncloud
|
||||
fi
|
||||
|
||||
tools/editconf.py /etc/mailinabox_mods.conf \
|
||||
"NC_HOST=$ans_hostname" \
|
||||
"NC_PREFIX=$ans_prefix"
|
||||
"NC_PROTO=$NC_PROTO" \
|
||||
"NC_HOST=$NC_HOST" \
|
||||
"NC_PORT=$NC_PORT" \
|
||||
"NC_PREFIX=$NC_PREFIX"
|
||||
}
|
||||
|
||||
remote_nextcloud_handler
|
||||
|
||||
Loading…
Reference in New Issue
Block a user