Files
shell_sequencer/seqs/matrix.sh
2020-09-15 14:57:32 +02:00

236 lines
7.0 KiB
Bash
Executable File

#!/bin/bash
toolName=synapse
toolDeps="build-essential python3-dev libffi-dev python3-pip python3-setuptools postgresql libssl-dev virtualenv libjpeg-dev libxslt1-dev libpq5 libpq-dev"
toolUser="synapse"
toolGroup="synapse"
# Filled by configuration
toolConfig=
toolUrl=
# Needed for different steps
postgresDb=""
postgresUser=""
postgresPass=""
# Get script working directory
# (when called from a different directory)
WDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >>/dev/null 2>&1 && pwd )"
CONFIG=0
CONFIG_FILE_NAME="matrix.cfg"
CONFIG_FILE_TEMPLATE="$WDIR/${CONFIG_FILE_NAME}.example"
step_config() {
initSeqConfig "$CONFIG_FILE_NAME" "$CONFIG_FILE_TEMPLATE"
if [ $? -eq 0 ] ; then
CONFIG=1
toolConfig="${MATRIX_HOME}/homeserver.yaml"
toolUrl="https://$MATRIX_DOMAIN"
localHome="$MATRIX_HOME"
echo " $toolName home: $MATRIX_HOME"
echo " $toolName domain: $MATRIX_DOMAIN"
fi
}
step_1_info() { echo "Installing $toolName dependencies"; }
step_1_alias() { ALIAS="install"; }
step_1() {
local aptOption=
exe apt update
endReturn -o $? "Updating apt repositories failed"
if [ $QUIET -ne 0 ] ; then
aptOption="-y"
else
aptOption=""
fi
exe apt install $toolDeps $aptOption
}
step_2_info() { echo "Create postgres database for $toolName"; }
step_2_alias() { ALIAS="createdb"; }
step_2() {
readDatabaseInfos
exe cd ~postgres
exe su -c "psql -c \"CREATE USER ${postgresUser} WITH ENCRYPTED password '${postgresPass}';\"" - postgres
exe su -c "psql -c \"CREATE DATABASE ${postgresDb} ENCODING \"UTF8\" LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER ${postgresUser};\"" - postgres
exe su -c "psql -c \"GRANT ALL PRIVILEGES ON DATABASE \"${postgresDb}\" to ${postgresUser};\"" - postgres
}
step_3_info() { echo "Create $toolName user and group"; }
step_3() {
exe addgroup "$toolGroup"
exe adduser --system --home ${MATRIX_HOME}/ --no-create-home --disabled-password --shell /bin/nologin --ingroup "$toolGroup" "$toolUser"
}
step_4_info() { echo "Install $toolName"; }
step_4() {
exe mkdir -p "$MATRIX_HOME"
exe virtualenv -p python3 "${MATRIX_HOME}/env"
exe cd "$MATRIX_HOME"
exe source "${MATRIX_HOME}/env/bin/activate"
exe pip install --upgrade pip
exe pip install --upgrade setuptools
exe pip install matrix-synapse[postgres]
# Create default configuration
exe python3 -m synapse.app.homeserver --server-name "$MATRIX_DOMAIN" --config-path homeserver.yaml --generate-config --report-stats=no
exe deactivate
# Create media directories
exe mkdir -p ${MATRIX_HOME}/media_store ${MATRIX_HOME}/uploads
exe chmod 770 "${MATRIX_HOME}/media_store" "${MATRIX_HOME}/uploads"
# Allow matrix to write its logs in /opt/synapse
exe chmod 755 "${MATRIX_HOME}"
exe chown ${toolUser}:${toolGroup} "${MATRIX_HOME}" "${MATRIX_HOME}/media_store" "${MATRIX_HOME}/uploads"
}
step_5_info() { echo "Configure $toolName"; }
step_5() {
exe vi "$toolConfig"
}
step_6_info() { echo "Create $toolName systemd service"; }
step_6() {
# eval needed to expand sourced configuration variables
local localService=`eval "echo \"$toolService\""`
addConf -c "$localService" "$toolServiceLoc"
exe systemctl daemon-reload
exe systemctl enable matrix-synapse.service
exe service matrix-synapse start
}
toolServiceLoc="/etc/systemd/system/matrix-synapse.service"
toolService="[Unit]
Description=Matrix Synapse service
After=network.target postgresql.service
[Service]
Type=forking
WorkingDirectory=\${MATRIX_HOME}/
ExecStart=\${MATRIX_HOME}/env/bin/synctl start
ExecStop=\${MATRIX_HOME}/env/bin/synctl stop
ExecReload=\${MATRIX_HOME}/env/bin/synctl restart
User=\${toolUser}
Group=\${toolGroup}
Restart=always
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=synapse
[Install]
WantedBy=multi-user.target"
step_10_info() { echo "Upgrade $toolName installation at $MATRIX_HOME"; }
step_10_alias() { ALIAS="upgrade"; }
step_10() {
echo " [I] Upgrading $toolName"
exe source "${MATRIX_HOME}/env/bin/activate"
exe pip install --upgrade pip
exe pip install --upgrade matrix-synapse
saveReturn $?
exe deactivate
endReturn "Error upgrading $toolName"
echo " [I] Restarting $toolName"
step restart
echo " [I] New Version:"
exe sleep 2
step version
}
step_12_info() { echo "Restart $toolName systemd service"; }
step_12_alias() { ALIAS="restart"; }
step_12() {
exe service matrix-synapse restart
}
step_14_info() { echo "Show $toolName version running at [IP]:8008"; }
step_14_alias() { ALIAS="version"; }
step_14() {
local synapseIP=localhost
shift
if [ ! -z $1 ]; then
synapseIP="$1"
fi
exe curl http://${synapseIP}:8008/_synapse/admin/v1/server_version
}
step_16_info() { echo "Create new user"; }
step_16_alias() { ALIAS="newuser"; }
step_16() {
exe /opt/synapse/env/bin/register_new_matrix_user -c "$MATRIX_HOME/homeserver.yaml" $toolUrl
}
step_18_info() { echo "Drop postgres database for $toolName"; }
step_18_alias() { ALIAS="dropdb"; }
step_18() {
readDatabaseInfos
exe cd ~postgres
exe su -c "psql -c \"DROP DATABASE ${postgresDb};\"" - postgres
}
step_20_info() { echo "Backup postgres database"; }
step_20_alias() { ALIAS="backupdb"; }
step_20() {
local DELYEAR=$(($(date +%Y)-2))
if [ ! -s ~/.pgpass ] ; then
echo " [I] For unattended backup please define ~/.pgpass containing credentials"
echo " e.g. localhost:5432:database:user:pass"
echo "Backup custom pg format with standard user / database: synapse / synapse"
fi
exep "pg_dump -h 127.0.0.1 -U synapse -Fc synapse | bzip2 -c > ${toolDbBackupFolder}/`date +%Y-%m-%d\"_\"%H-%M-%S`.backup.bz2"
exe rm -f ${toolDbBackupFolder}/${DELYEAR}*
}
toolDbBackupFolder=/root/backupdb
step_22_info() { echo "Postgres database restore"; }
step_22_alias() { ALIAS="restoredb"; }
step_22() {
echo " [I] Postgres database restore procedure"
echo "1. Create a empty postgres database first (step 4)"
echo "2. psql -h <host> -U <database user> -d <database name> -W -f <sql dump file>"
echo " e.g. psql -h 127.0.0.1 -U synapse -d synapse -W -f 2018-06-07_18-10-56.sql"
echo "or"
echo "3. Custom postgres format dump restore:"
echo " pg_restore -h localhost -p 5432 -U synapse -d new_db -v \"10.70.0.61.backup\""
echo
echo "Available postgresql databases:"
exe cd ~postgres
exe su postgres -c "psql -c '\l'"
echo "Available postgresql user:"
exe su postgres -c "psql -c '\du'"
}
# Read postgres database information dbname/user/pass if empty
readDatabaseInfos() {
if [ "$postgresDb" == "" ] ; then
read -p "Enter postgres database name: " postgresDb
endCheckEmpty postgresDb "database"
fi
if [ "$postgresUser" == "" ] ; then
read -p "Enter postgres user name: " postgresUser
endCheckEmpty postgresUser "user name"
fi
if [ "$postgresPass" == "" ] ; then
read -s -p "Enter postgres password: " postgresPass
endCheckEmpty postgresPass "password"
fi
echo
}
# Needs readDatabaseInfos() to execute some commands
toolScript() {
if [ ! -z "$1" ] ; then
readDatabaseInfos
fi
}
VERSION_SEQREV=11
. /usr/local/bin/sequencer.sh