svn commit: r431780 - in head: . net/py-matrix-synapse net/py-matrix-synapse/files
Mark Felder
feld at FreeBSD.org
Wed Jan 18 02:21:01 UTC 2017
Author: feld
Date: Wed Jan 18 02:20:59 2017
New Revision: 431780
URL: https://svnweb.freebsd.org/changeset/ports/431780
Log:
net/py-matrix-synapse: Update to 0.18.7
- Add missing run depends
- Add rc script
- Add example configs
- Add instructions to pkg-message
- Add user for daemon to run as non-root
- Add patch to run with newer nacl
- Take maintainership
Approved by: maintainer (private communications)
Differential Revision: https://reviews.freebsd.org/D9228
Added:
head/net/py-matrix-synapse/files/
head/net/py-matrix-synapse/files/homeserver.yaml.in (contents, props changed)
head/net/py-matrix-synapse/files/log.config.in (contents, props changed)
head/net/py-matrix-synapse/files/patch-synapse_python__dependencies.py (contents, props changed)
head/net/py-matrix-synapse/files/pkg-message.in (contents, props changed)
head/net/py-matrix-synapse/files/synapse.in (contents, props changed)
Modified:
head/UIDs
head/net/py-matrix-synapse/Makefile
head/net/py-matrix-synapse/distinfo
Modified: head/UIDs
==============================================================================
--- head/UIDs Wed Jan 18 02:16:54 2017 (r431779)
+++ head/UIDs Wed Jan 18 02:20:59 2017 (r431780)
@@ -72,7 +72,7 @@ zabbix:*:122:122::0:0:Zabbix NMS:/nonexi
_ntp:*:123:123::0:0:NTP Daemon:/var/empty:/usr/sbin/nologin
fetchmail:*:124:124::0:0:Fetchmail mail-retrieval daemon:/nonexistent:/usr/sbin/nologin
postfix:*:125:125::0:0:Postfix Mail System:/var/spool/postfix:/usr/sbin/nologin
-# free: 126
+synapse:*:126:65534::0:0:Synapse Daemon:/nonexistent:/usr/sbin/nologin
navcron:*:127:127::0:0:Network Administration Visualized:/usr/local/nav:/usr/sbin/nologin
sd-agent:*:128:128::0:0:ServerDensity Agent:/nonexistent:/usr/sbin/nologin
# free: 129
Modified: head/net/py-matrix-synapse/Makefile
==============================================================================
--- head/net/py-matrix-synapse/Makefile Wed Jan 18 02:16:54 2017 (r431779)
+++ head/net/py-matrix-synapse/Makefile Wed Jan 18 02:20:59 2017 (r431780)
@@ -3,18 +3,19 @@
PORTNAME= matrix-synapse
DISTVERSIONPREFIX= v
-DISTVERSION= 0.18.4
+DISTVERSION= 0.18.7
+PORTREVISION= 0
CATEGORIES= net python
PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
-MAINTAINER= brendan+freebsd at bbqsrc.net
+MAINTAINER= feld at FreeBSD.org
COMMENT= Matrix protocol reference homeserver
LICENSE= APACHE20
LICENSE_FILE= ${WRKSRC}/LICENSE
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}frozendict>=0.5:devel/py-frozendict \
- ${PYTHON_PKGNAMEPREFIX}unpaddedbase64>=1.0.1:devel/py-unpaddedbase64 \
+ ${PYTHON_PKGNAMEPREFIX}unpaddedbase64>=1.1.0:devel/py-unpaddedbase64 \
${PYTHON_PKGNAMEPREFIX}canonicaljson>=1.0.0:devel/py-canonicaljson \
${PYTHON_PKGNAMEPREFIX}signedjson>=1.0.0:security/py-signedjson \
${PYTHON_PKGNAMEPREFIX}pynacl>=1.0.1:security/py-pynacl \
@@ -33,7 +34,9 @@ RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}froz
${PYTHON_PKGNAMEPREFIX}pymacaroons-pynacl>=0.9.3:security/py-pymacaroons-pynacl \
${PYTHON_PKGNAMEPREFIX}simplejson>=3.10.0:devel/py-simplejson \
${PYTHON_PKGNAMEPREFIX}sqlite3>0:databases/py-sqlite3 \
- ${PYTHON_PKGNAMEPREFIX}matrix-angular-sdk>=0.6.6:devel/py-matrix-angular-sdk
+ ${PYTHON_PKGNAMEPREFIX}matrix-angular-sdk>=0.6.6:devel/py-matrix-angular-sdk \
+ ${PYTHON_PKGNAMEPREFIX}msgpack-python>=0.3.0:devel/py-msgpack-python \
+ ${LOCALBASE}/share/certs/ca-root-nss.crt:security/ca_root_nss
TEST_DEPENDS= ${PYTHON_PKGNAMEPREFIX}virtualenv>=15.0:devel/py-virtualenv \
${PYTHON_PKGNAMEPREFIX}tox>=2.3.1:devel/py-tox
@@ -44,6 +47,20 @@ USE_PYTHON= autoplist distutils
GH_ACCOUNT= matrix-org
GH_PROJECT= synapse
+USE_RC_SUBR= synapse
+
+USERS= synapse
+
+DBDIR?= /var/db/${PORTNAME}
+LOGDIR?= /var/log/${PORTNAME}
+PIDDIR?= /var/run/${PORTNAME}
+
+SUB_FILES= pkg-message homeserver.yaml log.config
+SUB_LIST+= PYTHON_CMD=${PYTHON_CMD} DBDIR=${DBDIR} LOGDIR=${LOGDIR} PIDDIR=${PIDDIR} USERS=${USERS}
+
+PLIST_FILES+= "@sample %%ETCDIR%%/homeserver.yaml.sample"
+PLIST_FILES+= "@sample %%ETCDIR%%/log.config.sample"
+
NO_ARCH= yes
do-test:
@@ -51,4 +68,9 @@ do-test:
@(cd ${WRKSRC} && ${PYTHON_CMD} ${PYDISTUTILS_SETUP} ${TEST_TARGET} \
-a "-epy27")
+post-install:
+ ${MKDIR} ${STAGEDIR}${ETCDIR}
+ ${INSTALL_DATA} ${WRKDIR}/homeserver.yaml ${STAGEDIR}${ETCDIR}/homeserver.yaml.sample
+ ${INSTALL_DATA} ${WRKDIR}/log.config ${STAGEDIR}${ETCDIR}/log.config.sample
+
.include <bsd.port.mk>
Modified: head/net/py-matrix-synapse/distinfo
==============================================================================
--- head/net/py-matrix-synapse/distinfo Wed Jan 18 02:16:54 2017 (r431779)
+++ head/net/py-matrix-synapse/distinfo Wed Jan 18 02:20:59 2017 (r431780)
@@ -1,3 +1,3 @@
-TIMESTAMP = 1480037052
-SHA256 (matrix-org-synapse-v0.18.4_GH0.tar.gz) = e0dc5517227e9591fa22f1723371f790999927131df3f5c7a7883578fefddff1
-SIZE (matrix-org-synapse-v0.18.4_GH0.tar.gz) = 731642
+TIMESTAMP = 1484684523
+SHA256 (matrix-org-synapse-v0.18.7_GH0.tar.gz) = 87bba87b0b70955387e5c621603ade7a2f2b1fec2788edbabd754fd10cf1078f
+SIZE (matrix-org-synapse-v0.18.7_GH0.tar.gz) = 748100
Added: head/net/py-matrix-synapse/files/homeserver.yaml.in
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/net/py-matrix-synapse/files/homeserver.yaml.in Wed Jan 18 02:20:59 2017 (r431780)
@@ -0,0 +1,471 @@
+# vim:ft=yaml
+# PEM encoded X509 certificate for TLS.
+# You can replace the self-signed certificate that synapse
+# 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: "%%ETCDIR%%/example.com.tls.crt"
+
+# PEM encoded private key for TLS
+tls_private_key_path: "%%ETCDIR%%/example.com.tls.key"
+
+# PEM dh parameters for ephemeral keys
+tls_dh_params_path: "%%ETCDIR%%/example.com.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 its the fingerprint of its own certificate
+# to the list. So if federation traffic is handle 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.
+tls_fingerprints: []
+# tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
+
+
+## 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: "example.com"
+
+# When running as a daemon, the file to store the pid in
+pid_file: %%PIDDIR%%/homeserver.pid
+
+# Whether to serve a web client from the HTTP/HTTPS root resource.
+web_client: True
+
+# The public-facing base URL for the client API (not including _matrix/...)
+# public_baseurl: https://example.com:8448/
+
+# Set the soft limit on the number of file descriptors synapse can use
+# Zero is used to indicate synapse should set the soft limit to the
+# hard limit.
+soft_file_limit: 0
+
+# The GC threshold parameters to pass to `gc.set_threshold`, if defined
+# gc_thresholds: [700, 10, 10]
+
+# List of ports that Synapse should listen on, their purpose and their
+# configuration.
+listeners:
+ # Main HTTPS listener
+ # For when matrix traffic is sent directly to synapse.
+ -
+ # The port to listen for HTTPS requests on.
+ port: 8448
+
+ # Local interface to listen on.
+ # The empty string will cause synapse to listen on all interfaces.
+ bind_address: ''
+
+ # This is a 'http' listener, allows us to specify 'resources'.
+ type: http
+
+ tls: true
+
+ # Use the X-Forwarded-For (XFF) header as the client IP and not the
+ # actual client IP.
+ x_forwarded: false
+
+ # List of HTTP resources to serve on this listener.
+ resources:
+ -
+ # List of resources to host on this listener.
+ names:
+ - client # The client-server APIs, both v1 and v2
+ - webclient # The bundled webclient.
+
+ # Should synapse compress HTTP responses to clients that support it?
+ # This should be disabled if running synapse behind a load balancer
+ # that can do automatic compression.
+ compress: true
+
+ - names: [federation] # Federation APIs
+ compress: false
+
+ # Unsecure HTTP listener,
+ # For when matrix traffic passes through loadbalancer that unwraps TLS.
+ - port: 8008
+ tls: false
+ bind_address: ''
+ type: http
+
+ x_forwarded: false
+
+ resources:
+ - names: [client, webclient]
+ compress: true
+ - names: [federation]
+ compress: false
+
+ # Turn on the twisted ssh manhole service on localhost on the given
+ # port.
+ # - port: 9000
+ # bind_address: 127.0.0.1
+ # type: manhole
+
+
+# Database configuration
+database:
+ # The database engine name
+ name: "sqlite3"
+ # Arguments to pass to the engine
+ args:
+ # Path to the database
+ database: "%%DBDIR%%/homeserver.db"
+
+# Number of events to cache in memory.
+event_cache_size: "10K"
+
+
+
+# Logging verbosity level.
+verbose: 0
+
+# File to write logging to
+log_file: "%%LOGDIR%%/homeserver.log"
+
+# A yaml python logging config file
+log_config: "%%ETCDIR%%/log.config"
+
+# 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 ##
+
+# Number of messages a client can send per second
+rc_messages_per_second: 0.2
+
+# Number of message a client can send before being throttled
+rc_message_burst_count: 10.0
+
+# The federation window size in milliseconds
+federation_rc_window_size: 1000
+
+# The number of federation requests from a single server in a window
+# before the server will delay processing the request.
+federation_rc_sleep_limit: 10
+
+# The duration in milliseconds to delay processing events from
+# remote servers by if they go over the sleep limit.
+federation_rc_sleep_delay: 500
+
+# The maximum number of concurrent federation requests allowed
+# from a single server
+federation_rc_reject_limit: 50
+
+# The number of federation requests to concurrently process from a
+# single server
+federation_rc_concurrent: 3
+
+
+
+# Directory where uploaded images and attachments are stored.
+media_store_path: "%%DBDIR%%/media_store"
+
+# Directory where in-progress uploads are stored.
+uploads_path: "%%DBDIR%%/uploads"
+
+# The largest allowed upload size in bytes
+max_upload_size: "10M"
+
+# Maximum number of pixels that will be thumbnailed
+max_image_pixels: "32M"
+
+# Whether to generate new thumbnails on the fly to precisely match
+# the resolution requested by the client. If true then whenever
+# a new resolution is requested by the client the server will
+# generate a new thumbnail. If false the server will pick a thumbnail
+# from a precalculated list.
+dynamic_thumbnails: false
+
+# List of thumbnail to precalculate when an image is uploaded.
+thumbnail_sizes:
+- width: 32
+ height: 32
+ method: crop
+- width: 96
+ height: 96
+ method: crop
+- width: 320
+ height: 240
+ method: scale
+- width: 640
+ height: 480
+ method: scale
+- width: 800
+ height: 600
+ method: scale
+
+# Is the preview URL API enabled? If enabled, you *must* specify
+# an explicit url_preview_ip_range_blacklist of IPs that the spider is
+# denied from accessing.
+url_preview_enabled: False
+
+# List of IP address CIDR ranges that the URL preview spider is denied
+# from accessing. There are no defaults: you must explicitly
+# specify a list for URL previewing to work. You should specify any
+# internal services in your network that you do not want synapse to try
+# to connect to, otherwise anyone in any Matrix room could cause your
+# synapse to issue arbitrary GET requests to your internal services,
+# causing serious security issues.
+#
+# url_preview_ip_range_blacklist:
+# - '127.0.0.0/8'
+# - '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'
+#
+# 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.
+# This is useful for specifying exceptions to wide-ranging blacklisted
+# target IP ranges - e.g. for enabling URL previews for a specific private
+# website only visible in your network.
+#
+# url_preview_ip_range_whitelist:
+# - '192.168.1.1'
+
+# Optional list of URL matches that the URL preview spider is
+# denied from accessing. You should use url_preview_ip_range_blacklist
+# in preference to this, otherwise someone could define a public DNS
+# entry that points to a private IP address and circumvent the blacklist.
+# This is more useful if you know there is an entire shape of URL that
+# you know that will never want synapse to try to spider.
+#
+# Each list entry is a dictionary of url component attributes as returned
+# by urlparse.urlsplit as applied to the absolute form of the URL. See
+# https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit
+# The values of the dictionary are treated as an filename match pattern
+# applied to that component of URLs, unless they start with a ^ in which
+# case they are treated as a regular expression match. If all the
+# specified component matches for a given list item succeed, the URL is
+# blacklisted.
+#
+# url_preview_url_blacklist:
+# # blacklist any URL with a username in its URI
+# - username: '*'
+#
+# # blacklist all *.google.com URLs
+# - netloc: 'google.com'
+# - netloc: '*.google.com'
+#
+# # blacklist all plain HTTP URLs
+# - scheme: 'http'
+#
+# # blacklist http(s)://www.acme.com/foo
+# - netloc: 'www.acme.com'
+# path: '/foo'
+#
+# # blacklist any URL with a literal IPv4 address
+# - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
+
+# The largest allowed URL preview spidering size in bytes
+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"
+
+# This Home Server's ReCAPTCHA private key.
+recaptcha_private_key: "YOUR_PRIVATE_KEY"
+
+# Enables ReCaptcha checks when registering, preventing signup
+# unless a captcha is answered. Requires a valid ReCaptcha
+# public/private key.
+enable_registration_captcha: False
+
+# A secret key used to bypass the captcha test entirely.
+#captcha_bypass_secret: "YOUR_SECRET_HERE"
+
+# The API endpoint to use for verifying m.login.recaptcha responses.
+recaptcha_siteverify_api: "https://www.google.com/recaptcha/api/siteverify"
+
+
+## Turn ##
+
+# The public URIs of the TURN server to give to clients
+turn_uris: []
+
+# The shared secret used to compute passwords for the TURN server
+turn_shared_secret: "YOUR_SHARED_SECRET"
+
+# How long generated TURN credentials last
+turn_user_lifetime: "1h"
+
+
+## Registration ##
+
+# Enable registration for new users.
+enable_registration: False
+
+# If set, allows registration by anyone who also has the shared
+# secret, even if registration is otherwise disabled.
+registration_shared_secret: "CHANGEME_50CHAR_RANDOM"
+
+# 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.
+bcrypt_rounds: 12
+
+# Allows users to register as guests without a password/email/etc, and
+# participate in rooms hosted on this server which have been made
+# accessible to anonymous users.
+allow_guest_access: False
+
+# The list of identity servers trusted to verify third party
+# identifiers by this server.
+trusted_third_party_id_servers:
+ - matrix.org
+ - vector.im
+
+
+## Metrics ###
+
+# Enable collection and rendering of performance metrics
+enable_metrics: False
+report_stats: False
+
+
+## API Configuration ##
+
+# A list of event types that will be included in the room_invite_state
+room_invite_state_types:
+ - "m.room.join_rules"
+ - "m.room.canonical_alias"
+ - "m.room.avatar"
+ - "m.room.name"
+
+
+# A list of application service config file to use
+app_service_config_files: []
+
+
+macaroon_secret_key: "CHANGEME_50CHAR_RANDOM"
+
+# Used to enable access token expiration.
+expire_access_token: False
+
+## Signing Keys ##
+
+# Path to the signing key to sign messages with
+signing_key_path: "%%ETCDIR%%/example.com.signing.key"
+
+# The keys that the server used to sign messages with but won't use
+# to sign new messages. E.g. it has lost its private key
+old_signing_keys: {}
+# "ed25519:auto":
+# # Base64 encoded public key
+# key: "The public part of your old signing key."
+# # Millisecond POSIX timestamp when the key expired.
+# expired_ts: 123456789123
+
+# How long key response published by this server is valid for.
+# Used to set the valid_until_ts in /key/v2 APIs.
+# Determines how quickly servers will query to check which keys
+# are still valid.
+key_refresh_interval: "1d" # 1 Day.
+
+# The trusted servers to download signing keys from.
+perspectives:
+ servers:
+ "matrix.org":
+ verify_keys:
+ "ed25519:auto":
+ key: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
+
+
+
+# Enable SAML2 for registration and login. Uses pysaml2
+# config_path: Path to the sp_conf.py configuration file
+# idp_redirect_url: Identity provider URL which will redirect
+# the user back to /login/saml2 with proper info.
+# See pysaml2 docs for format of config.
+#saml2_config:
+# enabled: true
+# config_path: "%%ETCDIR%%/sp_conf.py"
+# idp_redirect_url: "http://example.com/idp"
+
+
+
+# Enable CAS for registration and login.
+#cas_config:
+# enabled: true
+# server_url: "https://cas-server.com"
+# service_url: "https://homesever.domain.com:8448"
+# #required_attributes:
+# # name: value
+
+
+# The JWT needs to contain a globally unique "sub" (subject) claim.
+#
+# jwt_config:
+# enabled: true
+# secret: "a secret"
+# algorithm: "HS256"
+
+
+
+# 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 <noreply at example.com>"
+# app_name: Matrix
+# template_dir: res/templates
+# notif_template_html: notif_mail.html
+# notif_template_text: notif_mail.txt
+# notif_for_new_users: True
+
+
+# password_providers:
+# - module: "ldap_auth_provider.LdapAuthProvider"
+# config:
+# enabled: true
+# uri: "ldap://ldap.example.com:389"
+# start_tls: true
+# base: "ou=users,dc=example,dc=com"
+# attributes:
+# uid: "cn"
+# mail: "email"
+# name: "givenName"
+# #bind_dn:
+# #bind_password:
+# #filter: "(objectClass=posixAccount)"
Added: head/net/py-matrix-synapse/files/log.config.in
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/net/py-matrix-synapse/files/log.config.in Wed Jan 18 02:20:59 2017 (r431780)
@@ -0,0 +1,35 @@
+
+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: %%LOGDIR%%/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]
Added: head/net/py-matrix-synapse/files/patch-synapse_python__dependencies.py
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/net/py-matrix-synapse/files/patch-synapse_python__dependencies.py Wed Jan 18 02:20:59 2017 (r431780)
@@ -0,0 +1,11 @@
+--- synapse/python_dependencies.py.orig 2017-01-17 17:50:56 UTC
++++ synapse/python_dependencies.py
+@@ -22,7 +22,7 @@ REQUIREMENTS = {
+ "unpaddedbase64>=1.1.0": ["unpaddedbase64>=1.1.0"],
+ "canonicaljson>=1.0.0": ["canonicaljson>=1.0.0"],
+ "signedjson>=1.0.0": ["signedjson>=1.0.0"],
+- "pynacl==0.3.0": ["nacl==0.3.0", "nacl.bindings"],
++ "pynacl>=0.3.0": ["nacl>=0.3.0", "nacl.bindings"],
+ "service_identity>=1.0.0": ["service_identity>=1.0.0"],
+ "Twisted>=15.1.0": ["twisted>=15.1.0"],
+ "pyopenssl>=0.14": ["OpenSSL>=0.14"],
Added: head/net/py-matrix-synapse/files/pkg-message.in
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/net/py-matrix-synapse/files/pkg-message.in Wed Jan 18 02:20:59 2017 (r431780)
@@ -0,0 +1,22 @@
+Configuring Synapse:
+
+You may use the sample config located at %%ETCDIR%% to get started. It
+already is configured to find the configuration in that location and
+places the database in %%DBDIR%% and the logs in %%LOGDIR%%, but there
+are some crucial values you will need to populate with unique data:
+registration_shared_secret and macaroon_secret_key. Both of these
+by default are 50 character random strings. These are by default set to
+CHANGEME_50CHAR_RANDOM in the sample homeserver.yaml.
+
+If you wish to have Synapse handle this for you including generation of
+self-signed TLS certificates and dhparams you can use the following
+command:
+
+%%PYTHON_CMD%% -B -m synapse.app.homeserver -c %%ETCDIR%%/homeserver.yaml --generate-config --server-name=example.com
+
+Please note that you will still need to manually configure paths to log
+directory, database, and media storage with this method.
+
+It is also important that you deploy a TLS certificate that your
+clients accept as valid or some functionality will fail to work
+correctly (eg, media file retrieval).
Added: head/net/py-matrix-synapse/files/synapse.in
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/net/py-matrix-synapse/files/synapse.in Wed Jan 18 02:20:59 2017 (r431780)
@@ -0,0 +1,56 @@
+#!/bin/sh
+#
+# Created by: Mark Felder <feld at FreeBSD.org>
+# $FreeBSD$
+#
+
+# PROVIDE: synapse
+# REQUIRE: LOGIN postgresql
+# KEYWORD: shutdown
+
+#
+# Add the following line to /etc/rc.conf to enable `synapse':
+#
+# synapse_enable="YES"
+
+. /etc/rc.subr
+name=synapse
+
+rcvar=synapse_enable
+load_rc_config ${name}
+
+: ${synapse_enable:=NO}
+: ${synapse_user:=%%USERS%%}
+: ${synapse_conf:=%%ETCDIR%%/homeserver.yaml}
+: ${synapse_dbdir:=%%DBDIR%%}
+: ${synapse_logdir:=%%LOGDIR%%}
+: ${synapse_pidfile:=%%PIDDIR%%/homeserver.pid}
+
+pidfile="${synapse_pidfile}"
+procname=%%PYTHON_CMD%%
+command=%%PYTHON_CMD%%
+command_args="-m synapse.app.homeserver --daemonize -c ${synapse_conf}"
+start_precmd=start_precmd
+
+start_precmd()
+{
+ if [ ! -d ${synapse_pidfile%/*} ] ; then
+ install -d -o %%USERS%% -g wheel ${synapse_pidfile%/*};
+ fi
+
+ if [ ! -d ${synapse_dbdir} ] ; then
+ install -d -o %%USERS%% -g wheel ${synapse_dbdir};
+ fi
+
+ if [ ! -d ${synapse_logdir} ] ; then
+ install -d -o %%USERS%% -g wheel ${synapse_logdir};
+ fi
+
+ if $(grep -q CHANGEME ${synapse_conf}) ; then
+ echo "Error: Default secret values in config."
+ echo "Please replace the CHANGEME values in ${synapse_conf}"
+ exit 1
+ fi
+}
+
+run_rc_command "$1"
More information about the svn-ports-head
mailing list