Compare commits
4 commits
Author | SHA1 | Date | |
---|---|---|---|
07df829bd0 | |||
b8266d5a28 | |||
80d2007ba9 | |||
45cb56d22b |
47 changed files with 3404 additions and 0 deletions
744
cdist/conf/type/__coturn/files/turnserver.conf.sh
Executable file
744
cdist/conf/type/__coturn/files/turnserver.conf.sh
Executable file
|
@ -0,0 +1,744 @@
|
|||
#!/bin/sh
|
||||
|
||||
generate_use_auth_secret () {
|
||||
if [ $USE_AUTH_SECRET ]; then
|
||||
echo 'use-auth-secret'
|
||||
else
|
||||
echo '#use-auth-secret'
|
||||
fi
|
||||
}
|
||||
|
||||
generate_static_auth_secret () {
|
||||
if [ "$STATIC_AUTH_SECRET" $! "" ]; then
|
||||
echo "static-auth-secret=$STATIC_AUTH_SECRET"
|
||||
else
|
||||
echo "#static-auth-secret=north"
|
||||
fi
|
||||
}
|
||||
|
||||
generate_realm () {
|
||||
if [ "$REALM" != "" ]; then
|
||||
echo "realm=$REALM"
|
||||
else
|
||||
echo "#realm=mycompany.org"
|
||||
fi
|
||||
}
|
||||
|
||||
generate_no_tcp_relay () {
|
||||
if [ $NO_TCP_RELAY ]; then
|
||||
echo 'no-tcp-releay'
|
||||
else
|
||||
echo '#no-tcp-relay'
|
||||
fi
|
||||
}
|
||||
|
||||
cat << EOF
|
||||
# Coturn TURN SERVER configuration file
|
||||
#
|
||||
# Boolean values note: where boolean value is supposed to be used,
|
||||
# you can use '0', 'off', 'no', 'false', 'f' as 'false,
|
||||
# and you can use '1', 'on', 'yes', 'true', 't' as 'true'
|
||||
# If the value is missed, then it means 'true'.
|
||||
#
|
||||
|
||||
# Listener interface device (optional, Linux only).
|
||||
# NOT RECOMMENDED.
|
||||
#
|
||||
#listening-device=eth0
|
||||
|
||||
# TURN listener port for UDP and TCP (Default: 3478).
|
||||
# Note: actually, TLS & DTLS sessions can connect to the
|
||||
# "plain" TCP & UDP port(s), too - if allowed by configuration.
|
||||
#
|
||||
#listening-port=3478
|
||||
|
||||
# TURN listener port for TLS (Default: 5349).
|
||||
# Note: actually, "plain" TCP & UDP sessions can connect to the TLS & DTLS
|
||||
# port(s), too - if allowed by configuration. The TURN server
|
||||
# "automatically" recognizes the type of traffic. Actually, two listening
|
||||
# endpoints (the "plain" one and the "tls" one) are equivalent in terms of
|
||||
# functionality; but we keep both endpoints to satisfy the RFC 5766 specs.
|
||||
# For secure TCP connections, we currently support SSL version 3 and
|
||||
# TLS version 1.0, 1.1 and 1.2.
|
||||
# For secure UDP connections, we support DTLS version 1.
|
||||
#
|
||||
#tls-listening-port=5349
|
||||
|
||||
# Alternative listening port for UDP and TCP listeners;
|
||||
# default (or zero) value means "listening port plus one".
|
||||
# This is needed for RFC 5780 support
|
||||
# (STUN extension specs, NAT behavior discovery). The TURN Server
|
||||
# supports RFC 5780 only if it is started with more than one
|
||||
# listening IP address of the same family (IPv4 or IPv6).
|
||||
# RFC 5780 is supported only by UDP protocol, other protocols
|
||||
# are listening to that endpoint only for "symmetry".
|
||||
#
|
||||
#alt-listening-port=0
|
||||
|
||||
# Alternative listening port for TLS and DTLS protocols.
|
||||
# Default (or zero) value means "TLS listening port plus one".
|
||||
#
|
||||
#alt-tls-listening-port=0
|
||||
|
||||
# Listener IP address of relay server. Multiple listeners can be specified.
|
||||
# If no IP(s) specified in the config file or in the command line options,
|
||||
# then all IPv4 and IPv6 system IPs will be used for listening.
|
||||
#
|
||||
#listening-ip=172.17.19.101
|
||||
#listening-ip=10.207.21.238
|
||||
#listening-ip=2607:f0d0:1002:51::4
|
||||
|
||||
# Auxiliary STUN/TURN server listening endpoint.
|
||||
# Aux servers have almost full TURN and STUN functionality.
|
||||
# The (minor) limitations are:
|
||||
#
|
||||
# 1) Auxiliary servers do not have alternative ports and
|
||||
# they do not support STUN RFC 5780 functionality (CHANGE REQUEST).
|
||||
#
|
||||
# 2) Auxiliary servers also are never returning ALTERNATIVE-SERVER reply.
|
||||
#
|
||||
# Valid formats are 1.2.3.4:5555 for IPv4 and [1:2::3:4]:5555 for IPv6.
|
||||
#
|
||||
# There may be multiple aux-server options, each will be used for listening
|
||||
# to client requests.
|
||||
#
|
||||
#aux-server=172.17.19.110:33478
|
||||
#aux-server=[2607:f0d0:1002:51::4]:33478
|
||||
|
||||
# (recommended for older Linuxes only)
|
||||
# Automatically balance UDP traffic over auxiliary servers (if configured).
|
||||
# The load balancing is using the ALTERNATE-SERVER mechanism.
|
||||
# The TURN client must support 300 ALTERNATE-SERVER response for this
|
||||
# functionality.
|
||||
#
|
||||
#udp-self-balance
|
||||
|
||||
# Relay interface device for relay sockets (optional, Linux only).
|
||||
# NOT RECOMMENDED.
|
||||
#
|
||||
#relay-device=eth1
|
||||
|
||||
# Relay address (the local IP address that will be used to relay the
|
||||
# packets to the peer).
|
||||
# Multiple relay addresses may be used.
|
||||
# The same IP(s) can be used as both listening IP(s) and relay IP(s).
|
||||
#
|
||||
# If no relay IP(s) specified, then the turnserver will apply the default
|
||||
# policy: it will decide itself which relay addresses to be used, and it
|
||||
# will always be using the client socket IP address as the relay IP address
|
||||
# of the TURN session (if the requested relay address family is the same
|
||||
# as the family of the client socket).
|
||||
#
|
||||
#relay-ip=172.17.19.105
|
||||
#relay-ip=2607:f0d0:1002:51::5
|
||||
|
||||
# For Amazon EC2 users:
|
||||
#
|
||||
# TURN Server public/private address mapping, if the server is behind NAT.
|
||||
# In that situation, if a -X is used in form "-X <ip>" then that ip will be reported
|
||||
# as relay IP address of all allocations. This scenario works only in a simple case
|
||||
# when one single relay address is be used, and no RFC5780 functionality is required.
|
||||
# That single relay address must be mapped by NAT to the 'external' IP.
|
||||
# The "external-ip" value, if not empty, is returned in XOR-RELAYED-ADDRESS field.
|
||||
# For that 'external' IP, NAT must forward ports directly (relayed port 12345
|
||||
# must be always mapped to the same 'external' port 12345).
|
||||
#
|
||||
# In more complex case when more than one IP address is involved,
|
||||
# that option must be used several times, each entry must
|
||||
# have form "-X <public-ip/private-ip>", to map all involved addresses.
|
||||
# RFC5780 NAT discovery STUN functionality will work correctly,
|
||||
# if the addresses are mapped properly, even when the TURN server itself
|
||||
# is behind A NAT.
|
||||
#
|
||||
# By default, this value is empty, and no address mapping is used.
|
||||
#
|
||||
#external-ip=60.70.80.91
|
||||
#
|
||||
#OR:
|
||||
#
|
||||
#external-ip=60.70.80.91/172.17.19.101
|
||||
#external-ip=60.70.80.92/172.17.19.102
|
||||
|
||||
|
||||
# Number of the relay threads to handle the established connections
|
||||
# (in addition to authentication thread and the listener thread).
|
||||
# If explicitly set to 0 then application runs relay process in a
|
||||
# single thread, in the same thread with the listener process
|
||||
# (the authentication thread will still be a separate thread).
|
||||
#
|
||||
# If this parameter is not set, then the default OS-dependent
|
||||
# thread pattern algorithm will be employed. Usually the default
|
||||
# algorithm is the most optimal, so you have to change this option
|
||||
# only if you want to make some fine tweaks.
|
||||
#
|
||||
# In the older systems (Linux kernel before 3.9),
|
||||
# the number of UDP threads is always one thread per network listening
|
||||
# endpoint - including the auxiliary endpoints - unless 0 (zero) or
|
||||
# 1 (one) value is set.
|
||||
#
|
||||
#relay-threads=0
|
||||
|
||||
# Lower and upper bounds of the UDP relay endpoints:
|
||||
# (default values are 49152 and 65535)
|
||||
#
|
||||
#min-port=49152
|
||||
#max-port=65535
|
||||
|
||||
# Uncomment to run TURN server in 'normal' 'moderate' verbose mode.
|
||||
# By default the verbose mode is off.
|
||||
#verbose
|
||||
|
||||
# Uncomment to run TURN server in 'extra' verbose mode.
|
||||
# This mode is very annoying and produces lots of output.
|
||||
# Not recommended under any normal circumstances.
|
||||
#
|
||||
#Verbose
|
||||
|
||||
# Uncomment to use fingerprints in the TURN messages.
|
||||
# By default the fingerprints are off.
|
||||
#
|
||||
#fingerprint
|
||||
|
||||
# Uncomment to use long-term credential mechanism.
|
||||
# By default no credentials mechanism is used (any user allowed).
|
||||
#
|
||||
#lt-cred-mech
|
||||
|
||||
# This option is opposite to lt-cred-mech.
|
||||
# (TURN Server with no-auth option allows anonymous access).
|
||||
# If neither option is defined, and no users are defined,
|
||||
# then no-auth is default. If at least one user is defined,
|
||||
# in this file or in command line or in usersdb file, then
|
||||
# lt-cred-mech is default.
|
||||
#
|
||||
#no-auth
|
||||
|
||||
# TURN REST API flag.
|
||||
# (Time Limited Long Term Credential)
|
||||
# Flag that sets a special authorization option that is based upon authentication secret.
|
||||
#
|
||||
# This feature's purpose is to support "TURN Server REST API", see
|
||||
# "TURN REST API" link in the project's page
|
||||
# https://github.com/coturn/coturn/
|
||||
#
|
||||
# This option is used with timestamp:
|
||||
#
|
||||
# usercombo -> "timestamp:userid"
|
||||
# turn user -> usercombo
|
||||
# turn password -> base64(hmac(secret key, usercombo))
|
||||
#
|
||||
# This allows TURN credentials to be accounted for a specific user id.
|
||||
# If you don't have a suitable id, the timestamp alone can be used.
|
||||
# This option is just turning on secret-based authentication.
|
||||
# The actual value of the secret is defined either by option static-auth-secret,
|
||||
# or can be found in the turn_secret table in the database (see below).
|
||||
#
|
||||
# Read more about it:
|
||||
# - https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
|
||||
# - https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf
|
||||
#
|
||||
# Be aware that use-auth-secret overrides some part of lt-cred-mech.
|
||||
# Notice that this feature depends internally on lt-cred-mech, so if you set
|
||||
# use-auth-secret then it enables internally automatically lt-cred-mech option
|
||||
# like if you enable both.
|
||||
#
|
||||
# You can use only one of the to auth mechanisms in the same time because,
|
||||
# both mechanism use the username and password validation in different way.
|
||||
#
|
||||
# This way be aware that you can't use both auth mechnaism in the same time!
|
||||
# Use in config either the lt-cred-mech or the use-auth-secret
|
||||
# to avoid any confusion.
|
||||
#
|
||||
$(generate_use_auth_secret)
|
||||
|
||||
# 'Static' authentication secret value (a string) for TURN REST API only.
|
||||
# If not set, then the turn server
|
||||
# will try to use the 'dynamic' value in turn_secret table
|
||||
# in user database (if present). The database-stored value can be changed on-the-fly
|
||||
# by a separate program, so this is why that other mode is 'dynamic'.
|
||||
#
|
||||
$(generate_static_auth_secret)
|
||||
|
||||
# Server name used for
|
||||
# the oAuth authentication purposes.
|
||||
# The default value is the realm name.
|
||||
#
|
||||
#server-name=blackdow.carleon.gov
|
||||
|
||||
# Flag that allows oAuth authentication.
|
||||
#
|
||||
#oauth
|
||||
|
||||
# 'Static' user accounts for long term credentials mechanism, only.
|
||||
# This option cannot be used with TURN REST API.
|
||||
# 'Static' user accounts are NOT dynamically checked by the turnserver process,
|
||||
# so that they can NOT be changed while the turnserver is running.
|
||||
#
|
||||
#user=username1:key1
|
||||
#user=username2:key2
|
||||
# OR:
|
||||
#user=username1:password1
|
||||
#user=username2:password2
|
||||
#
|
||||
# Keys must be generated by turnadmin utility. The key value depends
|
||||
# on user name, realm, and password:
|
||||
#
|
||||
# Example:
|
||||
# $ turnadmin -k -u ninefingers -r north.gov -p youhavetoberealistic
|
||||
# Output: 0xbc807ee29df3c9ffa736523fb2c4e8ee
|
||||
# ('0x' in the beginning of the key is what differentiates the key from
|
||||
# password. If it has 0x then it is a key, otherwise it is a password).
|
||||
#
|
||||
# The corresponding user account entry in the config file will be:
|
||||
#
|
||||
#user=ninefingers:0xbc807ee29df3c9ffa736523fb2c4e8ee
|
||||
# Or, equivalently, with open clear password (less secure):
|
||||
#user=ninefingers:youhavetoberealistic
|
||||
#
|
||||
|
||||
# SQLite database file name.
|
||||
#
|
||||
# Default file name is /var/db/turndb or /usr/local/var/db/turndb or
|
||||
# /var/lib/turn/turndb.
|
||||
#
|
||||
#userdb=/var/db/turndb
|
||||
|
||||
# PostgreSQL database connection string in the case that we are using PostgreSQL
|
||||
# as the user database.
|
||||
# This database can be used for long-term credential mechanism
|
||||
# and it can store the secret value for secret-based timed authentication in TURN RESP API.
|
||||
# See http://www.postgresql.org/docs/8.4/static/libpq-connect.html for 8.x PostgreSQL
|
||||
# versions connection string format, see
|
||||
# http://www.postgresql.org/docs/9.2/static/libpq-connect.html#LIBPQ-CONNSTRING
|
||||
# for 9.x and newer connection string formats.
|
||||
#
|
||||
#psql-userdb="host=<host> dbname=<database-name> user=<database-user> password=<database-user-password> connect_timeout=30"
|
||||
|
||||
# MySQL database connection string in the case that we are using MySQL
|
||||
# as the user database.
|
||||
# This database can be used for long-term credential mechanism
|
||||
# and it can store the secret value for secret-based timed authentication in TURN RESP API.
|
||||
#
|
||||
# Optional connection string parameters for the secure communications (SSL):
|
||||
# ca, capath, cert, key, cipher
|
||||
# (see http://dev.mysql.com/doc/refman/5.1/en/ssl-options.html for the
|
||||
# command options description).
|
||||
#
|
||||
# Use string format as below (space separated parameters, all optional):
|
||||
#
|
||||
#mysql-userdb="host=<host> dbname=<database-name> user=<database-user> password=<database-user-password> port=<port> connect_timeout=<seconds> read_timeout=<seconds>"
|
||||
|
||||
# If you want to use in the MySQL connection string the password in encrypted format,
|
||||
# then set in this option the MySQL password encryption secret key file.
|
||||
#
|
||||
# Warning: If this option is set, then mysql password must be set in "mysql-userdb" in encrypted format!
|
||||
# If you want to use cleartext password then do not set this option!
|
||||
#
|
||||
# This is the file path which contain secret key of aes encryption while using password encryption.
|
||||
#
|
||||
#secret-key-file=/path/
|
||||
|
||||
# MongoDB database connection string in the case that we are using MongoDB
|
||||
# as the user database.
|
||||
# This database can be used for long-term credential mechanism
|
||||
# and it can store the secret value for secret-based timed authentication in TURN RESP API.
|
||||
# Use string format is described at http://hergert.me/docs/mongo-c-driver/mongoc_uri.html
|
||||
#
|
||||
#mongo-userdb="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"
|
||||
|
||||
# Redis database connection string in the case that we are using Redis
|
||||
# as the user database.
|
||||
# This database can be used for long-term credential mechanism
|
||||
# and it can store the secret value for secret-based timed authentication in TURN RESP API.
|
||||
# Use string format as below (space separated parameters, all optional):
|
||||
#
|
||||
#redis-userdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
|
||||
|
||||
# Redis status and statistics database connection string, if used (default - empty, no Redis stats DB used).
|
||||
# This database keeps allocations status information, and it can be also used for publishing
|
||||
# and delivering traffic and allocation event notifications.
|
||||
# The connection string has the same parameters as redis-userdb connection string.
|
||||
# Use string format as below (space separated parameters, all optional):
|
||||
#
|
||||
#redis-statsdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
|
||||
|
||||
# The default realm to be used for the users when no explicit
|
||||
# origin/realm relationship was found in the database, or if the TURN
|
||||
# server is not using any database (just the commands-line settings
|
||||
# and the userdb file). Must be used with long-term credentials
|
||||
# mechanism or with TURN REST API.
|
||||
#
|
||||
# Note: If default realm is not specified at all, then realm falls back to the host domain name.
|
||||
# If domain name is empty string, or '(None)', then it is initialized to am empty string.
|
||||
#
|
||||
$(generate_realm)
|
||||
|
||||
# The flag that sets the origin consistency
|
||||
# check: across the session, all requests must have the same
|
||||
# main ORIGIN attribute value (if the ORIGIN was
|
||||
# initially used by the session).
|
||||
#
|
||||
#check-origin-consistency
|
||||
|
||||
# Per-user allocation quota.
|
||||
# default value is 0 (no quota, unlimited number of sessions per user).
|
||||
# This option can also be set through the database, for a particular realm.
|
||||
#
|
||||
#user-quota=0
|
||||
|
||||
# Total allocation quota.
|
||||
# default value is 0 (no quota).
|
||||
# This option can also be set through the database, for a particular realm.
|
||||
#
|
||||
#total-quota=0
|
||||
|
||||
# Max bytes-per-second bandwidth a TURN session is allowed to handle
|
||||
# (input and output network streams are treated separately). Anything above
|
||||
# that limit will be dropped or temporary suppressed (within
|
||||
# the available buffer limits).
|
||||
# This option can also be set through the database, for a particular realm.
|
||||
#
|
||||
#max-bps=0
|
||||
|
||||
#
|
||||
# Maximum server capacity.
|
||||
# Total bytes-per-second bandwidth the TURN server is allowed to allocate
|
||||
# for the sessions, combined (input and output network streams are treated separately).
|
||||
#
|
||||
# bps-capacity=0
|
||||
|
||||
# Uncomment if no UDP client listener is desired.
|
||||
# By default UDP client listener is always started.
|
||||
#
|
||||
#no-udp
|
||||
|
||||
# Uncomment if no TCP client listener is desired.
|
||||
# By default TCP client listener is always started.
|
||||
#
|
||||
#no-tcp
|
||||
|
||||
# Uncomment if no TLS client listener is desired.
|
||||
# By default TLS client listener is always started.
|
||||
#
|
||||
#no-tls
|
||||
|
||||
# Uncomment if no DTLS client listener is desired.
|
||||
# By default DTLS client listener is always started.
|
||||
#
|
||||
#no-dtls
|
||||
|
||||
# Uncomment if no UDP relay endpoints are allowed.
|
||||
# By default UDP relay endpoints are enabled (like in RFC 5766).
|
||||
#
|
||||
#no-udp-relay
|
||||
|
||||
# Uncomment if no TCP relay endpoints are allowed.
|
||||
# By default TCP relay endpoints are enabled (like in RFC 6062).
|
||||
#
|
||||
$(generate_no_tcp_relay)
|
||||
|
||||
# Uncomment if extra security is desired,
|
||||
# with nonce value having limited lifetime.
|
||||
# By default, the nonce value is unique for a session,
|
||||
# and has unlimited lifetime.
|
||||
# Set this option to limit the nonce lifetime.
|
||||
# It defaults to 600 secs (10 min) if no value is provided. After that delay,
|
||||
# the client will get 438 error and will have to re-authenticate itself.
|
||||
#
|
||||
#stale-nonce=600
|
||||
|
||||
# Uncomment if you want to set the maximum allocation
|
||||
# time before it has to be refreshed.
|
||||
# Default is 3600s.
|
||||
#
|
||||
#max-allocate-lifetime=3600
|
||||
|
||||
|
||||
# Uncomment to set the lifetime for the channel.
|
||||
# Default value is 600 secs (10 minutes).
|
||||
# This value MUST not be changed for production purposes.
|
||||
#
|
||||
#channel-lifetime=600
|
||||
|
||||
# Uncomment to set the permission lifetime.
|
||||
# Default to 300 secs (5 minutes).
|
||||
# In production this value MUST not be changed,
|
||||
# however it can be useful for test purposes.
|
||||
#
|
||||
#permission-lifetime=300
|
||||
|
||||
# Certificate file.
|
||||
# Use an absolute path or path relative to the
|
||||
# configuration file.
|
||||
#
|
||||
#cert=/usr/local/etc/turn_server_cert.pem
|
||||
|
||||
# Private key file.
|
||||
# Use an absolute path or path relative to the
|
||||
# configuration file.
|
||||
# Use PEM file format.
|
||||
#
|
||||
#pkey=/usr/local/etc/turn_server_pkey.pem
|
||||
|
||||
# Private key file password, if it is in encoded format.
|
||||
# This option has no default value.
|
||||
#
|
||||
#pkey-pwd=...
|
||||
|
||||
# Allowed OpenSSL cipher list for TLS/DTLS connections.
|
||||
# Default value is "DEFAULT".
|
||||
#
|
||||
#cipher-list="DEFAULT"
|
||||
|
||||
# CA file in OpenSSL format.
|
||||
# Forces TURN server to verify the client SSL certificates.
|
||||
# By default it is not set: there is no default value and the client
|
||||
# certificate is not checked.
|
||||
#
|
||||
# Example:
|
||||
#CA-file=/etc/ssh/id_rsa.cert
|
||||
|
||||
# Curve name for EC ciphers, if supported by OpenSSL
|
||||
# library (TLS and DTLS). The default value is prime256v1,
|
||||
# if pre-OpenSSL 1.0.2 is used. With OpenSSL 1.0.2+,
|
||||
# an optimal curve will be automatically calculated, if not defined
|
||||
# by this option.
|
||||
#
|
||||
#ec-curve-name=prime256v1
|
||||
|
||||
# Use 566 bits predefined DH TLS key. Default size of the key is 1066.
|
||||
#
|
||||
#dh566
|
||||
|
||||
# Use 2066 bits predefined DH TLS key. Default size of the key is 1066.
|
||||
#
|
||||
#dh2066
|
||||
|
||||
# Use custom DH TLS key, stored in PEM format in the file.
|
||||
# Flags --dh566 and --dh2066 are ignored when the DH key is taken from a file.
|
||||
#
|
||||
#dh-file=<DH-PEM-file-name>
|
||||
|
||||
# Flag to prevent stdout log messages.
|
||||
# By default, all log messages are going to both stdout and to
|
||||
# the configured log file. With this option everything will be
|
||||
# going to the configured log only (unless the log file itself is stdout).
|
||||
#
|
||||
#no-stdout-log
|
||||
|
||||
# Option to set the log file name.
|
||||
# By default, the turnserver tries to open a log file in
|
||||
# /var/log, /var/tmp, /tmp and current directories directories
|
||||
# (which open operation succeeds first that file will be used).
|
||||
# With this option you can set the definite log file name.
|
||||
# The special names are "stdout" and "-" - they will force everything
|
||||
# to the stdout. Also, the "syslog" name will force everything to
|
||||
# the system log (syslog).
|
||||
# In the runtime, the logfile can be reset with the SIGHUP signal
|
||||
# to the turnserver process.
|
||||
#
|
||||
#log-file=/var/tmp/turn.log
|
||||
|
||||
# Option to redirect all log output into system log (syslog).
|
||||
#
|
||||
syslog
|
||||
|
||||
# This flag means that no log file rollover will be used, and the log file
|
||||
# name will be constructed as-is, without PID and date appendage.
|
||||
# This option can be used, for example, together with the logrotate tool.
|
||||
#
|
||||
#simple-log
|
||||
|
||||
# Option to set the "redirection" mode. The value of this option
|
||||
# will be the address of the alternate server for UDP & TCP service in form of
|
||||
# <ip>[:<port>]. The server will send this value in the attribute
|
||||
# ALTERNATE-SERVER, with error 300, on ALLOCATE request, to the client.
|
||||
# Client will receive only values with the same address family
|
||||
# as the client network endpoint address family.
|
||||
# See RFC 5389 and RFC 5766 for ALTERNATE-SERVER functionality description.
|
||||
# The client must use the obtained value for subsequent TURN communications.
|
||||
# If more than one --alternate-server options are provided, then the functionality
|
||||
# can be more accurately described as "load-balancing" than a mere "redirection".
|
||||
# If the port number is omitted, then the default port
|
||||
# number 3478 for the UDP/TCP protocols will be used.
|
||||
# Colon (:) characters in IPv6 addresses may conflict with the syntax of
|
||||
# the option. To alleviate this conflict, literal IPv6 addresses are enclosed
|
||||
# in square brackets in such resource identifiers, for example:
|
||||
# [2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478 .
|
||||
# Multiple alternate servers can be set. They will be used in the
|
||||
# round-robin manner. All servers in the pool are considered of equal weight and
|
||||
# the load will be distributed equally. For example, if we have 4 alternate servers,
|
||||
# then each server will receive 25% of ALLOCATE requests. A alternate TURN server
|
||||
# address can be used more than one time with the alternate-server option, so this
|
||||
# can emulate "weighting" of the servers.
|
||||
#
|
||||
# Examples:
|
||||
#alternate-server=1.2.3.4:5678
|
||||
#alternate-server=11.22.33.44:56789
|
||||
#alternate-server=5.6.7.8
|
||||
#alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478
|
||||
|
||||
# Option to set alternative server for TLS & DTLS services in form of
|
||||
# <ip>:<port>. If the port number is omitted, then the default port
|
||||
# number 5349 for the TLS/DTLS protocols will be used. See the previous
|
||||
# option for the functionality description.
|
||||
#
|
||||
# Examples:
|
||||
#tls-alternate-server=1.2.3.4:5678
|
||||
#tls-alternate-server=11.22.33.44:56789
|
||||
#tls-alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478
|
||||
|
||||
# Option to suppress TURN functionality, only STUN requests will be processed.
|
||||
# Run as STUN server only, all TURN requests will be ignored.
|
||||
# By default, this option is NOT set.
|
||||
#
|
||||
#stun-only
|
||||
|
||||
# Option to suppress STUN functionality, only TURN requests will be processed.
|
||||
# Run as TURN server only, all STUN requests will be ignored.
|
||||
# By default, this option is NOT set.
|
||||
#
|
||||
#no-stun
|
||||
|
||||
# This is the timestamp/username separator symbol (character) in TURN REST API.
|
||||
# The default value is ':'.
|
||||
# rest-api-separator=:
|
||||
|
||||
# Flag that can be used to allow peers on the loopback addresses (127.x.x.x and ::1).
|
||||
# This is an extra security measure.
|
||||
#
|
||||
# (To avoid any security issue that allowing loopback access may raise,
|
||||
# the no-loopback-peers option is replaced by allow-loopback-peers.)
|
||||
#
|
||||
# Allow it only for testing in a development environment!
|
||||
# In production it adds a possible security vulnerability, so for security reasons
|
||||
# it is not allowed using it together with empty cli-password.
|
||||
#
|
||||
#allow-loopback-peers
|
||||
|
||||
# Flag that can be used to disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*).
|
||||
# This is an extra security measure.
|
||||
#
|
||||
#no-multicast-peers
|
||||
|
||||
# Option to set the max time, in seconds, allowed for full allocation establishment.
|
||||
# Default is 60 seconds.
|
||||
#
|
||||
#max-allocate-timeout=60
|
||||
|
||||
# Option to allow or ban specific ip addresses or ranges of ip addresses.
|
||||
# If an ip address is specified as both allowed and denied, then the ip address is
|
||||
# considered to be allowed. This is useful when you wish to ban a range of ip
|
||||
# addresses, except for a few specific ips within that range.
|
||||
#
|
||||
# This can be used when you do not want users of the turn server to be able to access
|
||||
# machines reachable by the turn server, but would otherwise be unreachable from the
|
||||
# internet (e.g. when the turn server is sitting behind a NAT)
|
||||
#
|
||||
# Examples:
|
||||
# denied-peer-ip=83.166.64.0-83.166.95.255
|
||||
# allowed-peer-ip=83.166.68.45
|
||||
|
||||
# File name to store the pid of the process.
|
||||
# Default is /var/run/turnserver.pid (if superuser account is used) or
|
||||
# /var/tmp/turnserver.pid .
|
||||
#
|
||||
#pidfile="/var/run/turnserver.pid"
|
||||
|
||||
# Require authentication of the STUN Binding request.
|
||||
# By default, the clients are allowed anonymous access to the STUN Binding functionality.
|
||||
#
|
||||
#secure-stun
|
||||
|
||||
# Mobility with ICE (MICE) specs support.
|
||||
#
|
||||
#mobility
|
||||
|
||||
# Allocate Address Family according
|
||||
# If enabled then TURN server allocates address family according the TURN
|
||||
# Client <=> Server communication address family.
|
||||
# (By default coTURN works according RFC 6156.)
|
||||
# !!Warning: Enabling this option breaks RFC6156 section-4.2 (violates use default IPv4)!!
|
||||
#
|
||||
#keep-address-family
|
||||
|
||||
|
||||
# User name to run the process. After the initialization, the turnserver process
|
||||
# will make an attempt to change the current user ID to that user.
|
||||
#
|
||||
#proc-user=<user-name>
|
||||
|
||||
# Group name to run the process. After the initialization, the turnserver process
|
||||
# will make an attempt to change the current group ID to that group.
|
||||
#
|
||||
#proc-group=<group-name>
|
||||
|
||||
# Turn OFF the CLI support.
|
||||
# By default it is always ON.
|
||||
# See also options cli-ip and cli-port.
|
||||
#
|
||||
#no-cli
|
||||
|
||||
#Local system IP address to be used for CLI server endpoint. Default value
|
||||
# is 127.0.0.1.
|
||||
#
|
||||
#cli-ip=127.0.0.1
|
||||
|
||||
# CLI server port. Default is 5766.
|
||||
#
|
||||
#cli-port=5766
|
||||
|
||||
# CLI access password. Default is empty (no password).
|
||||
# For the security reasons, it is recommended to use the encrypted
|
||||
# for of the password (see the -P command in the turnadmin utility).
|
||||
#
|
||||
# Secure form for password 'qwerty':
|
||||
#
|
||||
#cli-password=$5$79a316b350311570$81df9cfb9af7f5e5a76eada31e7097b663a0670f99a3c07ded3f1c8e59c5658a
|
||||
#
|
||||
# Or unsecure form for the same password:
|
||||
#
|
||||
#cli-password=qwerty
|
||||
|
||||
# Enable Web-admin support on https. By default it is Disabled.
|
||||
# If it is enabled it also enables a http a simple static banner page
|
||||
# with a small reminder that the admin page is available only on https.
|
||||
#
|
||||
#web-admin
|
||||
|
||||
# Local system IP address to be used for Web-admin server endpoint. Default value is 127.0.0.1.
|
||||
#
|
||||
#web-admin-ip=127.0.0.1
|
||||
|
||||
# Web-admin server port. Default is 8080.
|
||||
#
|
||||
#web-admin-port=8080
|
||||
|
||||
# Web-admin server listen on STUN/TURN worker threads
|
||||
# By default it is disabled for security resons! (Not recommended in any production environment!)
|
||||
#
|
||||
#web-admin-listen-on-workers
|
||||
|
||||
# Server relay. NON-STANDARD AND DANGEROUS OPTION.
|
||||
# Only for those applications when we want to run
|
||||
# server applications on the relay endpoints.
|
||||
# This option eliminates the IP permissions check on
|
||||
# the packets incoming to the relay endpoints.
|
||||
#
|
||||
#server-relay
|
||||
|
||||
# Maximum number of output sessions in ps CLI command.
|
||||
# This value can be changed on-the-fly in CLI. The default value is 256.
|
||||
#
|
||||
#cli-max-output-sessions
|
||||
|
||||
# Set network engine type for the process (for internal purposes).
|
||||
#
|
||||
#ne=[1|2|3]
|
||||
|
||||
# Do not allow an TLS/DTLS version of protocol
|
||||
#
|
||||
#no-tlsv1
|
||||
#no-tlsv1_1
|
||||
#no-tlsv1_2
|
||||
EOF
|
61
cdist/conf/type/__coturn/man.rst
Normal file
61
cdist/conf/type/__coturn/man.rst
Normal file
|
@ -0,0 +1,61 @@
|
|||
cdist-type__coturn(7)
|
||||
=====================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__coturn - Install and configure a coturn TURN server
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This (singleton) type install and configure a coturn TURN
|
||||
server.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
None.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
static_auth_secret
|
||||
Secret used to access the TURN REST API.
|
||||
|
||||
realm
|
||||
Defailt realm.
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
use_auth_secret
|
||||
Allows TURN credentials to be accounted for a specific user id.
|
||||
|
||||
no_tcp_relay
|
||||
Disable TCP relay endpoints.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
__coturn \
|
||||
--realm turn.domain.tld \
|
||||
--no_tcp_relay
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- `coturn Github repository <https://github.com/coturn/coturn>`_
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Timothée Floure <timothee.floure@ungleich.ch>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2020 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.
|
55
cdist/conf/type/__coturn/manifest
Executable file
55
cdist/conf/type/__coturn/manifest
Executable file
|
@ -0,0 +1,55 @@
|
|||
#!/bin/sh -e
|
||||
#
|
||||
# 2020 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/>.
|
||||
#
|
||||
|
||||
__package coturn
|
||||
|
||||
# Optional parameters.
|
||||
if [ -f "$__object/parameter/use_auth_secret" ]; then
|
||||
export USE_AUTH_SECRET=1
|
||||
fi
|
||||
|
||||
if [ -f "$__object/parameter/static_auth_secret" ]; then
|
||||
static_auth_secret=$(cat "$__object/parameter/static_auth_secret")
|
||||
export STATIC_AUTH_SECRET=$static_auth_secret
|
||||
fi
|
||||
|
||||
if [ -f "$__object/parameter/realm" ]; then
|
||||
realm=$(cat "$__object/parameter/realm")
|
||||
export REALM=$realm
|
||||
fi
|
||||
|
||||
if [ -f "$__object/parameter/no_tcp_relay" ]; then
|
||||
no_tcp_relay=$(cat "$__object/parameter/no_tcp_relay")
|
||||
export NO_TCP_RELAY=$no_tcp_relay
|
||||
fi
|
||||
|
||||
# Hardcoded.
|
||||
coturn_config='/etc/turnserver.conf'
|
||||
|
||||
# Generate and deploy configuration file.
|
||||
mkdir -p "$__object/files"
|
||||
"$__type/files/turnserver.conf.sh" > "$__object/files/turnserver.conf"
|
||||
|
||||
__file $coturn_config \
|
||||
--source "$__object/files/turnserver.conf" \
|
||||
--state present
|
||||
|
||||
# Restart coturn server.
|
||||
require="__file/$coturn_config" __service coturn --action restart
|
2
cdist/conf/type/__coturn/parameter/boolean
Normal file
2
cdist/conf/type/__coturn/parameter/boolean
Normal file
|
@ -0,0 +1,2 @@
|
|||
use_auth_secret
|
||||
no_tcp_relay
|
2
cdist/conf/type/__coturn/parameter/optional
Normal file
2
cdist/conf/type/__coturn/parameter/optional
Normal file
|
@ -0,0 +1,2 @@
|
|||
static_auth_secret
|
||||
realm
|
0
cdist/conf/type/__coturn/singleton
Normal file
0
cdist/conf/type/__coturn/singleton
Normal file
56
cdist/conf/type/__matrix_riot/files/config.json.sh
Executable file
56
cdist/conf/type/__matrix_riot/files/config.json.sh
Executable file
|
@ -0,0 +1,56 @@
|
|||
#!/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
|
||||
}
|
||||
|
||||
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",
|
||||
"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
|
||||
]
|
||||
},
|
||||
$(generate_embedded_pages)
|
||||
"terms_and_conditions_links": [
|
||||
{
|
||||
"url": "$PRIVACY_POLICY_URL",
|
||||
"text": "Privacy Policy"
|
||||
},
|
||||
{
|
||||
"url": "$COOKIE_POLICY_URL",
|
||||
"text": "Cookie Policy"
|
||||
}
|
||||
]
|
||||
}
|
||||
EOF
|
74
cdist/conf/type/__matrix_riot/gencode-remote
Executable file
74
cdist/conf/type/__matrix_riot/gencode-remote
Executable file
|
@ -0,0 +1,74 @@
|
|||
#!/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"
|
||||
config='config.json'
|
||||
homepage='home.html'
|
||||
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)
|
||||
cd \$tmpdir
|
||||
|
||||
# Download and extract sources.
|
||||
curl -L '$url' > $archive
|
||||
tar xf $archive
|
||||
|
||||
# Backup configuration deployed by __matrix_riot.
|
||||
cp '$INSTALL_DIR/$config' '$config'
|
||||
|
||||
# Backup homepage deployed by __matrix_riot
|
||||
if [ -f '$INSTALL_DIR/$homepage' ]; then
|
||||
cp '$INSTALL_DIR/$homepage' '$homepage'
|
||||
fi
|
||||
|
||||
# Deploy sources and restore configuration.
|
||||
rm -r '$INSTALL_DIR'
|
||||
mv '$src' '$INSTALL_DIR'
|
||||
cp '$config' '$INSTALL_DIR/$config'
|
||||
|
||||
# Restore homepage if available.
|
||||
if [ -f '$homepage' ]; then
|
||||
cp '$homepage' '$INSTALL_DIR/$homepage'
|
||||
fi
|
||||
|
||||
# Chown deployed files to requested owner.
|
||||
chown -R '$OWNER' '$INSTALL_DIR'
|
||||
|
||||
# Remove temporary working directory.
|
||||
cd /
|
||||
rm -r \$tmpdir
|
||||
EOF
|
72
cdist/conf/type/__matrix_riot/man.rst
Normal file
72
cdist/conf/type/__matrix_riot/man.rst
Normal file
|
@ -0,0 +1,72 @@
|
|||
cdist-type__matrix_riot(7)
|
||||
======================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__matrix_riot - Install and configure Riot, a web Matrix client.
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type install and configure the Riot web client.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
install_dir
|
||||
Root directory of Riot's static files.
|
||||
|
||||
version
|
||||
Release of Riot 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 'Riot'.
|
||||
|
||||
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://riot.im/privacy'.
|
||||
|
||||
cookie_policy_url
|
||||
Defaults to 'https://matrix.org/docs/guides/riot_im_cookie_policy'.
|
||||
|
||||
homepage
|
||||
Path to custom Riot homepage, displayed once logged in.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
__matrix_riot my-riot --install_dir /var/www/riot-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.
|
68
cdist/conf/type/__matrix_riot/manifest
Executable file
68
cdist/conf/type/__matrix_riot/manifest
Executable file
|
@ -0,0 +1,68 @@
|
|||
#!/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/>.
|
||||
#
|
||||
|
||||
INSTALL_DIR=$(cat "$__object/parameter/install_dir")
|
||||
|
||||
default_server_name=$(cat "$__object/parameter/default_server_name")
|
||||
brand=$(cat "$__object/parameter/brand")
|
||||
default_country_code=$(cat "$__object/parameter/default_country_code")
|
||||
room_directory_servers=$(cat "$__object/parameter/room_directory_servers")
|
||||
privacy_policy_url=$(cat "$__object/parameter/privacy_policy_url")
|
||||
cookie_policy_url=$(cat "$__object/parameter/cookie_policy_url")
|
||||
|
||||
export DEFAULT_SERVER_NAME=$default_server_name
|
||||
export BRAND=$brand
|
||||
export DEFAULT_COUNTRY_CODE=$default_country_code
|
||||
export ROOM_DIRECTORY_SERVERS=$room_directory_servers
|
||||
export PRIVACY_POLICY_URL=$privacy_policy_url
|
||||
export COOKIE_POLICY_URL=$cookie_policy_url
|
||||
|
||||
if [ -f "$__object/parameter/homepage" ]; then
|
||||
export EMBED_HOMEPAGE=1
|
||||
homepage=$(cat "$__object/parameter/homepage")
|
||||
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" \
|
||||
--owner "$owner" --mode 0755 --parents \
|
||||
--state present
|
||||
require="__directory/$INSTALL_DIR" __file "$INSTALL_DIR/config.json" \
|
||||
--source "$__object/files/config.json" \
|
||||
--mode 0664 \
|
||||
--state present
|
||||
if [ $EMBED_HOMEPAGE ]; then
|
||||
require="__directory/$INSTALL_DIR" __file "$INSTALL_DIR/home.html" \
|
||||
--source "$homepage" \
|
||||
--mode 0664 \
|
||||
--state present
|
||||
fi
|
1
cdist/conf/type/__matrix_riot/parameter/default/brand
Normal file
1
cdist/conf/type/__matrix_riot/parameter/default/brand
Normal file
|
@ -0,0 +1 @@
|
|||
Riot
|
|
@ -0,0 +1 @@
|
|||
https://matrix.org/docs/guides/riot_im_cookie_policy
|
|
@ -0,0 +1 @@
|
|||
GB
|
|
@ -0,0 +1 @@
|
|||
matrix.org
|
|
@ -0,0 +1 @@
|
|||
https://matrix-client.matrix.org
|
1
cdist/conf/type/__matrix_riot/parameter/default/owner
Normal file
1
cdist/conf/type/__matrix_riot/parameter/default/owner
Normal file
|
@ -0,0 +1 @@
|
|||
root
|
|
@ -0,0 +1 @@
|
|||
https://riot.im/privacy
|
|
@ -0,0 +1 @@
|
|||
"matrix.org"
|
9
cdist/conf/type/__matrix_riot/parameter/optional
Normal file
9
cdist/conf/type/__matrix_riot/parameter/optional
Normal file
|
@ -0,0 +1,9 @@
|
|||
default_server_url
|
||||
default_server_name
|
||||
brand
|
||||
default_country_code
|
||||
privacy_policy_url
|
||||
cookie_policy_url
|
||||
room_directory_servers
|
||||
owner
|
||||
homepage
|
2
cdist/conf/type/__matrix_riot/parameter/required
Normal file
2
cdist/conf/type/__matrix_riot/parameter/required
Normal file
|
@ -0,0 +1,2 @@
|
|||
version
|
||||
install_dir
|
1651
cdist/conf/type/__matrix_synapse/files/homeserver.yaml.sh
Executable file
1651
cdist/conf/type/__matrix_synapse/files/homeserver.yaml.sh
Executable file
File diff suppressed because it is too large
Load diff
38
cdist/conf/type/__matrix_synapse/files/log.config.sh
Executable file
38
cdist/conf/type/__matrix_synapse/files/log.config.sh
Executable file
|
@ -0,0 +1,38 @@
|
|||
#!/bin/sh
|
||||
|
||||
cat << EOF
|
||||
version: 1
|
||||
|
||||
formatters:
|
||||
precise:
|
||||
format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s- %(message)s'
|
||||
|
||||
filters:
|
||||
context:
|
||||
(): synapse.util.logcontext.LoggingContextFilter
|
||||
request: ""
|
||||
|
||||
handlers:
|
||||
file:
|
||||
class: logging.handlers.RotatingFileHandler
|
||||
formatter: precise
|
||||
filename: $LOG_DIR/homeserver.log
|
||||
maxBytes: 104857600
|
||||
backupCount: 10
|
||||
filters: [context]
|
||||
level: INFO
|
||||
console:
|
||||
class: logging.StreamHandler
|
||||
formatter: precise
|
||||
|
||||
loggers:
|
||||
synapse:
|
||||
level: INFO
|
||||
|
||||
synapse.storage.SQL:
|
||||
level: INFO
|
||||
|
||||
root:
|
||||
level: INFO
|
||||
handlers: [file, console]
|
||||
EOF
|
122
cdist/conf/type/__matrix_synapse/man.rst
Normal file
122
cdist/conf/type/__matrix_synapse/man.rst
Normal file
|
@ -0,0 +1,122 @@
|
|||
cdist-type__matrix_synapse(7)
|
||||
======================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__matrix_synapse - Install and configure Synapse, a Matrix homeserver
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type install and configure the Synapse Matrix homeserver. This is a
|
||||
signleton type.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
server_name
|
||||
Name of your homeserver (e.g. ungleich.ch) used as part of your MXIDs. This
|
||||
value cannot be changed without meddling with the database once the server is
|
||||
being used.
|
||||
|
||||
base_url
|
||||
Public URL of your homeserver (e.g. http://matrix.ungleich.ch).
|
||||
|
||||
database_engine
|
||||
'sqlite3' or 'postgresql'
|
||||
|
||||
database_name
|
||||
Path to the database if SQLite3 is used or database name if PostgresSQL is
|
||||
used.
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
database_host
|
||||
Database node address, only used with PostgresSQL.
|
||||
|
||||
database_user
|
||||
Database user, only used with PostgresSQL.
|
||||
|
||||
database_password
|
||||
Database password, only used with PostgresSQL.
|
||||
|
||||
ldap_uri
|
||||
Address of your LDAP server.
|
||||
|
||||
ldap_base_dn
|
||||
Base DN of your LDAP tree.
|
||||
|
||||
ldap_uid_attribute
|
||||
LDAP attriute mapping to Synapse's uid field, default to uid.
|
||||
|
||||
ldap_mail_attribute
|
||||
LDAP attriute mapping to Synapse's mail field, default to mail.
|
||||
|
||||
ldap_name_attribute
|
||||
LDAP attriute mapping to Synapse's name field, default to givenName.
|
||||
|
||||
ldap_bind_dn
|
||||
User used to authenticate against your LDAP server in 'search' mode.
|
||||
|
||||
ldap_bind_password
|
||||
Password used to authenticate against your LDAP server in 'search' mode.
|
||||
|
||||
ldap_filter
|
||||
LDAP user filter, defaulting to `(objectClass=posixAccount)`.
|
||||
|
||||
turn_uri
|
||||
URI to TURN server, can be provided multiple times if there is more than one
|
||||
server.
|
||||
|
||||
turn_shared_secret
|
||||
Shared secret used to access the TURN REST API.
|
||||
|
||||
turn_user_lifetime
|
||||
Lifetime of TURN credentials. Defaults to 1h.
|
||||
|
||||
max_upload_size
|
||||
Maximum size for user-uploaded files. Defaults to 10M.
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
allow_registration
|
||||
Enables user registration on the homeserver.
|
||||
|
||||
enable_ldap_auth
|
||||
Enables ldap-backed authentication.
|
||||
|
||||
ldap_search_mode
|
||||
Enables 'search' mode for LDAP auth backend.
|
||||
|
||||
report_stats
|
||||
Whether or not to report anonymized homeserver usage statistics.
|
||||
|
||||
expose_metrics
|
||||
Expose metrics endpoint for Prometheus.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
__matrix_synapse --server_name ungleich.ch \
|
||||
--base_url https://matrix.ungleich.ch \
|
||||
--database_engine sqlite3 \
|
||||
--database_name /var/lib/matrix-syanpse/homeserver.db
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- `cdist-type__matrix_riot(7) <cdist-type__matrix_riot.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.
|
234
cdist/conf/type/__matrix_synapse/manifest
Executable file
234
cdist/conf/type/__matrix_synapse/manifest
Executable file
|
@ -0,0 +1,234 @@
|
|||
#!/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/>.
|
||||
#
|
||||
|
||||
# OS-specific configuration.
|
||||
os=$(cat "$__global/explorer/os")
|
||||
distribution=$(cat "$__global/explorer/lsb_codename")
|
||||
|
||||
case "$os" in
|
||||
debian)
|
||||
synapse_user=matrix-synapse
|
||||
synapse_pkg=matrix-synapse
|
||||
synapse_service=matrix-synapse
|
||||
ldap_auth_provider_pkg=matrix-synapse-ldap3
|
||||
psycopg2_pkg=python3-psycopg2
|
||||
synapse_conf_dir='/etc/matrix-synapse'
|
||||
synapse_data_dir='/var/lib/matrix-synapse'
|
||||
|
||||
if [ ! -f "$__global/explorer/lsb_codename" ]; then
|
||||
ls "$__global/explorer" >&2
|
||||
echo "Could not determine Debian release, ensure that lsb-release is installed on the target." >&2
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
fedora)
|
||||
synapse_user=synapse
|
||||
synapse_pkg=matrix-synapse
|
||||
synapse_service=synapse
|
||||
ldap_auth_provider_pkg=python-matrix-synapse-ldap3
|
||||
synapse_conf_dir='/etc/synapse'
|
||||
synapse_data_dir='/var/lib/synapse'
|
||||
;;
|
||||
freebsd)
|
||||
synapse_user=synapse
|
||||
synapse_pkg=py36-matrix-synapse
|
||||
synapse_service=synapse
|
||||
ldap_auth_provider_pkg=py36-matrix-synapse-ldap3
|
||||
synapse_conf_dir='/usr/local/etc/matrix-synapse'
|
||||
synapse_data_dir='/var/matrix-synapse'
|
||||
;;
|
||||
alpine)
|
||||
echo "As of 2019-12-19 matrix-synapse is not in alpine stable. Exiting."
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
printf "Your operating system (%s) is currently not supported by this type (%s)\n" "$os" "${__type##*/}" >&2
|
||||
printf "Please contribute an implementation for it if you can.\n" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
# Required parameters:
|
||||
server_name=$(cat "$__object/parameter/server_name")
|
||||
export SERVER_NAME=$server_name
|
||||
base_url=$(cat "$__object/parameter/base_url")
|
||||
export BASE_URL=$base_url
|
||||
|
||||
export DATA_DIR=$synapse_data_dir
|
||||
export LOG_DIR='/var/log/matrix-synapse'
|
||||
export PIDFILE='/var/run/matrix/homeserver.pid'
|
||||
export LOG_CONFIG_PATH="$synapse_conf_dir/log.yaml"
|
||||
export SIGNING_KEY_PATH="$synapse_conf_dir/signin.key"
|
||||
|
||||
database_engine=$(cat "$__object/parameter/database_engine")
|
||||
export DATABASE_ENGINE=$database_engine
|
||||
database_name=$(cat "$__object/parameter/database_name")
|
||||
export DATABASE_NAME=$database_name
|
||||
|
||||
# Optional parameters:
|
||||
database_host=$(cat "$__object/parameter/database_host")
|
||||
export DATABASE_HOST=$database_host
|
||||
database_user=$(cat "$__object/parameter/database_user")
|
||||
export DATABASE_USER=$database_user
|
||||
database_password=$(cat "$__object/parameter/database_password")
|
||||
export DATABASE_PASSWORD=$database_password
|
||||
|
||||
ldap_filter=$(cat "$__object/parameter/ldap_filter")
|
||||
export LDAP_FILTER=$ldap_filter
|
||||
ldap_uid_attribute=$(cat "$__object/parameter/ldap_uid_attribute")
|
||||
export LDAP_UID_ATTRIBUTE=$ldap_uid_attribute
|
||||
ldap_mail_attribute=$(cat "$__object/parameter/ldap_mail_attribute")
|
||||
export LDAP_MAIL_ATTRIBUTE=$ldap_mail_attribute
|
||||
ldap_name_attribute=$(cat "$__object/parameter/ldap_name_attribute")
|
||||
export LDAP_NAME_ATTRIBUTE=$ldap_name_attribute
|
||||
ldap_uri=$(cat "$__object/parameter/ldap_uri")
|
||||
export LDAP_URI=$ldap_uri
|
||||
ldap_base_dn=$(cat "$__object/parameter/ldap_base_dn")
|
||||
export LDAP_BASE_DN=$ldap_base_dn
|
||||
ldap_bind_dn=$(cat "$__object/parameter/ldap_bind_dn")
|
||||
export LDAP_BIND_DN=$ldap_bind_dn
|
||||
ldap_bind_password=$(cat "$__object/parameter/ldap_bind_password")
|
||||
export LDAP_BIND_PASSWORD=$ldap_bind_password
|
||||
|
||||
turn_user_lifetime=$(cat "$__object/parameter/turn_user_lifetime")
|
||||
export TURN_USER_LIFETIME=$turn_user_lifetime
|
||||
if [ -f "$__object/parameter/turn_shared_secret" ]; then
|
||||
turn_shared_secret=$(cat "$__object/parameter/turn_shared_secret")
|
||||
export TURN_SHARED_SECRET=$turn_shared_secret
|
||||
fi
|
||||
if [ -f "$__object/parameter/turn_uri" ]; then
|
||||
uris=$(tr "\n" "," < "$__object/parameter/turn_uri" | sed 's/,$//')
|
||||
export TURN_URIS="[$uris]"
|
||||
fi
|
||||
|
||||
max_upload_size=$(cat "$__object/parameter/max_upload_size")
|
||||
export MAX_UPLOAD_SIZE=$max_upload_size
|
||||
|
||||
# Boolean parameters:
|
||||
if [ -f "$__object/parameter/report_stats" ]; then
|
||||
export REPORT_STATS='true'
|
||||
else
|
||||
export REPORT_STATS='false'
|
||||
fi
|
||||
if [ -f "$__object/parameter/allow_registration" ]; then
|
||||
export ALLOW_REGISTRATION='true'
|
||||
else
|
||||
export ALLOW_REGISTRATION='false'
|
||||
fi
|
||||
if [ -f "$__object/parameter/enable_ldap_auth" ]; then
|
||||
export ENABLE_LDAP_AUTH='true'
|
||||
else
|
||||
export ENABLE_LDAP_AUTH='false'
|
||||
fi
|
||||
if [ -f "$__object/parameter/ldap_search_mode" ]; then
|
||||
export LDAP_SEARCH_MODE=1
|
||||
fi
|
||||
if [ -f "$__object/parameter/expose_metrics" ]; then
|
||||
export EXPOSE_METRICS='true'
|
||||
else
|
||||
export EXPOSE_METRICS='false'
|
||||
fi
|
||||
|
||||
# Specific case for debian-buster, boilerplate but there's not much I can do
|
||||
# about it.
|
||||
|
||||
installation_reqs=""
|
||||
if [ "$os" = "debian" ] && [ "$distribution" = "buster" ]; then
|
||||
# Enable debian-backports for debian Buster, as the 'stable'
|
||||
# matrix-synapse package is ways too old (< 1.0).
|
||||
__apt_source debian-backports \
|
||||
--uri http://deb.debian.org/debian/ \
|
||||
--distribution "$distribution-backports" \
|
||||
--component main
|
||||
require="__apt_source/debian-backports" __apt_update_index
|
||||
|
||||
# Install base matrix-synapse package.
|
||||
require="__apt_update_index" __package_apt $synapse_pkg \
|
||||
--state present \
|
||||
--target-release "$distribution-backports"
|
||||
|
||||
# Install LdapAuthProvider module if LDAP auth is enabled.
|
||||
if [ "$ENABLE_LDAP_AUTH" = "true" ]; then
|
||||
require="__package_apt/$synapse_pkg" __package_apt $ldap_auth_provider_pkg \
|
||||
--state present \
|
||||
--target-release "$distribution-backports"
|
||||
installation_reqs="$installation_reqs __package_apt/$ldap_auth_provider_pkg"
|
||||
fi
|
||||
|
||||
# For some reason, psycopg2 is not considered a dependency of
|
||||
# matrix-synapse in matrix.org's APT repository.
|
||||
if [ "$DATABASE_ENGINE" = "psycopg2" ]; then
|
||||
require="__package_apt/$synapse_pkg" __package_apt $psycopg2_pkg \
|
||||
--state present
|
||||
installation_reqs="$installation_reqs __package_apt/$psycopg2_pkg"
|
||||
fi
|
||||
|
||||
# Used for dependency order resolution.
|
||||
installation_reqs="$installation_reqs __package_apt/$synapse_pkg"
|
||||
else
|
||||
# Install base matrix-synapse package.
|
||||
__package $synapse_pkg --state present
|
||||
|
||||
# Install LdapAuthProvider module if LDAP auth is enabled.
|
||||
if [ "$ENABLE_LDAP_AUTH" = "true" ]; then
|
||||
require="__package/$synapse_pkg" __package $ldap_auth_provider_pkg \
|
||||
--state present
|
||||
fi
|
||||
|
||||
# Used for dependency order resolution.
|
||||
installation_reqs="__package/$synapse_pkg"
|
||||
fi
|
||||
|
||||
# Generate and deploy configuration files.
|
||||
mkdir -p "$__object/files"
|
||||
"$__type/files/homeserver.yaml.sh" > "$__object/files/homeserver.yaml"
|
||||
"$__type/files/log.config.sh" > "$__object/files/log.config"
|
||||
|
||||
require="$installation_reqs" __file "$synapse_conf_dir/homeserver.yaml" \
|
||||
--state present \
|
||||
--owner $synapse_user \
|
||||
--mode 600 \
|
||||
--source "$__object/files/homeserver.yaml"
|
||||
require="$installation_reqs" __file "$LOG_CONFIG_PATH" \
|
||||
--state present \
|
||||
--owner $synapse_user \
|
||||
--mode 600 \
|
||||
--source "$__object/files/log.config"
|
||||
require="$installation_reqs" __directory $DATA_DIR --state present --owner $synapse_user
|
||||
require="$installation_reqs" __directory $LOG_DIR --state present --owner $synapse_user
|
||||
|
||||
# Work around dpkg-reconfigure for Debian package.
|
||||
RESTART_REQUIRES="__file/$synapse_conf_dir/homeserver.yaml"
|
||||
if [ "$os" = "debian" ]; then
|
||||
require="$installation_reqs" __file "$synapse_conf_dir/conf.d/server_name.yaml" \
|
||||
--state present --owner $synapse_user --source - << EOF
|
||||
server_name: "$SERVER_NAME"
|
||||
EOF
|
||||
require="$installation_reqs" __file "$synapse_conf_dir/conf.d/report_stats.yaml" \
|
||||
--state present --owner $synapse_user --source - << EOF
|
||||
report_stats: $REPORT_STATS
|
||||
EOF
|
||||
|
||||
RESTART_REQUIRES="$RESTART_REQUIRES __file/$synapse_conf_dir/conf.d/server_name.yaml \
|
||||
__file/$synapse_conf_dir/conf.d/report_stats.yaml"
|
||||
fi
|
||||
|
||||
# Restart synapse homeserver to reload configuration.
|
||||
require="$RESTART_REQUIRES" __service $synapse_service --action restart
|
5
cdist/conf/type/__matrix_synapse/parameter/boolean
Normal file
5
cdist/conf/type/__matrix_synapse/parameter/boolean
Normal file
|
@ -0,0 +1,5 @@
|
|||
allow_registration
|
||||
enable_ldap_auth
|
||||
ldap_search_mode
|
||||
report_stats
|
||||
expose_metrics
|
|
@ -0,0 +1 @@
|
|||
(objectClass=posixAccount)
|
|
@ -0,0 +1 @@
|
|||
mail
|
|
@ -0,0 +1 @@
|
|||
givenName
|
|
@ -0,0 +1 @@
|
|||
uid
|
|
@ -0,0 +1 @@
|
|||
10M
|
|
@ -0,0 +1 @@
|
|||
1h
|
14
cdist/conf/type/__matrix_synapse/parameter/optional
Normal file
14
cdist/conf/type/__matrix_synapse/parameter/optional
Normal file
|
@ -0,0 +1,14 @@
|
|||
database_host
|
||||
database_user
|
||||
database_password
|
||||
ldap_uri
|
||||
ldap_base_dn
|
||||
ldap_uid_attribute
|
||||
ldap_mail_attribute
|
||||
ldap_name_attribute
|
||||
ldap_bind_dn
|
||||
ldap_bind_password
|
||||
ldap_filter
|
||||
turn_shared_secret
|
||||
turn_user_lifetime
|
||||
max_upload_size
|
|
@ -0,0 +1 @@
|
|||
turn_uri
|
4
cdist/conf/type/__matrix_synapse/parameter/required
Normal file
4
cdist/conf/type/__matrix_synapse/parameter/required
Normal file
|
@ -0,0 +1,4 @@
|
|||
server_name
|
||||
base_url
|
||||
database_engine
|
||||
database_name
|
0
cdist/conf/type/__matrix_synapse/singleton
Normal file
0
cdist/conf/type/__matrix_synapse/singleton
Normal file
18
cdist/conf/type/__matterbridge/files/matterbridge.service.sh
Executable file
18
cdist/conf/type/__matterbridge/files/matterbridge.service.sh
Executable file
|
@ -0,0 +1,18 @@
|
|||
#!/bin/sh
|
||||
|
||||
cat <<EOF
|
||||
[Unit]
|
||||
Description=IM bridging daemon
|
||||
Wants=network-online.target
|
||||
After=network-online.target
|
||||
|
||||
[Service]
|
||||
User=$USER
|
||||
Group=$GROUP
|
||||
Type=simple
|
||||
Restart=on-failure
|
||||
ExecStart=$BINARY_PATH -conf=/etc/matterbridge/matterbridge.toml
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
EOF
|
56
cdist/conf/type/__matterbridge/man.rst
Normal file
56
cdist/conf/type/__matterbridge/man.rst
Normal file
|
@ -0,0 +1,56 @@
|
|||
cdist-type__matterbridge(7)
|
||||
===========================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__matterbridge - Install matterbridge from upstream binary
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This singleton type install a matterbridge service from binary.
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
version
|
||||
Release (git tag) to fetch from the project github's page.
|
||||
|
||||
config
|
||||
Matterbridge configuration (TOML).
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
None.
|
||||
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
None.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
__matterbridge --version 1.16.3 --config - << EOF
|
||||
[...]
|
||||
EOF
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- `Matterbridge github repository <https://github.com/42wim/matterbridge>`_
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Timothée Floure <timothee.floure@ungleich.ch>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2020 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.
|
100
cdist/conf/type/__matterbridge/manifest
Executable file
100
cdist/conf/type/__matterbridge/manifest
Executable file
|
@ -0,0 +1,100 @@
|
|||
#!/bin/sh -e
|
||||
#
|
||||
# 2020 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/>.
|
||||
#
|
||||
|
||||
os=$(cat "$__global/explorer/os")
|
||||
case "$os" in
|
||||
debian)
|
||||
# This type assume systemd for service installation.
|
||||
;;
|
||||
*)
|
||||
printf "Your operating system (%s) is currently not supported by this type (%s)\n" "$os" "${__type##*/}" >&2
|
||||
printf "Please contribute an implementation for it if you can.\n" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
# Required parameters.
|
||||
VERSION=$(cat "$__object/parameter/version")
|
||||
if [ -f "$__object/parameter/config" ]; then
|
||||
CONFIG="$(cat "$__object/parameter/config")"
|
||||
if [ "$CONFIG" = "-" ]; then
|
||||
CONFIG=$(cat "$__object/stdin")
|
||||
fi
|
||||
fi
|
||||
|
||||
# Hardcoded values used in templates.
|
||||
export BINARY_PATH=/usr/local/bin/matterbridge
|
||||
export CONFIG_PATH=/etc/matterbridge/matterbridge.toml
|
||||
export USER=matterbridge
|
||||
export GROUP=$USER
|
||||
|
||||
# Internal variables.
|
||||
artefact="matterbridge-$VERSION-linux-64bit"
|
||||
checksum_file="checksums.txt"
|
||||
release_download_url=https://github.com/42wim/matterbridge/releases/download
|
||||
binary_url="$release_download_url/v$VERSION/$artefact"
|
||||
checksum_file_url="$release_download_url/v$VERSION/$checksum_file"
|
||||
config_dir=$(dirname $CONFIG_PATH)
|
||||
systemd_unit_path='/etc/systemd/system/matterbridge.service'
|
||||
|
||||
# Check if curl is available.
|
||||
if ! command -v curl > /dev/null; then
|
||||
echo "curl is required for this type, but could not be found. Exiting." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Initialize working directory.
|
||||
mkdir -p "$__object/files"
|
||||
|
||||
# Download and check matterbridge binary.
|
||||
curl -L "$binary_url" -o "$__object/files/$artefact"
|
||||
curl -L "$checksum_file_url" -o "$__object/files/$checksum_file"
|
||||
ls "$__object/files/" >&2
|
||||
cat "$__object/files/checksums.txt" >&2
|
||||
if ! (cd "$__object/files"; sha256sum --ignore-missing --check $checksum_file); then
|
||||
echo "Matterbridge binary checksum failed." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Create service user.
|
||||
__user $USER --home "/var/lib/$USER"
|
||||
|
||||
# Deploy matterbridge binary.
|
||||
require="__user/$USER" __file "$BINARY_PATH" \
|
||||
--source "$__object/files/$artefact" \
|
||||
--owner "$USER" --mode 755
|
||||
|
||||
# Generate and deploy configuration file.
|
||||
"$__type/files/matterbridge.service.sh" > "$__object/files/matterbridge.service"
|
||||
|
||||
require="__user/$USER" __directory "$config_dir" \
|
||||
--owner "$USER" --mode 0755 --parents \
|
||||
|
||||
require="__directory/$config_dir" echo "$CONFIG" | __file "$CONFIG_PATH" \
|
||||
--owner "$USER" \
|
||||
--mode 0640 \
|
||||
--source -
|
||||
|
||||
__file "$systemd_unit_path" \
|
||||
--source "$__object/files/matterbridge.service"
|
||||
|
||||
# Deal with init system.
|
||||
require="__file/$systemd_unit_path" __start_on_boot matterbridge
|
||||
require="__file/$BINARY_PATH __file/$CONFIG_PATH __file/$systemd_unit_path" __service matterbridge --action restart
|
2
cdist/conf/type/__matterbridge/parameter/required
Normal file
2
cdist/conf/type/__matterbridge/parameter/required
Normal file
|
@ -0,0 +1,2 @@
|
|||
version
|
||||
config
|
0
cdist/conf/type/__matterbridge/singleton
Normal file
0
cdist/conf/type/__matterbridge/singleton
Normal file
Loading…
Reference in a new issue