YunoHost-Apps/synapse_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/synapse_ynh.git synced 2024-09-03 20:26:38 +02:00
Code Issues Activity Actions

Merge pull request #2 from gnouts/choose-server-name

Browse source 
Choose server name
This commit is contained in:
Thatoo 2019-07-01 12:20:36 +02:00 • committed by GitHub
commit 3415d1cbf2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -41,11 +41,11 @@ If your server name is identical to the domain on which synapse is installed, an
If not, you may need to put the following line in the dns configuration: If not, you may need to put the following line in the dns configuration:
``` ```
_matrix._tcp.<yourdomain.com> <ttl> IN SRV 10 0 <port> <server.name> _matrix._tcp.<server_name-you-choose-at-install> <ttl> IN SRV 10 0 <port> <domain-or-subdomain-of-synapse>
``` ```
for example for example
``` ```
_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT example.com. _matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT synapse.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` 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`

2
conf/homeserver.yaml
View file

@ -50,7 +50,7 @@ tls_fingerprints: []
# This is used by remote servers to connect to this server, # This is used by remote servers to connect to this server,
# e.g. matrix.org, localhost:8080, etc. # e.g. matrix.org, localhost:8080, etc.
# This is also the last part of your UserID. # This is also the last part of your UserID.
server_name: "__DOMAIN__" server_name: "__SERVER_NAME__"
# When running as a daemon, the file to store the pid in # When running as a daemon, the file to store the pid in
pid_file: "/var/run/matrix-__APP__.pid" pid_file: "/var/run/matrix-__APP__.pid"

9
manifest.json
View file

