diff --git a/README.md b/README.md index db59251..e49a301 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Instant messaging server matrix network. Yunohost chatroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org) -**Shipped version:** 0.33.1 +**Shipped version:** 0.33.3.1 Configuration ------------- @@ -39,11 +39,11 @@ If you want a web client you can also install riot with this package: https://gi To be accessible by the federation you need to put the following line in the dns configuration: ``` -_matrix._tcp. IN SRV 10 0 +_matrix._tcp. IN SRV 10 0 ``` for example ``` -_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT synapse.example.com. +_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT example.com. ``` You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port` diff --git a/conf/armv7_jessie.src b/conf/armv7_jessie.src index 8356de5..323be29 100644 --- a/conf/armv7_jessie.src +++ b/conf/armv7_jessie.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/YunoHost-Apps/synapse_python_build/releases/download/v0.33.1/matrix-synapse_0.33.1-jessie-bin1_armv7l.tar.gz -SOURCE_SUM=cdeffcf86392a92d776198d125e1b3a953eb587e327b0e611cbc78db5b73f9e7 +SOURCE_URL=https://github.com/YunoHost-Apps/synapse_python_build/releases/download/v0.33.3.1/matrix-synapse_0.33.3.1-jessie-bin1_armv7l.tar.gz +SOURCE_SUM=0136525e08fb2b19902b0f1b0e9847e5b8c71f33ba044d1af7fa5768f0c376a4 # (Optional) Program to check the integrity (sha256sum, md5sum...) # default: sha256 SOURCE_SUM_PRG=sha256sum diff --git a/conf/armv7_stretch.src b/conf/armv7_stretch.src index d09b40b..9e3d392 100644 --- a/conf/armv7_stretch.src +++ b/conf/armv7_stretch.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/YunoHost-Apps/synapse_python_build/releases/download/v0.33.1/matrix-synapse_0.33.1-stretch-bin1_armv7l.tar.gz -SOURCE_SUM=bb6f83dd936b56577bb4bdaa2d1d9dac040bd81cc704bfbbc83f371252975325 +SOURCE_URL=https://github.com/YunoHost-Apps/synapse_python_build/releases/download/v0.33.3.1/matrix-synapse_0.33.3.1-stretch-bin1_armv7l.tar.gz +SOURCE_SUM=d9bc3722dca7f90134ce9aad67d8af8da9b9396545d1cbaed42083616327a575 # (Optional) Program to check the integrity (sha256sum, md5sum...) # default: sha256 SOURCE_SUM_PRG=sha256sum diff --git a/conf/homeserver.yaml b/conf/homeserver.yaml index 0d17b22..3d1c66a 100644 --- a/conf/homeserver.yaml +++ b/conf/homeserver.yaml @@ -4,27 +4,87 @@ # autogenerates on launch with your own SSL certificate + key pair # if you like. Any required intermediary certificates can be # appended after the primary certificate in hierarchical order. -tls_certificate_path: "/etc/yunohost/certs/__DOMAIN__/crt.pem" +tls_certificate_path: "/etc/matrix-__APP__/__DOMAIN__.tls.crt" # PEM encoded private key for TLS -tls_private_key_path: "/etc/yunohost/certs/__DOMAIN__/key.pem" +tls_private_key_path: "/etc/matrix-__APP__/__DOMAIN__.tls.key" # PEM dh parameters for ephemeral keys -tls_dh_params_path: "/etc/matrix-__APP__/dh.pem" +tls_dh_params_path: "/etc/matrix-__APP__/__DOMAIN__.tls.dh" # Don't bind to the https port no_tls: False +# List of allowed TLS fingerprints for this server to publish along +# with the signing keys for this server. Other matrix servers that +# make HTTPS requests to this server will check that the TLS +# certificates returned by this server match one of the fingerprints. +# +# Synapse automatically adds the fingerprint of its own certificate +# to the list. So if federation traffic is handled directly by synapse +# then no modification to the list is required. +# +# If synapse is run behind a load balancer that handles the TLS then it +# will be necessary to add the fingerprints of the certificates used by +# the loadbalancers to this list if they are different to the one +# synapse is using. +# +# Homeservers are permitted to cache the list of TLS fingerprints +# returned in the key responses up to the "valid_until_ts" returned in +# key. It may be necessary to publish the fingerprints of a new +# certificate and wait until the "valid_until_ts" of the previous key +# responses have passed before deploying it. +# +# You can calculate a fingerprint from a given TLS listener via: +# openssl s_client -connect $host:$port < /dev/null 2> /dev/null | +# openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '=' +# or by checking matrix.org/federationtester/api/report?server_name=$host +# +tls_fingerprints: [] +# tls_fingerprints: [{"sha256": ""}] + + ## Server ## +# The domain name of the server, with optional explicit port. +# This is used by remote servers to connect to this server, +# e.g. matrix.org, localhost:8080, etc. +# This is also the last part of your UserID. server_name: "__DOMAIN__" # When running as a daemon, the file to store the pid in pid_file: "/var/run/matrix-__APP__.pid" +# CPU affinity mask. Setting this restricts the CPUs on which the +# process will be scheduled. It is represented as a bitmask, with the +# lowest order bit corresponding to the first logical CPU and the +# highest order bit corresponding to the last logical CPU. Not all CPUs +# may exist on a given system but a mask may specify more CPUs than are +# present. +# +# For example: +# 0x00000001 is processor #0, +# 0x00000003 is processors #0 and #1, +# 0xFFFFFFFF is all processors (#0 through #31). +# +# Pinning a Python process to a single CPU is desirable, because Python +# is inherently single-threaded due to the GIL, and can suffer a +# 30-40% slowdown due to cache blow-out and thread context switching +# if the scheduler happens to schedule the underlying threads across +# different cores. See +# https://www.mirantis.com/blog/improve-performance-python-programs-restricting-single-cpu/. +# +# cpu_affinity: 0xFFFFFFFF + # Whether to serve a web client from the HTTP/HTTPS root resource. web_client: False +# The root directory to server for the above web client. +# If left undefined, synapse will serve the matrix-angular-sdk web client. +# Make sure matrix-angular-sdk is installed with pip if web_client is True +# and web_client_location is undefined +# web_client_location: "/path/to/web/root" + # The public-facing base URL for the client API (not including _matrix/...) # public_baseurl: https://example.com:8448/ @@ -36,14 +96,24 @@ soft_file_limit: 0 # The GC threshold parameters to pass to `gc.set_threshold`, if defined # gc_thresholds: [700, 10, 10] -# A list of other Home Servers to fetch the public room directory from -# and include in the public room directory of this home server -# This is a temporary stopgap solution to populate new server with a -# list of rooms until there exists a good solution of a decentralized -# room directory. -# secondary_directory_servers: -# - matrix.org -# - vector.im +# Set the limit on the returned events in the timeline in the get +# and sync operations. The default value is -1, means no upper limit. +# filter_timeline_limit: 5000 + +# Whether room invites to users on this server should be blocked +# (except those sent by local server admins). The default is False. +# block_non_admin_invites: True + +# Restrict federation to the following whitelist of domains. +# N.B. we recommend also firewalling your federation listener to limit +# inbound federation traffic as early as possible, rather than relying +# purely on this application-layer restriction. If not specified, the +# default is to whitelist everything. +# +# federation_domain_whitelist: +# - lon.example.com +# - nyc.example.com +# - syd.example.com # List of ports that Synapse should listen on, their purpose and their # configuration. @@ -54,9 +124,13 @@ listeners: # The port to listen for HTTPS requests on. port: __TLS_PORT__ - # Local interface to listen on. - # The empty string will cause synapse to listen on all interfaces. - bind_address: '' + # Local addresses to listen on. + # On Linux and Mac OS, `::` will listen on all IPv4 and IPv6 + # addresses by default. For most other OSes, this will only listen + # on IPv6. + bind_addresses: + - '::' + - '0.0.0.0' # This is a 'http' listener, allows us to specify 'resources'. type: http @@ -83,11 +157,18 @@ listeners: - names: [federation] # Federation APIs compress: false + # optional list of additional endpoints which can be loaded via + # dynamic modules + # additional_resources: + # "/_matrix/my/custom/endpoint": + # module: my_module.CustomRequestHandler + # config: {} + # Unsecure HTTP listener, # For when matrix traffic passes through loadbalancer that unwraps TLS. - port: __PORT__ tls: false - bind_address: 'localhost' + bind_addresses: ['::1', '127.0.0.1'] type: http x_forwarded: true @@ -101,7 +182,7 @@ listeners: # Turn on the twisted ssh manhole service on localhost on the given # port. # - port: 9000 - # bind_address: 127.0.0.1 + # bind_addresses: ['::1', '127.0.0.1'] # type: manhole @@ -125,11 +206,6 @@ event_cache_size: "10K" # A yaml python logging config file log_config: "/etc/matrix-__APP__/log.yaml" -# Stop twisted from discarding the stack traces of exceptions in -# deferreds by waiting a reactor tick before running a deferred's -# callbacks. -# full_twisted_stacktraces: true - ## Ratelimiting ## @@ -163,6 +239,23 @@ federation_rc_concurrent: 3 # Directory where uploaded images and attachments are stored. media_store_path: "/var/lib/matrix-__APP__/media" +# Media storage providers allow media to be stored in different +# locations. +media_storage_providers: +- module: file_system + # Whether to write new local files. + store_local: false + # Whether to write new remote media + store_remote: false + # Whether to block upload requests waiting for write to this + # provider to complete + store_synchronous: false + config: + directory: "/var/lib/matrix-__APP__/media_storage" + +# Directory where in-progress uploads are stored. +uploads_path: "/var/lib/matrix-__APP__/uploads" + # The largest allowed upload size in bytes max_upload_size: "10M" @@ -212,6 +305,11 @@ url_preview_ip_range_blacklist: - '10.0.0.0/8' - '172.16.0.0/12' - '192.168.0.0/16' +- '100.64.0.0/10' +- '169.254.0.0/16' +- '::1/128' +- 'fe80::/64' +- 'fc00::/7' # # List of IP address CIDR ranges that the URL preview spider is allowed # to access even if they are specified in url_preview_ip_range_blacklist. @@ -263,6 +361,7 @@ max_spider_size: "10M" ## Captcha ## +# See docs/CAPTCHA_SETUP for full details of configuring this. # This Home Server's ReCAPTCHA public key. recaptcha_public_key: "YOUR_PUBLIC_KEY" @@ -290,8 +389,20 @@ turn_uris: [ "turn:__DOMAIN__:__TURNSERVER_TLS_PORT__?transport=udp", "turn:__DO # The shared secret used to compute passwords for the TURN server turn_shared_secret: "__TURNPWD__" +# The Username and password if the TURN server needs them and +# does not use a token +#turn_username: "TURNSERVER_USERNAME" +#turn_password: "TURNSERVER_PASSWORD" + # How long generated TURN credentials last -turn_user_lifetime: "86400000" +turn_user_lifetime: "1h" + +# Whether guests should be allowed to use the TURN server. +# This defaults to True, otherwise VoIP will be unreliable for guests. +# However, it does introduce a slight security risk as it allows users to +# connect to arbitrary endpoints without having first signed up for a +# valid account (e.g. by passing a CAPTCHA). +turn_allow_guests: __ALLOWED_ACCESS__ ## Registration ## @@ -299,18 +410,32 @@ turn_user_lifetime: "86400000" # Enable registration for new users. enable_registration: __ALLOWED_ACCESS__ +# The user must provide all of the below types of 3PID when registering. +# +# registrations_require_3pid: +# - email +# - msisdn + +# Mandate that users are only allowed to associate certain formats of +# 3PIDs with accounts on this server. +# +# allowed_local_3pids: +# - medium: email +# pattern: ".*@matrix\.org" +# - medium: email +# pattern: ".*@vector\.im" +# - medium: msisdn +# pattern: "\+44" + # If set, allows registration by anyone who also has the shared # secret, even if registration is otherwise disabled. -# registration_shared_secret: - -# Sets the expiry for the short term user creation in -# milliseconds. For instance the bellow duration is two weeks -# in milliseconds. -user_creation_max_duration: 1209600000 +registration_shared_secret: "__REGISTRATION_SECRET__" # Set the number of bcrypt rounds used to generate password hash. # Larger numbers increase the work factor needed to generate the hash. -# The default number of rounds is 12. +# The default number is 12 (which equates to 2^12 rounds). +# N.B. that increasing this will exponentially increase the time required +# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins. bcrypt_rounds: 12 # Allows users to register as guests without a password/email/etc, and @@ -323,13 +448,19 @@ allow_guest_access: __ALLOWED_ACCESS__ trusted_third_party_id_servers: - matrix.org - vector.im + - riot.im + +# Users who register on this homeserver will automatically be joined +# to these rooms +#auto_join_rooms: +# - "#example:example.com" ## Metrics ### # Enable collection and rendering of performance metrics enable_metrics: False -report_stats: False +report_stats: __REPORT_STATS__ ## API Configuration ## @@ -350,6 +481,13 @@ app_service_config_files: [] # Used to enable access token expiration. expire_access_token: False +# a secret which is used to calculate HMACs for form values, to stop +# falsification of values +form_secret: "__FORM_SECRET__" + +# Used to enable access token expiration. +expire_access_token: False + ## Signing Keys ## # Path to the signing key to sign messages with @@ -387,8 +525,8 @@ perspectives: # See pysaml2 docs for format of config. #saml2_config: # enabled: true -# config_path: "/home/erikj/git/synapse/sp_conf.py" -# idp_redirect_url: "http://test/idp" +# config_path: "/opt/yunohost/matrix-synapse/sp_conf.py" +# idp_redirect_url: "http://machine.my.domain.name/idp" @@ -396,7 +534,7 @@ perspectives: #cas_config: # enabled: true # server_url: "https://cas-server.com" -# service_url: "https://homesever.domain.com:8448" +# service_url: "https://homeserver.domain.com:8448" # #required_attributes: # # name: value @@ -409,35 +547,38 @@ perspectives: # algorithm: "HS256" -# ldap_config: -# enabled: true -# server: "ldap://localhost" -# port: 389 -# tls: false -# search_base: "ou=Users,dc=example,dc=com" -# search_property: "cn" -# email_property: "email" -# full_name_property: "givenName" - - # Enable password for login. password_config: enabled: true + # Uncomment and change to a secret random string for extra security. + # DO NOT CHANGE THIS AFTER INITIAL SETUP! + #pepper: "" # Enable sending emails for notification events -email: - enable_notifs: false - smtp_host: "localhost" - smtp_port: 25 - notif_from: "Your Friendly %(app)s Home Server " - app_name: Matrix - template_dir: res/templates - notif_template_html: notif_mail.html - notif_template_text: notif_mail.txt - notif_for_new_users: True +# Defining a custom URL for Riot is only needed if email notifications +# should contain links to a self-hosted installation of Riot; when set +# the "app_name" setting is ignored. +# +# If your SMTP server requires authentication, the optional smtp_user & +# smtp_pass variables should be used +# +#email: +# enable_notifs: false +# smtp_host: "localhost" +# smtp_port: 25 +# smtp_user: "exampleusername" +# smtp_pass: "examplepassword" +# require_transport_security: False +# notif_from: "Your Friendly %(app)s Home Server " +# app_name: Matrix +# template_dir: res/templates +# notif_template_html: notif_mail.html +# notif_template_text: notif_mail.txt +# notif_for_new_users: True +# riot_base_url: "http://localhost/riot" ## For password by LDAP @@ -452,3 +593,111 @@ password_providers: uid: "uid" mail: "mail" name: "givenName" + #bind_dn: + #bind_password: + #filter: "(objectClass=posixAccount)" + + + +# Clients requesting push notifications can either have the body of +# the message sent in the notification poke along with other details +# like the sender, or just the event ID and room ID (`event_id_only`). +# If clients choose the former, this option controls whether the +# notification request includes the content of the event (other details +# like the sender are still included). For `event_id_only` push, it +# has no effect. + +# For modern android devices the notification content will still appear +# because it is loaded by the app. iPhone, however will send a +# notification saying only that a message arrived and who it came from. +# +#push: +# include_content: true + + +# spam_checker: +# module: "my_custom_project.SuperSpamChecker" +# config: +# example_option: 'things' + + +# Whether to allow non server admins to create groups on this server +enable_group_creation: false + +# If enabled, non server admins can only create groups with local parts +# starting with this prefix +# group_creation_prefix: "unofficial/" + + + +# User Directory configuration +# +# 'search_all_users' defines whether to search all users visible to your HS +# when searching the user directory, rather than limiting to users visible +# in public rooms. Defaults to false. If you set it True, you'll have to run +# UPDATE user_directory_stream_pos SET stream_id = NULL; +# on your database to tell it to rebuild the user_directory search indexes. +# +#user_directory: +# search_all_users: false + +# User Consent configuration +# +# for detailed instructions, see +# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md +# +# Parts of this section are required if enabling the 'consent' resource under +# 'listeners', in particular 'template_dir' and 'version'. +# +# 'template_dir' gives the location of the templates for the HTML forms. +# This directory should contain one subdirectory per language (eg, 'en', 'fr'), +# and each language directory should contain the policy document (named as +# '.html') and a success page (success.html). +# +# 'version' specifies the 'current' version of the policy document. It defines +# the version to be served by the consent resource if there is no 'v' +# parameter. +# +# 'server_notice_content', if enabled, will send a user a "Server Notice" +# asking them to consent to the privacy policy. The 'server_notices' section +# must also be configured for this to work. Notices will *not* be sent to +# guest users unless 'send_server_notice_to_guests' is set to true. +# +# 'block_events_error', if set, will block any attempts to send events +# until the user consents to the privacy policy. The value of the setting is +# used as the text of the error. +# +# user_consent: +# template_dir: res/templates/privacy +# version: 1.0 +# server_notice_content: +# msgtype: m.text +# body: >- +# To continue using this homeserver you must review and agree to the +# terms and conditions at %(consent_uri)s +# send_server_notice_to_guests: True +# block_events_error: >- +# To continue using this homeserver you must review and agree to the +# terms and conditions at %(consent_uri)s +# + + +# Server Notices room configuration +# +# Uncomment this section to enable a room which can be used to send notices +# from the server to users. It is a special room which cannot be left; notices +# come from a special "notices" user id. +# +# If you uncomment this section, you *must* define the system_mxid_localpart +# setting, which defines the id of the user which will be used to send the +# notices. +# +# It's also possible to override the room name, the display name of the +# "notices" user, and the avatar for the user. +# +# server_notices: +# system_mxid_localpart: notices +# system_mxid_display_name: "Server Notices" +# system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ" +# room_name: "Server Notices" + diff --git a/conf/python_source.src b/conf/python_source.src index a4e3248..7608a7b 100644 --- a/conf/python_source.src +++ b/conf/python_source.src @@ -1,2 +1,5 @@ -SOURCE_URL=https://github.com/matrix-org/synapse/archive/v0.33.1.tar.gz -SOURCE_SUM=2fb51254cdc7f12ada7f2f7d848aeeecaa5b484298cfecf18a676790f157e3e4 \ No newline at end of file +SOURCE_URL=https://github.com/matrix-org/synapse/archive/v0.33.3.1.tar.gz +SOURCE_SUM=c611fe29a4b4e13417f0fff9c4dc38117d3bba19d071bd138400c77ac961d894 +SOURCE_FORMAT=tar.gz +SOURCE_FILENAME=synapse_source.tar.gz +SOURCE_EXTRACT=false diff --git a/conf/turnserver.conf b/conf/turnserver.conf index 6895d6e..70d8086 100644 --- a/conf/turnserver.conf +++ b/conf/turnserver.conf @@ -11,7 +11,7 @@ cli-port=__CLI_PORT__ cert=/etc/yunohost/certs/__DOMAIN__/crt.pem pkey=/etc/yunohost/certs/__DOMAIN__/key.pem -dh-file=/etc/matrix-__APP__/dh.pem +dh-file=/etc/matrix-__APP__/__DOMAIN__.tls.dh no-sslv2 no-sslv3 diff --git a/manifest.json b/manifest.json index e6a01cb..8f53385 100644 --- a/manifest.json +++ b/manifest.json @@ -3,13 +3,13 @@ "id": "synapse", "packaging_format": 1, "requirements": { - "yunohost": ">= 2.7.9" + "yunohost": ">= 2.7.14" }, "description": { "en": "Instant messaging server who use matrix", "fr": "Un serveur de messagerie instantané basé sur matrix" }, - "version": "0.33.1~ynh1", + "version": "0.33.3.1~ynh1", "url": "http://matrix.org", "license": "Apache-2.0", "maintainer": { diff --git a/scripts/experimental_helper.sh b/scripts/experimental_helper.sh index d2f8c12..660007b 100644 --- a/scripts/experimental_helper.sh +++ b/scripts/experimental_helper.sh @@ -35,49 +35,6 @@ ynh_app_package_version () { echo "${version_key/*~ynh/}" } -####### Solve issue https://dev.yunohost.org/issues/1006 - -# Build and install a package from an equivs control file -# -# example: generate an empty control file with `equivs-control`, adjust its -# content and use helper to build and install the package: -# ynh_package_install_from_equivs /path/to/controlfile -# -# usage: ynh_package_install_from_equivs controlfile -# | arg: controlfile - path of the equivs control file -ynh_package_install_from_equivs () { - controlfile=$1 - - # Check if the equivs package is installed. Or install it. - ynh_package_is_installed 'equivs' \ - || ynh_package_install equivs - - # retrieve package information - pkgname=$(grep '^Package: ' $controlfile | cut -d' ' -f 2) # Retrieve the name of the debian package - pkgversion=$(grep '^Version: ' $controlfile | cut -d' ' -f 2) # And its version number - [[ -z "$pkgname" || -z "$pkgversion" ]] \ - && echo "Invalid control file" && exit 1 # Check if this 2 variables aren't empty. - - # Update packages cache - ynh_package_update - - # Build and install the package - TMPDIR=$(mktemp -d) - # Note that the cd executes into a sub shell - # Create a fake deb package with equivs-build and the given control file - # Install the fake package without its dependencies with dpkg - # Install missing dependencies with ynh_package_install - (cp "$controlfile" "${TMPDIR}/control" && cd "$TMPDIR" \ - && equivs-build ./control 1>/dev/null \ - && sudo dpkg --force-depends \ - -i "./${pkgname}_${pkgversion}_all.deb" 2>&1 \ - && ynh_package_install -f) || ynh_die "Unable to install dependencies" - [[ -n "$TMPDIR" ]] && rm -rf $TMPDIR # Remove the temp dir. - - # check if the package is actually installed - ynh_package_is_installed "$pkgname" -} - # Start or restart a service and follow its booting # # usage: ynh_check_starting "Line to match" [Log file] [Timeout] [Service name] @@ -128,61 +85,6 @@ ynh_check_starting () { ynh_clean_check_starting } -# Create a dedicated systemd config -# -# usage: ynh_add_systemd_config [Service name] [Source file] -# | arg: Service name -# | arg: Systemd source file (for example appname.service) -# -# This will use a template in ../conf/systemd.service -# and will replace the following keywords with -# global variables that should be defined before calling -# this helper : -# -# __APP__ by $app -# __FINALPATH__ by $final_path -# -# usage: ynh_add_systemd_config -ynh_add_systemd_config () { - local service_name="${1:-$app}" - - finalsystemdconf="/etc/systemd/system/$service_name.service" - ynh_backup_if_checksum_is_different "$finalsystemdconf" - sudo cp ../conf/${2:-systemd.service} "$finalsystemdconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_file_checksum "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $service_name - sudo systemctl daemon-reload -} - -# Remove the dedicated systemd config -# -# usage: ynh_remove_systemd_config [Service name] -# | arg: Service name -# -# usage: ynh_remove_systemd_config -ynh_remove_systemd_config () { - local service_name="${1:-$app}" - - local finalsystemdconf="/etc/systemd/system/$service_name.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $service_name - sudo systemctl disable $service_name - ynh_secure_remove "$finalsystemdconf" - sudo systemctl daemon-reload - fi -} - # Send an email to inform the administrator # # usage: ynh_send_readme_to_admin app_message [recipients] @@ -222,12 +124,24 @@ ynh_send_readme_to_admin() { local mail_subject="☁️🆈🅽🅷☁️: \`$app\` was just installed!" local mail_message="This is an automated message from your beloved YunoHost server. + Specific information for the application $app. + $app_message + --- Automatic diagnosis data from YunoHost + $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')" + # Define binary to use for mail command + if [ -e /usr/bin/bsd-mailx ] + then + local mail_bin=/usr/bin/bsd-mailx + else + local mail_bin=/usr/bin/mail.mailutils + fi + # Send the email to the recipients - echo "$mail_message" | mail -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients" -} \ No newline at end of file + echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients" +} diff --git a/scripts/install b/scripts/install index f03c4cc..f227bdb 100644 --- a/scripts/install +++ b/scripts/install @@ -25,6 +25,7 @@ synapse_user="matrix-$app" synapse_db_name="matrix_$app" synapse_db_user="matrix_$app" upstream_version=$(ynh_app_upstream_version) +report_stats="False" #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST @@ -58,6 +59,7 @@ ynh_app_setting_set $app special_path $path_url ynh_app_setting_set $app final_path $final_path ynh_app_setting_set $app synapse_version $upstream_version ynh_app_setting_set $app is_public $is_public +ynh_app_setting_set $app report_stats $report_stats #================================================= # STANDARD MODIFICATIONS @@ -84,20 +86,11 @@ ynh_app_setting_set $app turnserver_tls_port $turnserver_tls_port ynh_app_setting_set $app turnserver_alt_tls_port $turnserver_alt_tls_port ynh_app_setting_set $app cli_port $cli_port -#================================================= -# CREATE A DH FILE -#================================================= - -# Make dh cert for synapse if it not exist -test ! -e /etc/matrix-$app/dh.pem && \ - mkdir -p /etc/matrix-$app && \ - openssl dhparam -out /etc/matrix-$app/dh.pem 2048 > /dev/null - #================================================= # INSTALL DEPENDENCIES #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE, RESTORE +# WARNING : theses command are used in INSTALL, UPGRADE, RESTORE # For any update do it in all files ynh_install_app_dependencies coturn build-essential python2.7-dev libffi-dev python-pip python-setuptools sqlite3 libssl-dev python-virtualenv libxml2-dev libxslt1-dev python-lxml libjpeg-dev libpq-dev postgresql acl pip install --upgrade virtualenv @@ -129,7 +122,7 @@ ynh_psql_execute_as_root \ # Create empty dir for synapse -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files mkdir -p /var/lib/matrix-$app mkdir -p /var/log/matrix-$app @@ -138,7 +131,7 @@ mkdir -p $final_path # Install synapse in virtualenv -# WARRNING : theses command are used in INSTALL, UPGRADE (2 times) +# WARNING : theses command are used in INSTALL, UPGRADE (2 times) # For any update do it in all files if [ -n "$(uname -m | grep arm)" ] then @@ -148,7 +141,7 @@ else test -e $final_path/bin || virtualenv -p python2.7 $final_path # Install synapse in virtualenv - PS1="" + PS1=${PS1:-} cp ../conf/virtualenv_activate $final_path/bin/activate ynh_replace_string __FINAL_PATH__ $final_path $final_path/bin/activate @@ -158,24 +151,43 @@ else pip install --upgrade setuptools pip install --upgrade cffi ndg-httpsclient psycopg2 lxml - # Download and check the checksum for the synapse source - src_url=$(grep 'SOURCE_URL=' "$YNH_CWD/../conf/python_source.src" | cut -d= -f2-) - src_sum=$(grep 'SOURCE_SUM=' "$YNH_CWD/../conf/python_source.src" | cut -d= -f2-) - - wget -nv -O synapse_source.tar.gz "$src_url" - echo "${src_sum} synapse_source.tar.gz" | sha256sum -c --status \ - || ynh_die "Corrupt source" - pip install --upgrade synapse_source.tar.gz + ynh_setup_source "/tmp" "python_source" + pip install --upgrade "/tmp/synapse_source.tar.gz" # Fix issue with msgpack see https://github.com/YunoHost-Apps/synapse_ynh/issues/29 test -e $final_path/lib/python2.7/site-packages/msgpack/__init__.py || (\ pip uninstall -y msgpack-python msgpack; \ pip install msgpack-python) - # This fonction was defined while we call "source $final_path/bin/activate". By this fonction de undo what does "$final_path/bin/activate" + # This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does deactivate fi +#================================================= +# CREATE SYNAPSE KEYS +#================================================= + +# Go in virtualenvironnement +PS1=${PS1:-} +source $final_path/bin/activate + +# Get the dh.pem if exist +test -e /etc/matrix-$app/dh.pem && mv /etc/matrix-$app/dh.pem $domain.tls.dh + +# Generate config and keys +python -m synapse.app.homeserver --keys-directory /etc/matrix-$app/ --generate-config --generate-keys --server-name $domain --report-stats=no -c homeserver.yml + +# This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does +deactivate + +# Get random values from config +registration_shared_secret=$(egrep "registration_shared_secret" homeserver.yml | cut -d'"' -f2) +form_secret=$(egrep "form_secret" homeserver.yml | cut -d'"' -f2) + +# store in yunohost settings +ynh_app_setting_set $app registration_shared_secret "$registration_shared_secret" +ynh_app_setting_set $app form_secret "$form_secret" + #================================================= # SETUP SYSTEMD #================================================= @@ -203,7 +215,7 @@ ynh_app_setting_set $app turnserver_pwd $turnserver_pwd # Configure Synapse -# WARRNING : theses command are used in INSTALL, UPGRADE (2 times) +# WARNING : theses command are used in INSTALL, UPGRADE (2 times) # For any update do it in all files homeserver_config_path="/etc/matrix-$app/homeserver.yaml" @@ -219,6 +231,9 @@ ynh_replace_string __PORT__ $port "$homeserver_config_path" ynh_replace_string __TLS_PORT__ $synapse_tls_port "$homeserver_config_path" ynh_replace_string __TURNSERVER_TLS_PORT__ $turnserver_tls_port "$homeserver_config_path" ynh_replace_string __TURNPWD__ $turnserver_pwd "$homeserver_config_path" +ynh_replace_string __REGISTRATION_SECRET__ "$registration_shared_secret" "$homeserver_config_path" +ynh_replace_string __FORM_SECRET__ "$form_secret" "$homeserver_config_path" +ynh_replace_string __REPORT_STATS__ "$report_stats" "$homeserver_config_path" ynh_replace_string __APP__ $app "/etc/matrix-$app/log.yaml" @@ -236,7 +251,7 @@ ynh_store_file_checksum "/etc/matrix-$app/log.yaml" # SET COTURN CONFIG #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files coturn_config_path="/etc/matrix-$app/coturn.conf" @@ -281,7 +296,7 @@ ynh_use_logrotate /var/log/matrix-$app # ADD SCRIPT FOR COTURN CRON #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files cp ../sources/Coturn_config_rotate.sh $final_path/ @@ -303,14 +318,15 @@ python3 $final_path/add_sso_conf.py || ynh_die "Your file /etc/ssowat/conf.json. # SECURE FILES AND DIRECTORIES #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE (2 times), RESTORE +# WARNING : theses command are used in INSTALL, UPGRADE, RESTORE # For any update do it in all files chown $synapse_user:root -R $final_path +chmod 770 $final_path/Coturn_config_rotate.sh chown $synapse_user:root -R /var/lib/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app -chmod 600 /etc/matrix-$app/dh.pem +chmod 600 /etc/matrix-$app/{$domain.signing.key,$domain.tls.crt,$domain.tls.dh,$domain.tls.key} setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app @@ -332,7 +348,7 @@ ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/m # SEND A README FOR THE ADMIN #================================================= -# WARRNING : theses command are used in INSTALL, RESTORE +# WARNING : theses command are used in INSTALL, RESTORE # For any update do it in all files message="To federate this app you need to add this line in your DNS configuration: diff --git a/scripts/restore b/scripts/restore index 2f907a8..1da0302 100644 --- a/scripts/restore +++ b/scripts/restore @@ -57,7 +57,7 @@ ynh_restore # REINSTALL DEPENDENCIES #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE, RESTORE +# WARNING : theses command are used in INSTALL, UPGRADE, RESTORE # For any update do it in all files ynh_install_app_dependencies coturn build-essential python2.7-dev libffi-dev python-pip python-setuptools sqlite3 libssl-dev python-virtualenv libxml2-dev libxslt1-dev python-lxml libjpeg-dev libpq-dev postgresql acl pip install --upgrade virtualenv @@ -170,14 +170,15 @@ ynh_use_logrotate /var/log/matrix-$app # SECURE FILES AND DIRECTORIES #================================================= -# WARNING : these commands are used in INSTALL, UPGRADE, RESTORE +# WARNING : theses command are used in INSTALL, UPGRADE, RESTORE (3 times) # For any update do it in all files chown $synapse_user:root -R $final_path +chmod 770 $final_path/Coturn_config_rotate.sh chown $synapse_user:root -R /var/lib/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app -chmod 600 /etc/matrix-$app/dh.pem +chmod 600 /etc/matrix-$app/{$domain.signing.key,$domain.tls.crt,$domain.tls.dh,$domain.tls.key} setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app @@ -200,7 +201,7 @@ ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/m # SEND A README FOR THE ADMIN #================================================= -# WARRNING : theses command are used in INSTALL, RESTORE +# WARNING : theses command are used in INSTALL, RESTORE # For any update do it in all files message="To federate this app you need to add this line in your DNS configuration: diff --git a/scripts/upgrade b/scripts/upgrade index 54aca18..deede78 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -42,6 +42,9 @@ turnserver_tls_port=$(ynh_app_setting_get $app turnserver_tls_port) turnserver_alt_tls_port=$(ynh_app_setting_get $app turnserver_alt_tls_port) turnserver_pwd=$(ynh_app_setting_get $app turnserver_pwd) cli_port=$(ynh_app_setting_get $app cli_port) +registration_shared_secret=$(ynh_app_setting_get $app registration_shared_secret) +form_secret=$(ynh_app_setting_get $app form_secret) +report_stats=$(ynh_app_setting_get $app report_stats) #================================================= # ENSURE DOWNWARD COMPATIBILITY @@ -88,7 +91,7 @@ else test -e $final_path/bin || virtualenv -p python2.7 $final_path # Install synapse in virtualenv - PS1="" + PS1=${PS1:-} cp ../conf/virtualenv_activate $final_path/bin/activate ynh_replace_string __FINAL_PATH__ $final_path $final_path/bin/activate @@ -98,28 +101,52 @@ else pip install --upgrade cffi ndg-httpsclient psycopg2 lxml # Download and check the checksum for the synapse source - src_url=$(grep 'SOURCE_URL=' "$YNH_CWD/../conf/python_source.src" | cut -d= -f2-) - src_sum=$(grep 'SOURCE_SUM=' "$YNH_CWD/../conf/python_source.src" | cut -d= -f2-) - - wget -nv -O synapse_source.tar.gz "$src_url" - echo "${src_sum} synapse_source.tar.gz" | sha256sum -c --status \ - || ynh_die "Corrupt source" - pip install --upgrade synapse_source.tar.gz + ynh_setup_source "/tmp" "python_source" + pip install --upgrade "/tmp/synapse_source.tar.gz" # Fix issue with msgpack see https://github.com/YunoHost-Apps/synapse_ynh/issues/29 test -e $final_path/lib/python2.7/site-packages/msgpack/__init__.py || (\ pip uninstall -y msgpack-python msgpack; \ pip install msgpack-python) - # This fonction was defined while we call "source $final_path/bin/activate". By this fonction de undo what does "$final_path/bin/activate" + # This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does deactivate fi +#================================================= +# MIGRATION 1 : USE SYNAPSE OWN KEYS +#================================================= + +if [[ -z "$registration_shared_secret" ]] +then + # Go in virtualenvironnement + PS1=${PS1:-} + source $final_path/bin/activate + + # Get the dh.pem if exist + test -e /etc/matrix-$app/dh.pem && mv /etc/matrix-$app/dh.pem /etc/matrix-$app/$domain.tls.dh + test -e /etc/matrix-$app/homeserver.signing.key && mv /etc/matrix-$app/homeserver.signing.key /etc/matrix-$app/$domain.signing.key + + # Generate config and keys + python -m synapse.app.homeserver --keys-directory /etc/matrix-$app/ --generate-config --generate-keys --server-name $domain --report-stats=no -c homeserver.yml + + # This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does + deactivate + + # Get random values from config + registration_shared_secret=$(egrep "registration_shared_secret" homeserver.yml | cut -d'"' -f2) + form_secret=$(egrep "form_secret" homeserver.yml | cut -d'"' -f1) + + # store in yunohost settings + ynh_app_setting_set $app registration_shared_secret "$registration_shared_secret" + ynh_app_setting_set $app form_secret "$form_secret" +fi + #================================================= # UPDATE SYNAPSE CONFIG #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files homeserver_config_path="/etc/matrix-$app/homeserver.yaml" @@ -135,6 +162,9 @@ ynh_replace_string __PORT__ $port "$homeserver_config_path" ynh_replace_string __TLS_PORT__ $synapse_tls_port "$homeserver_config_path" ynh_replace_string __TURNSERVER_TLS_PORT__ $turnserver_tls_port "$homeserver_config_path" ynh_replace_string __TURNPWD__ $turnserver_pwd "$homeserver_config_path" +ynh_replace_string __REGISTRATION_SECRET__ "$registration_shared_secret" "$homeserver_config_path" +ynh_replace_string __FORM_SECRET__ "$form_secret" "$homeserver_config_path" +ynh_replace_string __REPORT_STATS__ "$report_stats" "$homeserver_config_path" ynh_replace_string __APP__ $app "/etc/matrix-$app/log.yaml" @@ -149,7 +179,7 @@ ynh_store_file_checksum "$homeserver_config_path" ynh_store_file_checksum "/etc/matrix-$app/log.yaml" #================================================= -# MIGRATION 1 : MULTINSTANCE SUPPORT +# MIGRATION 2 : MULTINSTANCE SUPPORT #================================================= if [[ ! -e /etc/matrix-$app/coturn.conf ]] @@ -183,8 +213,7 @@ then fi #================================================= -# MIGRATION 2 : USE STANDARD ACCESS FOR CERTIFCATE -# AND USE INDEPENDANT DH FILE +# MIGRATION 3 : USE STANDARD ACCESS FOR CERTIFCATE #================================================= # Fix issue about certificates access @@ -194,12 +223,6 @@ then adduser turnserver ssl-cert fi -# In the old synapse instance we stored the dh.pem in /etc/yunohost/certs/DOMAIN.TLD/ but it was problematics with lets'encrypt witch made a link to the key. While the letsencrypt key was changed the dh.pem file was lost. So we decided to move to /etc/matrix-synapse/ witch is a directory witch is not managed by any other component. -# Here we check if the dh.pem file is already moved. If not we try to copy the file from the old place. If the file in the old place was already removed (by letsencrypt) we create a new one. -test -e /etc/matrix-$app/dh.pem || \ - cp /etc/yunohost/certs/$domain/dh.pem /etc/matrix-$app/dh.pem || \ - openssl dhparam -out /etc/matrix-$app/dh.pem 2048 > /dev/null - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -212,7 +235,7 @@ ynh_add_nginx_config # UPDATE COTURN CONFIG #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files coturn_config_path="/etc/matrix-$app/coturn.conf" @@ -251,7 +274,7 @@ ynh_store_file_checksum "$coturn_config_path" # ADD SCRIPT FOR COTURN CRON #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE +# WARNING : theses command are used in INSTALL, UPGRADE # For any update do it in all files cp ../sources/Coturn_config_rotate.sh $final_path/ @@ -274,14 +297,15 @@ ynh_add_systemd_config coturn-$app coturn-synapse.service # SECURE FILES AND DIRECTORIES #================================================= -# WARRNING : theses command are used in INSTALL, UPGRADE (2 times), RESTORE +# WARNING : theses command are used in INSTALL, UPGRADE, RESTORE # For any update do it in all files chown $synapse_user:root -R $final_path +chmod 770 $final_path/Coturn_config_rotate.sh chown $synapse_user:root -R /var/lib/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app -chmod 600 /etc/matrix-$app/dh.pem +chmod 600 /etc/matrix-$app/{$domain.signing.key,$domain.tls.crt,$domain.tls.dh,$domain.tls.key} setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app diff --git a/sources/Coturn_config_rotate.sh b/sources/Coturn_config_rotate.sh index 186e6bc..e01c3fc 100644 --- a/sources/Coturn_config_rotate.sh +++ b/sources/Coturn_config_rotate.sh @@ -25,4 +25,8 @@ fi ynh_replace_string "^external-ip=.*\$" "$external_IP_line" "/etc/matrix-$app_instance/coturn.conf" -exit 0 \ No newline at end of file +setfacl -R -m user:turnserver:rX /etc/matrix-$app_instance + +systemctl restart coturn-$app_instance.service + +exit 0