Commit f381c8ebfced181367d2808dab3a0f3153ecb987 - matrix-synapse

+2

-0

debian/config less more

0	0	#!/bin/sh
	1
	2	set -e
1	3
2	4	. /usr/share/debconf/confmodule
3	5

+52

-31

debian/control less more

1	1	Maintainer: Erik Johnston <erikj@matrix.org>
2	2	Section: python
3	3	Priority: optional
4		Build-Depends: python-setuptools (>= 0.6b3), python (>= 2.6.6-3),
5		debhelper (>= 9), dh-python, dh-systemd (>= 1.5), python-mock, python-twisted (>= 16.0.0),
6		python-syutil (>= 0.0.7), python-yaml, python-frozendict (>= 0.4),
7		python-bcrypt, python-daemonize, python-openssl (>= 0.14),
8		python-service-identity (>= 1.0.0), python-blist, python-pyasn1, python-pysaml2,
9		python-ujson, python-pil, python-pydenticon, python-signedjson (>= 1.0.0),
10		python-unpaddedbase64 (>= 1.0.1), python-canonicaljson (>=1.0.0),
11		python-nacl (>= 0.3.0), python-pymacaroons-pynacl, python-msgpack (>=0.3.0)
12		Standards-Version: 3.9.1
	4	Build-Depends:
	5	debhelper (>= 9),
	6	dh-python,
	7	dh-systemd (>= 1.5),
	8	po-debconf,
	9	python (>= 2.6.6-3),
	10	python-bcrypt,
	11	python-blist,
	12	python-canonicaljson (>=1.0.0),
	13	python-daemonize,
	14	python-frozendict (>= 0.4),
	15	python-mock,
	16	python-msgpack (>=0.3.0),
	17	python-nacl (>= 0.3.0),
	18	python-openssl (>= 0.14),
	19	python-pil,
	20	python-pyasn1,
	21	python-pydenticon,
	22	python-pymacaroons-pynacl,
	23	python-pysaml2,
	24	python-service-identity (>= 1.0.0),
	25	python-setuptools (>= 0.6b3),
	26	python-signedjson (>= 1.0.0),
	27	python-syutil (>= 0.0.7),
	28	python-twisted (>= 16.0.0),
	29	python-unpaddedbase64 (>= 1.0.1),
	30	python-ujson,
	31	python-yaml,
	32	Standards-Version: 3.9.8
13	33	X-Python-Version: >= 2.7
14	34
15	35	Package: matrix-synapse
16	36	Architecture: all
17		Depends: ${misc:Depends}, ${python:Depends},
18		debconf, adduser, python-twisted (>= 16.0.0)
19		Suggests: python-bleach (>= 1.4.2), python-jinja2 (>= 2.8)
20		Description: Reference Synapse Home Server
21		.. contents::
	37	Depends:
	38	${misc:Depends},
	39	${python:Depends},
	40	adduser,
	41	debconf,
	42	lsb-base (>= 3.0-6),
	43	python-twisted (>= 16.0.0),
	44	Suggests:
	45	python-bleach (>= 1.4.2),
	46	python-jinja2 (>= 2.8),
	47	Description: Open federated Instant Messaging and VoIP server
	48	Matrix is an ambitious new ecosystem for open federated Instant
	49	Messaging and VoIP. Synapse is a reference Matrix server
	50	implementation.
22	51	.
23		Introduction
24		============
	52	Everything in Matrix happens in a room. Rooms are distributed and do
	53	not exist on any single server. Rooms can be located using
	54	convenience aliases like #matrix:matrix.org or #test:localhost:8448.
25	55	.
26		Matrix is an ambitious new ecosystem for open federated Instant Messaging and
27		VoIP. The basics you need to know to get up and running are:
	56	Matrix user IDs look like @matthew:matrix.org (although in the future
	57	you will normally refer to yourself and others using a 3PID: email
	58	address, phone number, etc rather than manipulating Matrix user IDs)
28	59	.
29		- Everything in Matrix happens in a room. Rooms are distributed and do not
30		exist on any single server. Rooms can be located using convenience aliases
31		like ``#matrix:matrix.org`` or ``#test:localhost:8448``.
32		.
33		- Matrix user IDs look like ``@matthew:matrix.org`` (although in the future
34		you will normally refer to yourself and others using a 3PID: email
35		address, phone number, etc rather than manipulating Matrix user IDs)
36		.
37		The overall architecture is::
38		.
39		client <----> homeserver <=====================> homeserver <----> client
40		https://somewhere.org/_matrix https://elsewhere.net/_matrix
41
	60	The overall architecture is:
	61	client <------> homeserver <=============> homeserver <------> client
	62	https://a.org/_matrix https://b.net/_matrix

