Port details on branch 2023Q1 |
- py-matrix-synapse Matrix protocol reference homeserver
- 1.74.0 net-im
=0 1.127.1Version of this port present on the latest quarterly branch. - Maintainer: ports@skyforge.at
 - Port Added: 2023-01-03 11:58:32
- Last Update: 2023-01-03 11:55:13
- Commit Hash: 8a0eb12
- Also Listed In: python
- License: APACHE20
- WWW:
- https://www.matrix.org
- Description:
- Matrix is an ambitious new ecosystem for open federated Instant Messaging and
VoIP. The basics you need to know to get up and running are:
* Everything in Matrix happens in a room. Rooms are distributed and do not
exist on any single server. Rooms can be located using convenience
aliases like #matrix:matrix.org or #test:localhost:8448.
* Matrix user IDs look like @matthew:matrix.org (although in the future you
will normally refer to yourself and others using a 3PID: email address,
phone number, etc rather than manipulating Matrix user IDs)
Synapse is currently in rapid development, but as of version 0.5 we believe it
is sufficiently stable to be run as an internet-facing service for real usage!
¦ ¦ ¦ ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}matrix-synapse>0:net-im/py-matrix-synapse@${PY_FLAVOR}
- To install the port:
- cd /usr/ports/net-im/py-matrix-synapse/ && make install clean
- To add the package, run one of these commands:
- pkg install net-im/py-matrix-synapse
- pkg install py39-matrix-synapse
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py39-matrix-synapse listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py39-matrix-synapse
- Package flavors (<flavor>: <package>)
- py39: py39-matrix-synapse
- distinfo:
- TIMESTAMP = 1671985196
SHA256 (matrix_synapse-1.74.0.tar.gz) = 4df0442a7b638679bcc4caf7629b76a092b6375b661b21b1c259a7229c57a1d6
SIZE (matrix_synapse-1.74.0.tar.gz) = 3075807
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py39-poetry-core>=1.0.0 : devel/py-poetry-core@py39
- py39-setuptools-rust>=1.3 : devel/py-setuptools-rust@py39
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- rust>=1.66.0 : lang/rust
- Test dependencies:
-
- py39-virtualenv>=15.0 : devel/py-virtualenv@py39
- py39-tox>=2.3.1 : devel/py-tox@py39
- py39-lxml>0 : devel/py-lxml@py39
- py39-parameterized>=0.7.4 : devel/py-parameterized@py39
- py39-authlib>=0.15.1 : security/py-authlib@py39
- py39-idna>=2.5 : dns/py-idna@py39
- python3.9 : lang/python39
- Runtime dependencies:
-
- py39-jsonschema>=3.0.0 : devel/py-jsonschema@py39
- py39-frozendict>=1 : devel/py-frozendict@py39
- py39-unpaddedbase64>=2.1.0 : devel/py-unpaddedbase64@py39
- py39-canonicaljson>=1.5.0 : devel/py-canonicaljson@py39
- py39-signedjson>=1.1.0 : security/py-signedjson@py39
- py39-service_identity>=18.1.0 : security/py-service_identity@py39
- py39-twisted>=18.9.0 : devel/py-twisted@py39
- py39-treq>=15.1 : www/py-treq@py39
- py39-openssl>=16.0.0 : security/py-openssl@py39
- py39-yaml>=3.11 : devel/py-yaml@py39
- py39-pyasn1>=0.1.9 : devel/py-pyasn1@py39
- py39-pyasn1-modules>=0.0.7 : devel/py-pyasn1-modules@py39
- py39-bcrypt>=3.1.7 : security/py-bcrypt@py39
- py39-pillow>=7.0.0 : graphics/py-pillow@py39
- py39-sortedcontainers>=1.5.2 : devel/py-sortedcontainers@py39
- py39-pysaml2>=4.5.0 : security/py-pysaml2@py39
- py39-pymacaroons>=0.13.0 : security/py-pymacaroons@py39
- py39-msgpack>=0.5.2 : devel/py-msgpack@py39
- py39-phonenumbers>=8.2.0 : devel/py-phonenumbers@py39
- py39-prometheus-client>=0.4.0 : net-mgmt/py-prometheus-client@py39
- py39-attrs>=19.2.0 : devel/py-attrs@py39
- py39-netaddr>=0.7.18 : net/py-netaddr@py39
- py39-Jinja2>=3.0.0 : devel/py-Jinja2@py39
- py39-bleach>=1.4.3 : www/py-bleach@py39
- py39-typing-extensions>=3.10.0.1 : devel/py-typing-extensions@py39
- py39-cryptography>=0 : security/py-cryptography@py39
- py39-ijson>=3.1.4 : devel/py-ijson@py39
- py39-packaging>=16.1 : devel/py-packaging@py39
- py39-matrix-common>=1.3.0 : devel/py-matrix-common@py39
- py39-pydantic>=1.7.4 : devel/py-pydantic@py39
- ca-root-nss.crt : security/ca_root_nss
- py39-psycopg2>2.8 : databases/py-psycopg2@py39
- py39-sqlite3>0 : databases/py-sqlite3@py39
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- There are no ports dependent upon this port
Configuration Options:
- ===> The following configuration options are available for py39-matrix-synapse-1.74.0:
DOCS=on: Build and/or install documentation
JWT=off: Add dependencies for JSON web tokens
LDAP=off: LDAP protocol support
OIDC=off: Add dependencies for OpenID Connect based logins
PGSQL=on: PostgreSQL database support
REDIS=off: Add support replication over Redis for synapse workers
SQLITE=on: SQLite database support
URLPREVIEW=off: Add dependencies necessary for URL previews
===> Use 'make config' to modify these settings
- Options name:
- net-im_py-matrix-synapse
- USES:
- python:3.7+ cargo
- pkg-message:
- For install:
- Configuring Synapse:
The following command can be used to generate a sample configuration of synapse:
/usr/local/bin/python3.9 -B -m synapse.app.homeserver -c /usr/local/etc/matrix-synapse/homeserver.yaml --generate-config -H <SERVER_NAME> --report-stats no
Please note that you will still need to manually configure paths to log
directory, database, and media storage with this method.
- If upgrading
- If you're upgrading from a previous release of synapse, please read the upgrade
instructions at /usr/local/share/doc/matrix-synapse/UPGRADE.rst
- If upgrading from < 1.51.0:
- Synapse 1.51.0 deprecates webclient listeners and non-HTTP(S)
web_client_location settings. Please update your homeserver configurations
accordingly.
Additionally, if you run your own turn server for WebRTC and
use Let's Encrypt certificates, be advised that some Android and iOS clients
may be unable to connect. Please see upstream's turn-howto[0] for additional
details on this issue.
[0] https://matrix-org.github.io/synapse/latest/turn-howto.html
- If upgrading from < 1.55.0:
- The default room version of synapse has been increased to version 9. Consider
changing this if interoperability with other matrix servers is an issue.
If you're using Mjolnir, be advised that this version of synapse is
incompatible with Mjolnir 1.3.1 and earlier.
- Running synapse with the sqlite backend is only recommended for testing purposes.
Future versions of synapse will disable federation by default if sqlite is used.
- If upgrading
- If you're currently using synapse with sqlite and would like to switch to postgres,
please read the instructions at /usr/local/share/doc/matrix-synapse/postgres.md
- If upgrading from < 1.55.2:
- Synapse will now refuse to start up if open registration is enabled, in order to help
mitigate abuse across the federation. If you would like to provide registration to
anyone, consider adding email, recaptcha or token-based verification in order to
prevent automated registration from bad actors. This check can be disabled by setting
the enable_registration_without_verification option in your homeserver configuration
file to true. More details are available in the upgrade notes[0].
Synapse will additionally now refuse to start when using PostgreSQL with a non-C values
for COLLATE and CTYPE, unless the config flag allow_unsafe_locale, found in the database
section of the configuration file, is set to true. See the upgrade notes[1] for details.
[0] https://matrix-org.github.io/synapse/v1.56/upgrade.html#open-registration-without-verification-is-now-disabled-by-default
[1] https://matrix-org.github.io/synapse/v1.56/upgrade#change-in-behaviour-for-postgresql-databases-with-unsafe-locale
- If upgrading from < 1.62.0:
- Starting with synapse 1.62.0, this port will no longer ship with sqlite support
by default. If you rely on sqlite for your setup, please either migrate to
postgresql, install the sqlite dependency manually or build a custom flavor of the
port.
- Master Sites:
|