From 37ef2ce6d5f893de2167cef3837cde34d0aceb44 Mon Sep 17 00:00:00 2001 From: Michael Kuron Date: Fri, 7 Jul 2017 20:59:25 +0200 Subject: [PATCH] SOGo Integrator build instructions --- docs/download/build-thunderbird-plugins.sh | 63 ++++++++++++++ docs/download/thunderbird-plugins.php | 96 ++++++++++++++++++++++ docs/third_party-thunderbird.md | 27 ++++++ mkdocs.yml | 1 + 4 files changed, 187 insertions(+) create mode 100755 docs/download/build-thunderbird-plugins.sh create mode 100644 docs/download/thunderbird-plugins.php create mode 100644 docs/third_party-thunderbird.md diff --git a/docs/download/build-thunderbird-plugins.sh b/docs/download/build-thunderbird-plugins.sh new file mode 100755 index 000000000..4db51139b --- /dev/null +++ b/docs/download/build-thunderbird-plugins.sh @@ -0,0 +1,63 @@ +#!/bin/bash + +set -e + +MAILHOST=$1 + +cd $(dirname $0) + +wget -O integrator.tar.gz https://github.com/inverse-inc/sogo-integrator.tb31/archive/master.tar.gz +wget -O connector.tar.gz https://github.com/inverse-inc/sogo-connector.tb31/archive/master.tar.gz + +mkdir -p integrator connector +tar --strip-components=1 -C integrator -xf integrator.tar.gz +tar --strip-components=1 -C connector -xf connector.tar.gz + +# build custom integrator +while read DOMAINS; do + for DOMAIN in $DOMAINS; do + echo "Building SOGo Integrator for $DOMAIN hosted on $MAILHOST" + cd integrator + echo > defaults/preferences/site.js + mkdir -p custom/${DOMAIN} + cp -r custom/sogo-demo/* custom/${DOMAIN}/ + sed -i "s/http:\/\/sogo-demo\.inverse\.ca/https:\/\/${MAILHOST}/g" custom/${DOMAIN}/chrome/content/extensions.rdf + sed -i "s/plugins\/updates\.php[?]/thunderbird-plugins.php?domain=${DOMAIN}\&/g" custom/${DOMAIN}/chrome/content/extensions.rdf + echo 'pref("sogo-integrator.autocomplete.server.urlid", "'${DOMAIN}'");' > custom/${DOMAIN}/defaults/preferences/site.js + echo 'pref("mail.collect_email_address_outgoing", false);' >> custom/${DOMAIN}/defaults/preferences/site.js + sed -i 's/<\/Seq>/
  • <\/li>
  • <\/li><\/Seq>/g' custom/${DOMAIN}/chrome/content/extensions.rdf + make build=${DOMAIN} + INTEGRATOR_VER=$(grep em:version install.rdf | awk -F '"' '{print $2}') + cp sogo-integrator-*-${DOMAIN}.xpi ../sogo-integrator-${INTEGRATOR_VER}-${DOMAIN}.xpi + cd .. + done +done + +# build connector +cd connector +make +CONNECTOR_VER=$(grep em:version install.rdf | awk -F '"' '{print $2}') +cp sogo-connector-*.xpi ../sogo-connector-${CONNECTOR_VER}.xpi +cd .. + +# download Sieve plugin +SIEVE_RELEASES=$(wget --header="Accept: application/vnd.github.v3+json" -qO - https://api.github.com/repos/thsmi/sieve/releases) +SIEVE_VER=$(echo "$SIEVE_RELEASES" | grep -o '"tag_name": *"[^"]*"' | head -n 1 | awk -F '"' '{print $4}') +SIEVE_URL=$(echo "$SIEVE_RELEASES" | grep -o '"browser_download_url": *"[^"]*"' | head -n 1 | awk -F '"' '{print $4}') +wget -O sieve-${SIEVE_VER}.xpi ${SIEVE_URL} +unset SIEVE_RELEASES + +# download ACL plugin +IMAP_ACL_RELEASES=$(wget -qO - 'https://addons.mozilla.org/api/v3/addons/addon/176736') +IMAP_ACL_VER=$(echo "$IMAP_ACL_RELEASES" | grep -o '"version": *"[^"]*"' | head -n 1 | awk -F '"' '{print $4}') +IMAP_ACL_URL=$(echo "$IMAP_ACL_RELEASES" | grep -o '"url": *"[^"]*\.xpi' | head -n 1 | awk -F '"' '{print $4}') +wget -O imap_acl_extension-${IMAP_ACL_VER}-tb.xpi ${IMAP_ACL_URL} +unset IMAP_ACL_RELEASES + +# update version file +echo "sogo-connector@inverse.ca;${CONNECTOR_VER};sogo-connector-${CONNECTOR_VER}.xpi" > version.csv +echo "sogo-integrator@inverse.ca;${INTEGRATOR_VER};sogo-integrator-${INTEGRATOR_VER}-__DOMAIN__.xpi" >> version.csv +echo "sieve@mozdev.org;${SIEVE_VER};sieve-${SIEVE_VER}.xpi" >> version.csv +echo "imap-acl@sirphreak.com;${IMAP_ACL_VER};imap_acl_extension-${IMAP_ACL_VER}-tb.xpi" >> version.csv + +rm -rf connector integrator *.tar.gz diff --git a/docs/download/thunderbird-plugins.php b/docs/download/thunderbird-plugins.php new file mode 100644 index 000000000..8a1a7e9bb --- /dev/null +++ b/docs/download/thunderbird-plugins.php @@ -0,0 +1,96 @@ + 'thunderbird', + 'version' => $row[1], + 'filename' => str_replace('__DOMAIN__', $_GET["domain"], $row[2]), + ); + } + fclose($fh); + } +} + +$applications += array( "thunderbird" => "{3550f703-e582-4d05-9a08-453d09bdfdc6} + 31.0 + 31.*" ); + +$pluginname = $_GET["plugin"]; +$plugin =& $plugins[$pluginname]; +$application =& $applications[$plugin["application"]]; + +if ( $plugin ) { + $platform = $_GET["platform"]; + if ( $platform + && file_exists( $platform . "/" . $plugin["filename"] ) ) { + $plugin["filename"] = $platform . "/" . $plugin["filename"]; + } + elseif ( !file_exists( $plugin["filename"] ) ) { + $plugin = false; + } +} + +if ( $plugin ) { + header("Content-type: text/xml; charset=utf-8"); + echo ('' . "\n"); +?> + + + + + +
  • + + + + + + + + + + +
    • + + + + + diff --git a/docs/third_party-thunderbird.md b/docs/third_party-thunderbird.md new file mode 100644 index 000000000..776cb8add --- /dev/null +++ b/docs/third_party-thunderbird.md @@ -0,0 +1,27 @@ +# Build the SOGo Integrator plugin + +Install GNU Make, tar, and ZIP if you don't already have them installed. On Debian/Ubuntu, this can be done using + +``` +apt-get install make tar zip +``` + +Next, go to `data/web` inside mailcow-dockerized. +Place the file [thunderbird-plugins.php](download/thunderbird-plugins.php) into that directory. +Create a new directory `thunderbrid-plugins` and place the script [build-plugins.sh](download/build-thunderbird-plugins.sh) into it. +Finally, execute the script with your hostname as an argument and piping it the names of all domains that Mailcow handles. +All of this can be done using the following commands: + +``` +cd data/web +curl -LO https://github.com/mailcow/mailcow-dockerized-docs/raw/master/docs/download/thunderbird-plugins.php +mkdir thunderbird-plugins +curl -Lo build-plugins.sh https://github.com/mailcow/mailcow-dockerized-docs/raw/master/docs/download/build-thunderbird-plugins.sh +chmod +x build-plugins.sh +echo example.com example.org | ./build-plugins.sh mailcow.example.com +``` + +# Install it in Thunderbird + +After you have set up your Mailcow IMAP account in Thunderbird, download the SOGo integrator plugin for your domain, e.g. https://mailcow.example.com/thunderbird-plugins/sogo-integrator-31.0.5-example.com.xpi, and install it into Thunderbird. +All your address books and calendars will be configured automatically. diff --git a/mkdocs.yml b/mkdocs.yml index 7867212b2..b8716a935 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,7 @@ pages: - 'Adjust Service Configurations': 'u_e-change_config.md' - 'Deinstall': 'u_e-deinstall.md' - 'Third party apps': + - 'Thunderbird': 'third_party-thunderbird.md' - 'Roundcube': 'third_party-roundcube.md' - 'Portainer': 'third_party-portainer.md' - 'Gogs': 'third_party-gogs.md'