+118

-0

debian/copyright less more

	0	Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
	1	Upstream-Name: synapse
	2	Source: https://github.com/matrix-org/synapse
	3
	4	Files: *
	5	Copyright: 2014-2017, OpenMarket Ltd
	6	License: Apache-2.0
	7
	8	Files: synapse/config/saml2.py
	9	Copyright: 2015, Ericsson
	10	License: Apache-2.0
	11
	12	Files: synapse/config/jwt.py
	13	Copyright: 2015, Niklas Riekenbrauck
	14	License: Apache-2.0
	15
	16	Files: synapse/config/workers.py
	17	Copyright: 2016, matrix.org
	18	License: Apache-2.0
	19
	20	Files: synapse/config/repository.py
	21	Copyright: 2014-2015, matrix.org
	22	License: Apache-2.0
	23
	24	Files: contrib/jitsimeetbridge/unjingle/strophe/base64.js
	25	Copyright: Public Domain (Tyler Akins http://rumkin.com)
	26	License: public-domain
	27	This code was written by Tyler Akins and has been placed in the
	28	public domain. It would be nice if you left this header intact.
	29	Base64 code from Tyler Akins -- http://rumkin.com
	30
	31	Files: contrib/jitsimeetbridge/unjingle/strophe/md5.js
	32	Copyright: 1999-2002, Paul Johnston & Contributors
	33	License: BSD-3-clause
	34
	35	Files: contrib/jitsimeetbridge/unjingle/strophe/strophe.js
	36	Copyright: 2006-2008, OGG, LLC
	37	License: Expat
	38
	39	Files: contrib/jitsimeetbridge/unjingle/strophe/XMLHttpRequest.js
	40	Copyright: 2010 passive.ly LLC
	41	License: Expat
	42
	43	Files: contrib/jitsimeetbridge/unjingle/*.js
	44	Copyright: 2014 Jitsi
	45	License: Apache-2.0
	46
	47	Files: debian/*
	48	Copyright: 2016-2017, Erik Johnston <erik@matrix.org>
	49	2017, Rahul De <rahulde@swecha.net>
	50	2017, Sunil Mohan Adapa <sunil@medhas.org>
	51	License: Apache-2.0
	52
	53	License: Apache-2.0
	54	Licensed under the Apache License, Version 2.0 (the "License");
	55	you may not use this file except in compliance with the License.
	56	You may obtain a copy of the License at
	57	.
	58	http://www.apache.org/licenses/LICENSE-2.0
	59	.
	60	Unless required by applicable law or agreed to in writing, software
	61	distributed under the License is distributed on an "AS IS" BASIS,
	62	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	63	See the License for the specific language governing permissions and
	64	limitations under the License.
	65	.
	66	On Debian systems, the full text of the Apache License version
	67	2.0 can be found in the file
	68	`/usr/share/common-licenses/Apache-2.0'.
	69
	70	License: BSD-3-clause
	71	Redistribution and use in source and binary forms, with or without
	72	modification, are permitted provided that the following conditions
	73	are met:
	74	.
	75	Redistributions of source code must retain the above copyright
	76	notice, this list of conditions and the following
	77	disclaimer. Redistributions in binary form must reproduce the above
	78	copyright notice, this list of conditions and the following
	79	disclaimer in the documentation and/or other materials provided with
	80	the distribution.
	81	.
	82	Neither the name of the author nor the names of its contributors may
	83	be used to endorse or promote products derived from this software
	84	without specific prior written permission.
	85	.
	86	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	87	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	88	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	89	A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	90	OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	91	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	92	LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	93	DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	94	THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	95	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	96	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	97
	98	License: Expat
	99	Permission is hereby granted, free of charge, to any person obtaining
	100	a copy of this software and associated documentation files (the
	101	"Software"), to deal in the Software without restriction, including
	102	without limitation the rights to use, copy, modify, merge, publish,
	103	distribute, sublicense, and/or sell copies of the Software, and to
	104	permit persons to whom the Software is furnished to do so, subject to
	105	the following conditions:
	106	.
	107	The above copyright notice and this permission notice shall be
	108	included in all copies or substantial portions of the Software.
	109	.
	110	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	111	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	112	MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	113	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	114	BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	115	ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	116	CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	117	SOFTWARE.

+90

-0

debian/hash_password.1 less more

	0	.\" generated with Ronn/v0.7.3
	1	.\" http://github.com/rtomayko/ronn/tree/0.7.3
	2	.
	3	.TH "HASH_PASSWORD" "1" "February 2017" "" ""
	4	.
	5	.SH "NAME"
	6	\fBhash_password\fR \- Calculate the hash of a new password, so that passwords can be reset
	7	.
	8	.SH "SYNOPSIS"
	9	\fBhash_password\fR [\fB\-p\fR\|\fB\-\-password\fR [password]] [\fB\-c\fR\|\fB\-\-config\fR \fIfile\fR]
	10	.
	11	.SH "DESCRIPTION"
	12	\fBhash_password\fR calculates the hash of a supplied password using bcrypt\.
	13	.
	14	.P
	15	\fBhash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.
	16	.
	17	.P
	18	It accepts an YAML file which can be used to specify parameters like the number of rounds for bcrypt and password_config section having the pepper value used for the hashing\. By default \fBbcrypt_rounds\fR is set to \fB10\fR\.
	19	.
	20	.P
	21	The hashed password is written on the \fBSTDOUT\fR\.
	22	.
	23	.SH "FILES"
	24	A sample YAML file accepted by \fBhash_password\fR is described below:
	25	.
	26	.P
	27	bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"
	28	.
	29	.SH "OPTIONS"
	30	.
	31	.TP
	32	\fB\-p\fR, \fB\-\-password\fR
	33	Read the password form the command line if [password] is supplied\. If not, prompt the user and read the password form the \fBSTDIN\fR\. It is not recommended to type the password on the command line directly\. Use the STDIN instead\.
	34	.
	35	.TP
	36	\fB\-c\fR, \fB\-\-config\fR
	37	Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.
	38	.
	39	.SH "EXAMPLES"
	40	Hash from the command line:
	41	.
	42	.IP "" 4
	43	.
	44	.nf
	45
	46	$ hash_password \-p "p@ssw0rd"
	47	$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8\.X8fWFpum7SxZ9MFe
	48	.
	49	.fi
	50	.
	51	.IP "" 0
	52	.
	53	.P
	54	Hash from the STDIN:
	55	.
	56	.IP "" 4
	57	.
	58	.nf
	59
	60	$ hash_password
	61	Password:
	62	Confirm password:
	63	$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG
	64	.
	65	.fi
	66	.
	67	.IP "" 0
	68	.
	69	.P
	70	Using a config file:
	71	.
	72	.IP "" 4
	73	.
	74	.nf
	75
	76	$ hash_password \-c config\.yml
	77	Password:
	78	Confirm password:
	79	$2b$12$CwI\.wBNr\.w3kmiUlV3T5s\.GT2wH7uebDCovDrCOh18dFedlANK99O
	80	.
	81	.fi
	82	.
	83	.IP "" 0
	84	.
	85	.SH "COPYRIGHT"
	86	This man page was written by Rahul De <\fIrahulde@swecha\.net\fR> for Debian GNU/Linux distribution\.
	87	.
	88	.SH "SEE ALSO"
	89	synctl(1), synapse_port_db(1), register_new_matrix_user(1)

+69

-0

debian/hash_password.ronn less more

	0	hash_password(1) -- Calculate the hash of a new password, so that passwords can be reset
	1	========================================================================================
	2
	3	## SYNOPSIS
	4
	5	`hash_password` [`-p`\|`--password` [password]] [`-c`\|`--config` <file>]
	6
	7	## DESCRIPTION
	8
	9	hash_password calculates the hash of a supplied password using bcrypt.
	10
	11	`hash_password` takes a password as an parameter either on the command line
	12	or the `STDIN` if not supplied.
	13
	14	It accepts an YAML file which can be used to specify parameters like the
	15	number of rounds for bcrypt and password_config section having the pepper
	16	value used for the hashing. By default `bcrypt_rounds` is set to 10.
	17
	18	The hashed password is written on the `STDOUT`.
	19
	20	## FILES
	21
	22	A sample YAML file accepted by `hash_password` is described below:
	23
	24	bcrypt_rounds: 17
	25	password_config:
	26	pepper: "random hashing pepper"
	27
	28	## OPTIONS
	29
	30	* `-p`, `--password`:
	31	Read the password form the command line if [password] is supplied.
	32	If not, prompt the user and read the password form the `STDIN`.
	33	It is not recommended to type the password on the command line
	34	directly. Use the STDIN instead.
	35
	36	* `-c`, `--config`:
	37	Read the supplied YAML <file> containing the options `bcrypt_rounds`
	38	and the `password_config` section containing the `pepper` value.
	39
	40	## EXAMPLES
	41
	42	Hash from the command line:
	43
	44	$ hash_password -p "p@ssw0rd"
	45	$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8.X8fWFpum7SxZ9MFe
	46
	47	Hash from the STDIN:
	48
	49	$ hash_password
	50	Password:
	51	Confirm password:
	52	$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX.rcuAbM8ErLoUhybG
	53
	54	Using a config file:
	55
	56	$ hash_password -c config.yml
	57	Password:
	58	Confirm password:
	59	$2b$12$CwI.wBNr.w3kmiUlV3T5s.GT2wH7uebDCovDrCOh18dFedlANK99O
	60
	61	## COPYRIGHT
	62
	63	This man page was written by Rahul De <<rahulde@swecha.net>>
	64	for Debian GNU/Linux distribution.
	65
	66	## SEE ALSO
	67
	68	synctl(1), synapse_port_db(1), register_new_matrix_user(1)

+4

-0

debian/manpages less more

	0	debian/hash_password.1
	1	debian/register_new_matrix_user.1
	2	debian/synapse_port_db.1
	3	debian/synctl.1

+1

-0

debian/po/POTFILES.in less more

0

[type: gettext/rfc822deb] templates

+56

-0

debian/po/templates.pot less more

	0	# SOME DESCRIPTIVE TITLE.
	1	# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
	2	# This file is distributed under the same license as the matrix-synapse package.
	3	# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
	4	#
	5	#, fuzzy
	6	msgid ""
	7	msgstr ""
	8	"Project-Id-Version: matrix-synapse\n"
	9	"Report-Msgid-Bugs-To: matrix-synapse@packages.debian.org\n"
	10	"POT-Creation-Date: 2017-02-21 07:51+0000\n"
	11	"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
	12	"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
	13	"Language-Team: LANGUAGE <LL@li.org>\n"
	14	"Language: \n"
	15	"MIME-Version: 1.0\n"
	16	"Content-Type: text/plain; charset=CHARSET\n"
	17	"Content-Transfer-Encoding: 8bit\n"
	18
	19	#. Type: string
	20	#. Description
	21	#: ../templates:1001
	22	msgid "Name of the server:"
	23	msgstr ""
	24
	25	#. Type: string
	26	#. Description
	27	#: ../templates:1001
	28	msgid ""
	29	"The name that this homeserver will appear as, to clients and other servers "
	30	"via federation. This name should match the SRV record published in DNS."
	31	msgstr ""
	32
	33	#. Type: boolean
	34	#. Description
	35	#: ../templates:2001
	36	msgid "Report anonymous statistics?"
	37	msgstr ""
	38
	39	#. Type: boolean
	40	#. Description
	41	#: ../templates:2001
	42	msgid ""
	43	"Developers of Matrix and Synapse really appreciate helping the project out "
	44	"by reporting anonymized usage statistics from this homeserver. Only very "
	45	"basic aggregate data (e.g. number of users) will be reported, but it helps "
	46	"track the growth of the Matrix community, and helps in making Matrix a "
	47	"success, as well as to convince other networks that they should peer with "
	48	"Matrix."
	49	msgstr ""
	50
	51	#. Type: boolean
	52	#. Description
	53	#: ../templates:2001
	54	msgid "Thank you."
	55	msgstr ""

+72

-0

debian/register_new_matrix_user.1 less more

	0	.\" generated with Ronn/v0.7.3
	1	.\" http://github.com/rtomayko/ronn/tree/0.7.3
	2	.
	3	.TH "REGISTER_NEW_MATRIX_USER" "1" "February 2017" "" ""
	4	.
	5	.SH "NAME"
	6	\fBregister_new_matrix_user\fR \- Used to register new users with a given home server when registration has been disabled
	7	.
	8	.SH "SYNOPSIS"
	9	\fBregister_new_matrix_user\fR options\.\.\.
	10	.
	11	.SH "DESCRIPTION"
	12	\fBregister_new_matrix_user\fR registers new users with a given home server when registration has been disabled\. For this to work, the home server must be configured with the \'registration_shared_secret\' option set\.
	13	.
	14	.P
	15	This accepts the user credentials like the username, password, is user an admin or not and registers the user onto the homeserver database\. Also, a YAML file containing the shared secret can be provided\. If not, the shared secret can be provided via the command line\.
	16	.
	17	.P
	18	By default it assumes the home server URL to be \fBhttps://localhost:8448\fR\. This can be changed via the \fBserver_url\fR command line option\.
	19	.
	20	.SH "FILES"
	21	A sample YAML file accepted by \fBregister_new_matrix_user\fR is described below:
	22	.
	23	.IP "" 4
	24	.
	25	.nf
	26
	27	registration_shared_secret: "s3cr3t"
	28	.
	29	.fi
	30	.
	31	.IP "" 0
	32	.
	33	.SH "OPTIONS"
	34	.
	35	.TP
	36	\fB\-u\fR, \fB\-\-user\fR
	37	Local part of the new user\. Will prompt if omitted\.
	38	.
	39	.TP
	40	\fB\-p\fR, \fB\-\-password\fR
	41	New password for user\. Will prompt if omitted\. Supplying the password on the command line is not recommended\. Use the STDIN instead\.
	42	.
	43	.TP
	44	\fB\-a\fR, \fB\-\-admin\fR
	45	Register new user as an admin\. Will prompt if omitted\.
	46	.
	47	.TP
	48	\fB\-c\fR, \fB\-\-config\fR
	49	Path to server config file containing the shared secret\.
	50	.
	51	.TP
	52	\fB\-k\fR, \fB\-\-shared\-secret\fR
	53	Shared secret as defined in server config file\. This is an optional parameter as it can be also supplied via the YAML file\.
	54	.
	55	.TP
	56	\fBserver_url\fR
	57	URL of the home server\. Defaults to \'https://localhost:8448\'\.
	58	.
	59	.SH "EXAMPLES"
	60	.
	61	.nf
	62
	63	$ register_new_matrix_user \-u user1 \-p p@ssword \-a \-c config\.yaml
	64	.
	65	.fi
	66	.
	67	.SH "COPYRIGHT"
	68	This man page was written by Rahul De <\fIrahulde@swecha\.net\fR> for Debian GNU/Linux distribution\.
	69	.
	70	.SH "SEE ALSO"
	71	synctl(1), synapse_port_db(1), hash_password(1)

+61

-0

debian/register_new_matrix_user.ronn less more

	0	register_new_matrix_user(1) -- Used to register new users with a given home server when registration has been disabled
	1	======================================================================================================================
	2
	3	## SYNOPSIS
	4
	5	`register_new_matrix_user` options...
	6
	7	## DESCRIPTION
	8
	9	register_new_matrix_user registers new users with a given home server when
	10	registration has been disabled. For this to work, the home server must be
	11	configured with the 'registration_shared_secret' option set.
	12
	13	This accepts the user credentials like the username, password, is user an
	14	admin or not and registers the user onto the homeserver database. Also,
	15	a YAML file containing the shared secret can be provided. If not, the
	16	shared secret can be provided via the command line.
	17
	18	By default it assumes the home server URL to be `https://localhost:8448`.
	19	This can be changed via the `server_url` command line option.
	20
	21	## FILES
	22
	23	A sample YAML file accepted by `register_new_matrix_user` is described below:
	24
	25	registration_shared_secret: "s3cr3t"
	26
	27	## OPTIONS
	28
	29	* `-u`, `--user`:
	30	Local part of the new user. Will prompt if omitted.
	31
	32	* `-p`, `--password`:
	33	New password for user. Will prompt if omitted. Supplying the password
	34	on the command line is not recommended. Use the STDIN instead.
	35
	36	* `-a`, `--admin`:
	37	Register new user as an admin. Will prompt if omitted.
	38
	39	* `-c`, `--config`:
	40	Path to server config file containing the shared secret.
	41
	42	* `-k`, `--shared-secret`:
	43	Shared secret as defined in server config file. This is an optional
	44	parameter as it can be also supplied via the YAML file.
	45
	46	* `server_url`:
	47	URL of the home server. Defaults to 'https://localhost:8448'.
	48
	49	## EXAMPLES
	50
	51	$ register_new_matrix_user -u user1 -p p@ssword -a -c config.yaml
	52
	53	## COPYRIGHT
	54
	55	This man page was written by Rahul De <<rahulde@swecha.net>>
	56	for Debian GNU/Linux distribution.
	57
	58	## SEE ALSO
	59
	60	synctl(1), synapse_port_db(1), hash_password(1)

+98

-0

debian/synapse_port_db.1 less more

	0	.\" generated with Ronn/v0.7.3
	1	.\" http://github.com/rtomayko/ronn/tree/0.7.3
	2	.
	3	.TH "SYNAPSE_PORT_DB" "1" "February 2017" "" ""
	4	.
	5	.SH "NAME"
	6	\fBsynapse_port_db\fR \- A script to port an existing synapse SQLite database to a new PostgreSQL database\.
	7	.
	8	.SH "SYNOPSIS"
	9	\fBsynapse_port_db\fR [\-v] \-\-sqlite\-database=\fIdbfile\fR \-\-postgres\-config=\fIyamlconfig\fR [\-\-curses] [\-\-batch\-size=\fIbatch\-size\fR]
	10	.
	11	.SH "DESCRIPTION"
	12	\fBsynapse_port_db\fR ports an existing synapse SQLite database to a new PostgreSQL database\.
	13	.
	14	.P
	15	SQLite database is specified with \fB\-\-sqlite\-database\fR option and PostgreSQL configuration required to connect to PostgreSQL database is provided using \fB\-\-postgres\-config\fR configuration\. The configuration is specified in YAML format\.
	16	.
	17	.SH "OPTIONS"
	18	.
	19	.TP
	20	\fB\-v\fR
	21	Print log messages in \fBdebug\fR level instead of \fBinfo\fR level\.
	22	.
	23	.TP
	24	\fB\-\-sqlite\-database\fR
	25	The snapshot of the SQLite database file\. This must not be currently used by a running synapse server\.
	26	.
	27	.TP
	28	\fB\-\-postgres\-config\fR
	29	The database config file for the PostgreSQL database\.
	30	.
	31	.TP
	32	\fB\-\-curses\fR
	33	Display a curses based progress UI\.
	34	.
	35	.SH "CONFIG FILE"
	36	The postgres configuration file must be a valid YAML file with the following options\.
	37	.
	38	.IP "\(bu" 4
	39	\fBdatabase\fR: Database configuration section\. This section header can be ignored and the options below may be specified as top level keys\.
	40	.
	41	.IP "\(bu" 4
	42	\fBname\fR: Connector to use when connecting to the database\. This value must be \fBpsycopg2\fR\.
	43	.
	44	.IP "\(bu" 4
	45	\fBargs\fR: DB API 2\.0 compatible arguments to send to the \fBpsycopg2\fR module\.
	46	.
	47	.IP "\(bu" 4
	48	\fBdbname\fR \- the database name
	49	.
	50	.IP "\(bu" 4
	51	\fBuser\fR \- user name used to authenticate
	52	.
	53	.IP "\(bu" 4
	54	\fBpassword\fR \- password used to authenticate
	55	.
	56	.IP "\(bu" 4
	57	\fBhost\fR \- database host address (defaults to UNIX socket if not provided)
	58	.
	59	.IP "\(bu" 4
	60	\fBport\fR \- connection port number (defaults to 5432 if not provided)
	61	.
	62	.IP "" 0
	63
	64	.
	65	.IP "\(bu" 4
	66	\fBsynchronous_commit\fR: Optional\. Default is True\. If the value is \fBFalse\fR, enable asynchronous commit and don\'t wait for the server to call fsync before ending the transaction\. See: https://www\.postgresql\.org/docs/current/static/wal\-async\-commit\.html
	67	.
	68	.IP "" 0
	69
	70	.
	71	.IP "" 0
	72	.
	73	.P
	74	Following example illustrates the configuration file format\.
	75	.
	76	.IP "" 4
	77	.
	78	.nf
	79
	80	database:
	81	name: psycopg2
	82	args:
	83	dbname: synapsedb
	84	user: synapseuser
	85	password: ORohmi9Eet=ohphi
	86	host: localhost
	87	synchronous_commit: false
	88	.
	89	.fi
	90	.
	91	.IP "" 0
	92	.
	93	.SH "COPYRIGHT"
	94	This man page was written by Sunil Mohan Adapa <\fIsunil@medhas\.org\fR> for Debian GNU/Linux distribution\.
	95	.
	96	.SH "SEE ALSO"
	97	synctl(1), hash_password(1), register_new_matrix_user(1)

+87

-0

debian/synapse_port_db.ronn less more

	0	synapse_port_db(1) -- A script to port an existing synapse SQLite database to a new PostgreSQL database.
	1	=============================================
	2
	3	## SYNOPSIS
	4
	5	`synapse_port_db` [-v] --sqlite-database=<dbfile> --postgres-config=<yamlconfig> [--curses] [--batch-size=<batch-size>]
	6
	7	## DESCRIPTION
	8
	9	synapse_port_db ports an existing synapse SQLite database to a new
	10	PostgreSQL database.
	11
	12	SQLite database is specified with `--sqlite-database` option and
	13	PostgreSQL configuration required to connect to PostgreSQL database is
	14	provided using `--postgres-config` configuration. The configuration
	15	is specified in YAML format.
	16
	17	## OPTIONS
	18
	19	* `-v`:
	20	Print log messages in `debug` level instead of `info` level.
	21
	22	* `--sqlite-database`:
	23	The snapshot of the SQLite database file. This must not be
	24	currently used by a running synapse server.
	25
	26	* `--postgres-config`:
	27	The database config file for the PostgreSQL database.
	28
	29	* `--curses`:
	30	Display a curses based progress UI.
	31
	32	## CONFIG FILE
	33
	34	The postgres configuration file must be a valid YAML file with the
	35	following options.
	36
	37	* `database`:
	38	Database configuration section. This section header can be
	39	ignored and the options below may be specified as top level
	40	keys.
	41
	42	* `name`:
	43	Connector to use when connecting to the database. This value must
	44	be `psycopg2`.
	45
	46	* `args`:
	47	DB API 2.0 compatible arguments to send to the `psycopg2` module.
	48
	49	* `dbname` - the database name
	50
	51	* `user` - user name used to authenticate
	52
	53	* `password` - password used to authenticate
	54
	55	* `host` - database host address (defaults to UNIX socket if not
	56	provided)
	57
	58	* `port` - connection port number (defaults to 5432 if not
	59	provided)
	60
	61
	62	* `synchronous_commit`:
	63	Optional. Default is True. If the value is `False`, enable
	64	asynchronous commit and don't wait for the server to call fsync
	65	before ending the transaction. See:
	66	https://www.postgresql.org/docs/current/static/wal-async-commit.html
	67
	68	Following example illustrates the configuration file format.
	69
	70	database:
	71	name: psycopg2
	72	args:
	73	dbname: synapsedb
	74	user: synapseuser
	75	password: ORohmi9Eet=ohphi
	76	host: localhost
	77	synchronous_commit: false
	78
	79	## COPYRIGHT
	80
	81	This man page was written by Sunil Mohan Adapa <<sunil@medhas.org>> for
	82	Debian GNU/Linux distribution.
	83
	84	## SEE ALSO
	85
	86	synctl(1), hash_password(1), register_new_matrix_user(1)

+63

-0

debian/synctl.1 less more

	0	.\" generated with Ronn/v0.7.3
	1	.\" http://github.com/rtomayko/ronn/tree/0.7.3
	2	.
	3	.TH "SYNCTL" "1" "February 2017" "" ""
	4	.
	5	.SH "NAME"
	6	\fBsynctl\fR \- Synapse server control interface
	7	.
	8	.SH "SYNOPSIS"
	9	Start, stop or restart synapse server\.
	10	.
	11	.P
	12	\fBsynctl\fR {start\|stop\|restart} [configfile] [\-w\|\-\-worker=\fIWORKERCONFIG\fR] [\-a\|\-\-all\-processes=\fIWORKERCONFIGDIR\fR]
	13	.
	14	.SH "DESCRIPTION"
	15	\fBsynctl\fR can be used to start, stop or restart Synapse server\. The control operation can be done on all processes or a single worker process\.
	16	.
	17	.SH "OPTIONS"
	18	.
	19	.TP
	20	\fBaction\fR
	21	The value of action should be one of \fBstart\fR, \fBstop\fR or \fBrestart\fR\.
	22	.
	23	.TP
	24	\fBconfigfile\fR
	25	Optional path of the configuration file to use\. Default value is \fBhomeserver\.yaml\fR\. The configuration file must exist for the operation to succeed\.
	26	.
	27	.TP
	28	\fB\-w\fR, \fB\-\-worker\fR:
	29	.
	30	.IP
	31	Perform start, stop or restart operations on a single worker\. Incompatible with \fB\-a\fR\|\fB\-\-all\-processes\fR\. Value passed must be a valid worker\'s configuration file\.
	32	.
	33	.TP
	34	\fB\-a\fR, \fB\-\-all\-processes\fR:
	35	.
	36	.IP
	37	Perform start, stop or restart operations on all the workers in the given directory and the main synapse process\. Incompatible with \fB\-w\fR\|\fB\-\-worker\fR\. Value passed must be a directory containing valid work configuration files\. All files ending with \fB\.yaml\fR extension shall be considered as configuration files and all other files in the directory are ignored\.
	38	.
	39	.SH "CONFIGURATION FILE"
	40	Configuration file may be generated as follows:
	41	.
	42	.IP "" 4
	43	.
	44	.nf
	45
	46	$ python \-B \-m synapse\.app\.homeserver \-c config\.yaml \-\-generate\-config \-\-server\-name=<server name>
	47	.
	48	.fi
	49	.
	50	.IP "" 0
	51	.
	52	.SH "ENVIRONMENT"
	53	.
	54	.TP
	55	\fBSYNAPSE_CACHE_FACTOR\fR
	56	Synapse\'s architecture is quite RAM hungry currently \- a lot of recent room data and metadata is deliberately cached in RAM in order to speed up common requests\. This will be improved in future, but for now the easiest way to either reduce the RAM usage (at the risk of slowing things down) is to set the SYNAPSE_CACHE_FACTOR environment variable\. Roughly speaking, a SYNAPSE_CACHE_FACTOR of 1\.0 will max out at around 3\-4GB of resident memory \- this is what we currently run the matrix\.org on\. The default setting is currently 0\.1, which is probably around a ~700MB footprint\. You can dial it down further to 0\.02 if desired, which targets roughly ~512MB\. Conversely you can dial it up if you need performance for lots of users and have a box with a lot of RAM\.
	57	.
	58	.SH "COPYRIGHT"
	59	This man page was written by Sunil Mohan Adapa <\fIsunil@medhas\.org\fR> for Debian GNU/Linux distribution\.
	60	.
	61	.SH "SEE ALSO"
	62	synapse_port_db(1), hash_password(1), register_new_matrix_user(1)

+70

-0

debian/synctl.ronn less more

	0	synctl(1) -- Synapse server control interface
	1	=============================================
	2
	3	## SYNOPSIS
	4	Start, stop or restart synapse server.
	5
	6	`synctl` {start\|stop\|restart} [configfile] [-w\|--worker=<WORKERCONFIG>] [-a\|--all-processes=<WORKERCONFIGDIR>]
	7
	8	## DESCRIPTION
	9
	10	synctl can be used to start, stop or restart Synapse server. The
	11	control operation can be done on all processes or a single worker
	12	process.
	13
	14	## OPTIONS
	15
	16	* `action`:
	17	The value of action should be one of `start`, `stop` or `restart`.
	18
	19	* `configfile`:
	20	Optional path of the configuration file to use. Default value is
	21	`homeserver.yaml`. The configuration file must exist for the
	22	operation to succeed.
	23
	24	* `-w`, `--worker`:
	25
	26	Perform start, stop or restart operations on a single worker.
	27	Incompatible with `-a`\|`--all-processes`. Value passed must be a
	28	valid worker's configuration file.
	29
	30	* `-a`, `--all-processes`:
	31
	32	Perform start, stop or restart operations on all the workers in
	33	the given directory and the main synapse process. Incompatible
	34	with `-w`\|`--worker`. Value passed must be a directory containing
	35	valid work configuration files. All files ending with `.yaml`
	36	extension shall be considered as configuration files and all other
	37	files in the directory are ignored.
	38
	39	## CONFIGURATION FILE
	40
	41	Configuration file may be generated as follows:
	42
	43	$ python -B -m synapse.app.homeserver -c config.yaml --generate-config --server-name=<server name>
	44
	45	## ENVIRONMENT
	46
	47	* `SYNAPSE_CACHE_FACTOR`:
	48	Synapse's architecture is quite RAM hungry currently - a lot of
	49	recent room data and metadata is deliberately cached in RAM in
	50	order to speed up common requests. This will be improved in
	51	future, but for now the easiest way to either reduce the RAM usage
	52	(at the risk of slowing things down) is to set the
	53	SYNAPSE_CACHE_FACTOR environment variable. Roughly speaking, a
	54	SYNAPSE_CACHE_FACTOR of 1.0 will max out at around 3-4GB of
	55	resident memory - this is what we currently run the matrix.org
	56	on. The default setting is currently 0.1, which is probably around
	57	a ~700MB footprint. You can dial it down further to 0.02 if
	58	desired, which targets roughly ~512MB. Conversely you can dial it
	59	up if you need performance for lots of users and have a box with a
	60	lot of RAM.
	61
	62	## COPYRIGHT
	63
	64	This man page was written by Sunil Mohan Adapa <<sunil@medhas.org>> for
	65	Debian GNU/Linux distribution.
	66
	67	## SEE ALSO
	68
	69	synapse_port_db(1), hash_password(1), register_new_matrix_user(1)

+11

-10

debian/templates less more

0	0	Template: matrix-synapse/server-name
1	1	Type: string
2		Description: Name of the server
3		The name that this homeserver will appear as, to clients and other servers via
4		federation. This name should match the SRV record published in DNS.
	2	_Description: Name of the server:
	3	The name that this homeserver will appear as, to clients and other
	4	servers via federation. This name should match the SRV record
	5	published in DNS.
5	6
6	7	Template: matrix-synapse/report-stats
7	8	Type: boolean
8	9	Default: true
9		Description: Report anonymous stats (yes/no)
10		We would really appreciate it if you could help our project out by reporting
11		anonymized usage statistics from your homeserver. Only very basic aggregate
12		data (e.g. number of users) will be reported, but it helps us to track the
13		growth of the Matrix community, and helps us to make Matrix a success, as well
14		as to convince other networks that they should peer with us.
	10	_Description: Report anonymous statistics?
	11	Developers of Matrix and Synapse really appreciate helping the
	12	project out by reporting anonymized usage statistics from this
	13	homeserver. Only very basic aggregate data (e.g. number of users)
	14	will be reported, but it helps track the growth of the Matrix
	15	community, and helps in making Matrix a success, as well as to
	16	convince other networks that they should peer with Matrix.
15	17	.
16	18	Thank you.
17