@ -29,6 +29,15 @@
"en": "Choose a domain for Synapse", "en": "Choose a domain for Synapse",
"fr": "Choisissez un domaine pour Synapse" "fr": "Choisissez un domaine pour Synapse"
}, },
"example": "synapse.domain.org"
},
{
"name": "server_name",
"type": "string",
"ask": {
"en": "If your synapse domain is a subdomain, you can choose a name for your Synapse server to have your matrix user-ids looking like @user:domain.org instead of @user:synapse.domain.org",
"fr": "Si votre domaine pour synapse est un sous-domaine, vous pouvez choisir un nom pour votre serveur Synapse afin que vos identifiants matrix soient @utilisateur:domain.org plutôt que @utilisateur:synapse.domain.org"
},
"example": "domain.org" "example": "domain.org"
}, },
{ {

2
scripts/config
View file

@ -69,6 +69,7 @@ apply_config() {
fi fi
domain=$(ynh_app_setting_get $app special_domain) domain=$(ynh_app_setting_get $app special_domain)
server_name=$(ynh_app_setting_get $app server_name)
synapse_db_pwd=$(ynh_app_setting_get $app synapse_db_pwd) synapse_db_pwd=$(ynh_app_setting_get $app synapse_db_pwd)
is_public=$(ynh_app_setting_get $app is_public) is_public=$(ynh_app_setting_get $app is_public)
port=$(ynh_app_setting_get $app synapse_port) port=$(ynh_app_setting_get $app synapse_port)
@ -96,6 +97,7 @@ apply_config() {
ynh_replace_string __APP__ $app "$homeserver_config_path" ynh_replace_string __APP__ $app "$homeserver_config_path"
ynh_replace_string __DOMAIN__ $domain "$homeserver_config_path" ynh_replace_string __DOMAIN__ $domain "$homeserver_config_path"
ynh_replace_string __SERVER_NAME__ $server_name "$homeserver_config_path"
ynh_replace_string __SYNAPSE_DB_USER__ $synapse_db_user "$homeserver_config_path" ynh_replace_string __SYNAPSE_DB_USER__ $synapse_db_user "$homeserver_config_path"
ynh_replace_string __SYNAPSE_DB_PWD__ $synapse_db_pwd "$homeserver_config_path" ynh_replace_string __SYNAPSE_DB_PWD__ $synapse_db_pwd "$homeserver_config_path"
ynh_replace_string __PORT__ $port "$homeserver_config_path" ynh_replace_string __PORT__ $port "$homeserver_config_path"

7
scripts/install
View file

@ -32,6 +32,7 @@ report_stats="False"
#================================================= #=================================================
domain=$YNH_APP_ARG_DOMAIN domain=$YNH_APP_ARG_DOMAIN
server_name=$YNH_APP_ARG_SERVER_NAME
is_public=$YNH_APP_ARG_IS_PUBLIC is_public=$YNH_APP_ARG_IS_PUBLIC
path_url="/_matrix" path_url="/_matrix"
final_path="/opt/yunohost/matrix-$app" final_path="/opt/yunohost/matrix-$app"
@ -56,6 +57,7 @@ test ! -e "$final_path" || ynh_die "This path already contains a folder"
# This hack solve the issue : https://github.com/YunoHost-Apps/synapse_ynh/issues/14 # This hack solve the issue : https://github.com/YunoHost-Apps/synapse_ynh/issues/14
ynh_app_setting_set $app special_domain $domain ynh_app_setting_set $app special_domain $domain
ynh_app_setting_set $app special_path $path_url ynh_app_setting_set $app special_path $path_url
ynh_app_setting_set $app server_name $server_name
ynh_app_setting_set $app final_path $final_path ynh_app_setting_set $app final_path $final_path
ynh_app_setting_set $app synapse_version $upstream_version ynh_app_setting_set $app synapse_version $upstream_version
ynh_app_setting_set $app is_public $is_public ynh_app_setting_set $app is_public $is_public
@ -178,7 +180,7 @@ PS1=${PS1:-}
source $final_path/bin/activate source $final_path/bin/activate
# Generate config # Generate config
python -m synapse.app.homeserver --keys-directory /etc/matrix-$app/ --generate-config --generate-keys --server-name $domain --report-stats=no -c homeserver.yml python -m synapse.app.homeserver --keys-directory /etc/matrix-$app/ --generate-config --generate-keys --server-name $server_name --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 # This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does
deactivate deactivate
@ -228,6 +230,7 @@ cp ../conf/log.yaml /etc/matrix-$app/log.yaml
ynh_replace_string __APP__ $app "$homeserver_config_path" ynh_replace_string __APP__ $app "$homeserver_config_path"
ynh_replace_string __DOMAIN__ $domain "$homeserver_config_path" ynh_replace_string __DOMAIN__ $domain "$homeserver_config_path"
ynh_replace_string __SERVER_NAME__ $server_name "$homeserver_config_path"
ynh_replace_string __SYNAPSE_DB_USER__ $synapse_db_user "$homeserver_config_path" ynh_replace_string __SYNAPSE_DB_USER__ $synapse_db_user "$homeserver_config_path"
ynh_replace_string __SYNAPSE_DB_PWD__ $synapse_db_pwd "$homeserver_config_path" ynh_replace_string __SYNAPSE_DB_PWD__ $synapse_db_pwd "$homeserver_config_path"
ynh_replace_string __PORT__ $port "$homeserver_config_path" ynh_replace_string __PORT__ $port "$homeserver_config_path"
@ -327,7 +330,7 @@ chown $synapse_user:root -R /var/lib/matrix-$app
chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app
chown $synapse_user:root -R /etc/matrix-$app chown $synapse_user:root -R /etc/matrix-$app
chmod u=rwX,g=rX,o= -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app
chmod 600 /etc/matrix-$app/$domain.signing.key chmod 600 /etc/matrix-$app/$server_name.signing.key
setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rX /etc/matrix-$app
setfacl -R -m user:turnserver:rwX /var/log/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app

2
scripts/restore
View file

@ -192,7 +192,7 @@ chown $synapse_user:root -R /var/lib/matrix-$app
chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app
chown $synapse_user:root -R /etc/matrix-$app chown $synapse_user:root -R /etc/matrix-$app
chmod u=rwX,g=rX,o= -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app
chmod 600 /etc/matrix-$app/$domain.signing.key chmod 600 /etc/matrix-$app/$server_name.signing.key
setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rX /etc/matrix-$app
setfacl -R -m user:turnserver:rwX /var/log/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app

5
scripts/upgrade
View file

@ -31,6 +31,7 @@ upstream_version=$(ynh_app_upstream_version)
#================================================= #=================================================
domain=$(ynh_app_setting_get $app special_domain) domain=$(ynh_app_setting_get $app special_domain)
server_name=$(ynh_app_setting_get $app server_name)
path_url=$(ynh_app_setting_get $app special_path) path_url=$(ynh_app_setting_get $app special_path)
final_path=$(ynh_app_setting_get $app final_path) final_path=$(ynh_app_setting_get $app final_path)
synapse_old_version=$(ynh_app_setting_get $app synapse_version) synapse_old_version=$(ynh_app_setting_get $app synapse_version)
@ -126,7 +127,7 @@ then
source $final_path/bin/activate source $final_path/bin/activate
# Generate config and keys # 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 python -m synapse.app.homeserver --keys-directory /etc/matrix-$app/ --generate-config --generate-keys --server-name $server_name --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 # This function was defined when we called "source $final_path/bin/activate". With this function we undo what "$final_path/bin/activate" does
deactivate deactivate
@ -330,7 +331,7 @@ chown $synapse_user:root -R /var/lib/matrix-$app
chown $synapse_user:root -R /var/log/matrix-$app chown $synapse_user:root -R /var/log/matrix-$app
chown $synapse_user:root -R /etc/matrix-$app chown $synapse_user:root -R /etc/matrix-$app
chmod u=rwX,g=rX,o= -R /etc/matrix-$app chmod u=rwX,g=rX,o= -R /etc/matrix-$app
chmod 600 /etc/matrix-$app/$domain.signing.key chmod 600 /etc/matrix-$app/$server_name.signing.key
setfacl -R -m user:turnserver:rX /etc/matrix-$app setfacl -R -m user:turnserver:rX /etc/matrix-$app
setfacl -R -m user:turnserver:rwX /var/log/matrix-$app setfacl -R -m user:turnserver:rwX /var/log/matrix-$app