Merge branch '__matrix_riot' into 'master'

__matrix_element

See merge request ungleich-public/cdist-contrib!10

type/__matrix_element/files/config.json.sh

@@ -0,0 +1,90 @@
+#!/bin/sh
+#
+# Upstream configuration guide/documentation:
+#   https://github.com/vector-im/riot-web/blob/develop/docs/config.md
+
+generate_embedded_pages () {
+    if [ "$EMBED_HOMEPAGE" != "" ]; then
+        cat << EOF
+    "embeddedPages": {
+        "homeUrl": "home.html"
+    },
+EOF
+    fi
+}
+
+generate_jitsi_config () {
+    if [ "$JITSI_DOMAIN" != "" ]; then
+        cat << EOF
+    "jitsi": {
+        "preferredDomain": "$JITSI_DOMAIN"
+     },
+EOF
+    fi
+}
+
+generate_branding () {
+    echo '"branding": {'
+
+    if [ "$BRANDING_AUTH_HEADER_LOGO_URL" != "" ]; then
+        cat << EOF
+        "authHeaderLogoUrl": "$BRANDING_AUTH_HEADER_LOGO_URL",
+EOF
+    fi
+
+    if [ "$BRANDING_AUTH_FOOTER_LINKS" != "" ]; then
+        cat << EOF
+        "authFooterLinks": "$BRANDING_AUTH_FOOTER_LINKS",
+EOF
+    fi
+
+    cat << EOF
+    "welcomeBackgroundUrl": "themes/element/img/backgrounds/lake.jpg"
+EOF
+    echo '},'
+}
+
+cat << EOF
+{
+    "default_server_config": {
+        "m.homeserver": {
+            "base_url": "$DEFAULT_SERVER_URL",
+            "server_name": "$DEFAULT_SERVER_NAME"
+        },
+        "m.identity_server": {
+            "base_url": "https://vector.im"
+        }
+    },
+    "brand": "$BRAND",
+    $(generate_branding)
+    "defaultCountryCode": "$DEFAULT_COUNTRY_CODE",
+    "integrations_ui_url": "https://scalar.vector.im/",
+    "integrations_rest_url": "https://scalar.vector.im/api",
+    "integrations_widgets_urls": [
+        "https://scalar.vector.im/_matrix/integrations/v1",
+        "https://scalar.vector.im/api",
+        "https://scalar-staging.vector.im/_matrix/integrations/v1",
+        "https://scalar-staging.vector.im/api",
+        "https://scalar-staging.riot.im/scalar/api"
+    ],
+    "bug_report_endpoint_url": "https://riot.im/bugreports/submit",
+    "roomDirectory": {
+        "servers": [
+            $ROOM_DIRECTORY_SERVERS
+        ]
+    },
+    "disable_custom_urls": "$DISABLE_CUSTOM_URLS",
+    $(generate_embedded_pages)
+    $(generate_jitsi_config)
+    "terms_and_conditions_links": [
+        {
+            "url": "$PRIVACY_POLICY_URL",
+            "text": "Privacy Policy"
+        },
+        {
+            "url": "$COOKIE_POLICY_URL",
+            "text": "Cookie Policy"
+        }
+    ]
+}
+EOF

type/__matrix_element/gencode-remote

@@ -0,0 +1,69 @@
+#!/bin/sh -e
+#
+# 2019 Timothée Floure (timothee.floure@ungleich.ch)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+#
+
+VERSION=$(cat "$__object/parameter/version")
+INSTALL_DIR=$(cat "$__object/parameter/install_dir")
+OWNER=$(cat "$__object/parameter/owner")
+
+src="riot-v$VERSION"
+archive="$src.tar.gz"
+url="https://github.com/vector-im/riot-web/releases/download/v$VERSION/$archive"
+
+# tar and curl are installed by the __matrix-riot manifest. mktemp is usually
+# provided by coreutils and assumed installed.
+cat << EOF
+set -e
+
+# Ensure that coreutils is installed.
+if [ ! -x \$(which mktemp) ]; then
+  echo "mktemp is not available on the remote host." >&2
+  exit 1
+fi
+
+# Create temporary working directory.
+tmpdir=\$(mktemp -d)
+custom_files_dir="\$tmpdir/custom_files"
+cd \$tmpdir
+
+# Download and extract sources.
+curl -L '$url' > $archive
+tar xf $archive
+
+# Backup files deployed by __matrix_element.
+mkdir -p \$custom_files_dir
+for file in $INSTALL_DIR/cdist/*; do
+  cp "\$file" "\$custom_files_dir"
+done
+
+# Deploy sources and restore configuration.
+rm -r '$INSTALL_DIR'
+mv '$src' '$INSTALL_DIR'
+
+for file in \$custom_files_dir/*; do
+    cp "\$file" '$INSTALL_DIR'
+done
+
+# Chown deployed files to requested owner.
+chown -R '$OWNER' '$INSTALL_DIR'
+
+# Remove temporary working directory.
+cd /
+rm -r \$tmpdir
+EOF

type/__matrix_element/man.rst

@@ -0,0 +1,87 @@
+cdist-type__matrix_element(7)
+======================
+
+NAME
+----
+cdist-type__matrix_element - Install and configure Element, a web Matrix client.
+
+
+DESCRIPTION
+-----------
+This type install and configure the Element web client.
+
+
+REQUIRED PARAMETERS
+-------------------
+install_dir
+  Root directory of Element's static files.
+
+version
+  Release of Element to install.
+
+OPTIONAL PARAMETERS
+-------------------
+default_server_name
+  Name of matrix homeserver to connect to, defaults to 'matrix.org'.
+
+default_server_url
+  URL of matrix homeserver to connect to, defaults to 'https://matrix-client.matrix.org'.
+
+owner
+  Owner of the deployed files, passed to `chown`. Defaults to 'root'.
+
+brand
+  Web UI branding, defaults to 'Element'.
+
+default_country_code
+  ISO 3166 alpha2 country code to use when showing country selectors, such as
+  phone number inputs. Defaults to GB.
+
+privacy_policy_url
+  Defaults to 'https://element.io/privacy'.
+
+cookie_policy_url
+  Defaults to 'https://matrix.org/docs/guides/element_im_cookie_policy'.
+
+jitsi_domain
+  Domain name of preferred Jitsi instance (default is jitsi.element.im). This is
+  used whenever a user clicks on the voice/video call buttons.
+
+homepage
+  Path to custom homepage, displayed once logged in.
+
+welcomepage
+  Path to custom welcome (= login) page.
+
+custom_asset
+  Serve a file a the top-level directory (e.g. /my-custom-logo.svg). Can be specified multiple times.
+
+BOOLEAN PARAMETERS
+-------------------
+disable_custom_urls
+  Disallow the user to change the default homeserver when signing up or logging in.
+
+EXAMPLES
+--------
+
+.. code-block:: sh
+
+    __matrix_element my-element --install_dir /var/www/element-web --version 1.5.6
+
+
+SEE ALSO
+--------
+- `cdist-type__matrix_synapse(7) <cdist-type__matrix_synapse.html>`_
+
+
+AUTHORS
+-------
+Timothée Floure <timothee.floure@ungleich.ch>
+
+
+COPYING
+-------
+Copyright \(C) 2019 Timothée Floure. You can redistribute it
+and/or modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.

type/__matrix_element/manifest

@@ -0,0 +1,106 @@
+#!/bin/sh -e
+#
+# 2019 Timothée Floure (timothee.floure@ungleich.ch)
+#
+# This file is part of cdist.
+#
+# cdist is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# cdist is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with cdist. If not, see <http://www.gnu.org/licenses/>.
+
+# Ignore "Declare and assign separately to avoid masking return values. [SC2155]"
+# => not relevant for the type arguments.
+# shellcheck disable=SC2155
+
+INSTALL_DIR=$(cat "$__object/parameter/install_dir")
+
+export DEFAULT_SERVER_NAME=$(cat "$__object/parameter/default_server_name")
+export DEFAULT_SERVER_URL=$(cat "$__object/parameter/default_server_url")
+export BRAND=$(cat "$__object/parameter/brand")
+export DEFAULT_COUNTRY_CODE=$(cat "$__object/parameter/default_country_code")
+export ROOM_DIRECTORY_SERVERS=$(cat "$__object/parameter/room_directory_servers")
+export PRIVACY_POLICY_URL=$(cat "$__object/parameter/privacy_policy_url")
+export COOKIE_POLICY_URL=$(cat "$__object/parameter/cookie_policy_url")
+
+if [ -f "$__object/parameter/jitsi_domain" ]; then
+    export JITSI_DOMAIN=$(cat "$__object/parameter/jitsi_domain")
+fi
+
+if [ -f "$__object/parameter/branding_auth_header_logo_url" ]; then
+    export BRANDING_AUTH_HEADER_LOGO_URL=$(cat "$__object/parameter/branding_auth_header_logo_url")
+fi
+
+if [ -f "$__object/parameter/branding_auth_footer_links" ]; then
+    export BRANDING_AUTH_FOOTER_LINKS=$(cat "$__object/parameter/branding_auth_footer_links")
+fi
+
+if [ -f "$__object/parameter/homepage" ]; then
+    export EMBED_HOMEPAGE=1
+    homepage=$(cat "$__object/parameter/homepage")
+fi
+
+if [ -f "$__object/parameter/welcomepage" ]; then
+    export EMBED_WELCOMEPAGE=1
+    welcomepage=$(cat "$__object/parameter/welcomepage")
+fi
+
+if [ -f "$__object/parameter/custom_asset" ]; then
+   "$__object/parameter/custom_asset" | while IFS= read -r file; do
+       require="__directory/$INSTALL_DIR/cdist" __file "$INSTALL_DIR/cdist/$(basename "$file")" \
+           --source "$file" \
+           --mode 0664 \
+           --state present
+   done
+fi
+
+if [ -f "$__object/parameter/disable_custom_urls" ]; then
+    export DISABLE_CUSTOM_URLS='true'
+else
+    export DISABLE_CUSTOM_URLS='false'
+fi
+
+# Owner of the uploaded files.
+owner=$(cat "$__object/parameter/owner")
+
+# Ensure that curl and tar are installed, as they will be required by the
+# gencode-remote script.
+__package curl --state present
+__package tar --state present
+
+# Generate and deploy configuration file.
+mkdir -p "$__object/files"
+"$__type/files/config.json.sh" > "$__object/files/config.json"
+
+# Install the config.json configuration file. The application's sources are
+# downloaded and deployed by gencode-remote.
+__directory "$INSTALL_DIR/cdist" \
+    --owner "$owner" --mode 0755 --parents \
+    --state present
+
+require="__directory/$INSTALL_DIR/cdist" __file "$INSTALL_DIR/cdist/config.json" \
+  --source "$__object/files/config.json" \
+  --mode 0664 \
+  --state present
+
+if [ $EMBED_HOMEPAGE ]; then
+    require="__directory/$INSTALL_DIR/cdist" __file "$INSTALL_DIR/cdist/home.html" \
+      --source "$homepage" \
+      --mode 0664 \
+      --state present
+fi
+
+if [ $EMBED_WELCOMEPAGE ]; then
+    require="__directory/$INSTALL_DIR/cdist" __file "$INSTALL_DIR/cdist/welcome.html" \
+      --source "$welcomepage" \
+      --mode 0664 \
+      --state present
+fi

type/__matrix_element/parameter/boolean

@@ -0,0 +1 @@
+disable_custom_urls

type/__matrix_element/parameter/default/brand

@@ -0,0 +1 @@
+Element

type/__matrix_element/parameter/default/cookie_policy_url

@@ -0,0 +1 @@
+https://matrix.org/docs/guides/riot_im_cookie_policy

type/__matrix_element/parameter/default/default_country_code

@@ -0,0 +1 @@
+GB

type/__matrix_element/parameter/default/default_server_name

@@ -0,0 +1 @@
+matrix.org

type/__matrix_element/parameter/default/default_server_url

@@ -0,0 +1 @@
+https://matrix-client.matrix.org

type/__matrix_element/parameter/default/owner

@@ -0,0 +1 @@
+root

type/__matrix_element/parameter/default/privacy_policy_url

@@ -0,0 +1 @@
+https://element.io/privacy

type/__matrix_element/parameter/default/room_directory_servers

@@ -0,0 +1 @@
+"matrix.org"

type/__matrix_element/parameter/optional

@@ -0,0 +1,13 @@
+default_server_url
+default_server_name
+brand
+default_country_code
+privacy_policy_url
+cookie_policy_url
+room_directory_servers
+owner
+homepage
+welcomepage
+jitsi_domain
+branding_auth_header_logo_url
+branding_auth_footer_links

type/__matrix_element/parameter/optional_multiple

@@ -0,0 +1 @@
+custom_asset

type/__matrix_element/parameter/required

@@ -0,0 +1,2 @@
+version
+install_dir