mirror of
https://github.com/element-hq/element-web
synced 2024-11-28 12:28:50 +03:00
Merge pull request #1 from matrix-org/bwindels/join-with-consent
join with consent dialog
This commit is contained in:
Bruno Windels
GitHub
commit
6ae5a7bd97
21 changed files with 1033 additions and 210 deletions
29
README.md
29
README.md
|
|
@ -18,14 +18,39 @@ This repository contains tests for the matrix-react-sdk web app. The tests fire
|
||||||
- Run 2 synapse instances to test federation use cases.
|
- Run 2 synapse instances to test federation use cases.
|
||||||
- start synapse with clean config/database on every test run
|
- start synapse with clean config/database on every test run
|
||||||
- look into CI(Travis) integration
|
- look into CI(Travis) integration
|
||||||
|
- create interactive mode, where window is opened, and browser is kept open until Ctrl^C, for easy test debugging.
|
||||||
|
|
||||||
|
## It's broken! How do I see what's happening in the browser?
|
||||||
|
|
||||||
|
Look for this line:
|
||||||
|
```
|
||||||
|
puppeteer.launch();
|
||||||
|
```
|
||||||
|
Now change it to:
|
||||||
|
```
|
||||||
|
puppeteer.launch({headless: false});
|
||||||
|
```
|
||||||
|
|
||||||
## How to run
|
## How to run
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
- install synapse with `sh synapse/install.sh`, this fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
|
||||||
|
- install riot with `sh riot/install.sh`, this fetches the master branch at the moment.
|
||||||
- install dependencies with `npm install` (will download copy of chrome)
|
- install dependencies with `npm install` (will download copy of chrome)
|
||||||
- have riot-web running on `localhost:8080`
|
- have riot-web running on `localhost:8080`
|
||||||
- have a local synapse running at `localhost:8008`
|
- have a local synapse running at `localhost:8008`
|
||||||
|
|
||||||
### Run tests
|
### Run tests
|
||||||
- run tests with `node start.js`
|
|
||||||
|
Run tests with `sh run.sh`.
|
||||||
|
|
||||||
|
You should see the terminal split with on top the server output (both riot static server, and synapse), and on the bottom the tests running.
|
||||||
|
|
||||||
|
Developer Guide
|
||||||
|
===============
|
||||||
|
|
||||||
|
Please follow the standard Matrix contributor's guide:
|
||||||
|
https://github.com/matrix-org/synapse/tree/master/CONTRIBUTING.rst
|
||||||
|
|
||||||
|
Please follow the Matrix JS/React code style as per:
|
||||||
|
https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md
|
||||||
|
|
|
||||||
184
code_style.md
184
code_style.md
|
|
@ -1,184 +0,0 @@
|
||||||
Matrix JavaScript/ECMAScript Style Guide
|
|
||||||
========================================
|
|
||||||
|
|
||||||
The intention of this guide is to make Matrix's JavaScript codebase clean,
|
|
||||||
consistent with other popular JavaScript styles and consistent with the rest of
|
|
||||||
the Matrix codebase. For reference, the Matrix Python style guide can be found
|
|
||||||
at https://github.com/matrix-org/synapse/blob/master/docs/code_style.rst
|
|
||||||
|
|
||||||
This document reflects how we would like Matrix JavaScript code to look, with
|
|
||||||
acknowledgement that a significant amount of code is written to older
|
|
||||||
standards.
|
|
||||||
|
|
||||||
Write applications in modern ECMAScript and use a transpiler where necessary to
|
|
||||||
target older platforms. When writing library code, consider carefully whether
|
|
||||||
to write in ES5 to allow all JavaScript application to use the code directly or
|
|
||||||
writing in modern ECMAScript and using a transpile step to generate the file
|
|
||||||
that applications can then include. There are significant benefits in being
|
|
||||||
able to use modern ECMAScript, although the tooling for doing so can be awkward
|
|
||||||
for library code, especially with regard to translating source maps and line
|
|
||||||
number throgh from the original code to the final application.
|
|
||||||
|
|
||||||
General Style
|
|
||||||
-------------
|
|
||||||
- 4 spaces to indent, for consistency with Matrix Python.
|
|
||||||
- 120 columns per line, but try to keep JavaScript code around the 80 column mark.
|
|
||||||
Inline JSX in particular can be nicer with more columns per line.
|
|
||||||
- No trailing whitespace at end of lines.
|
|
||||||
- Don't indent empty lines.
|
|
||||||
- One newline at the end of the file.
|
|
||||||
- Unix newlines, never `\r`
|
|
||||||
- Indent similar to our python code: break up long lines at logical boundaries,
|
|
||||||
more than one argument on a line is OK
|
|
||||||
- Use semicolons, for consistency with node.
|
|
||||||
- UpperCamelCase for class and type names
|
|
||||||
- lowerCamelCase for functions and variables.
|
|
||||||
- Single line ternary operators are fine.
|
|
||||||
- UPPER_CAMEL_CASE for constants
|
|
||||||
- Single quotes for strings by default, for consistency with most JavaScript styles:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
"bad" // Bad
|
|
||||||
'good' // Good
|
|
||||||
```
|
|
||||||
- Use parentheses or `` ` `` instead of `\` for line continuation where ever possible
|
|
||||||
- Open braces on the same line (consistent with Node):
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
if (x) {
|
|
||||||
console.log("I am a fish"); // Good
|
|
||||||
}
|
|
||||||
|
|
||||||
if (x)
|
|
||||||
{
|
|
||||||
console.log("I am a fish"); // Bad
|
|
||||||
}
|
|
||||||
```
|
|
||||||
- Spaces after `if`, `for`, `else` etc, no space around the condition:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
if (x) {
|
|
||||||
console.log("I am a fish"); // Good
|
|
||||||
}
|
|
||||||
|
|
||||||
if(x) {
|
|
||||||
console.log("I am a fish"); // Bad
|
|
||||||
}
|
|
||||||
|
|
||||||
if ( x ) {
|
|
||||||
console.log("I am a fish"); // Bad
|
|
||||||
}
|
|
||||||
```
|
|
||||||
- No new line before else, catch, finally, etc:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
if (x) {
|
|
||||||
console.log("I am a fish");
|
|
||||||
} else {
|
|
||||||
console.log("I am a chimp"); // Good
|
|
||||||
}
|
|
||||||
|
|
||||||
if (x) {
|
|
||||||
console.log("I am a fish");
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
console.log("I am a chimp"); // Bad
|
|
||||||
}
|
|
||||||
```
|
|
||||||
- Declare one variable per var statement (consistent with Node). Unless they
|
|
||||||
are simple and closely related. If you put the next declaration on a new line,
|
|
||||||
treat yourself to another `var`:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const key = "foo",
|
|
||||||
comparator = function(x, y) {
|
|
||||||
return x - y;
|
|
||||||
}; // Bad
|
|
||||||
|
|
||||||
const key = "foo";
|
|
||||||
const comparator = function(x, y) {
|
|
||||||
return x - y;
|
|
||||||
}; // Good
|
|
||||||
|
|
||||||
let x = 0, y = 0; // Fine
|
|
||||||
|
|
||||||
let x = 0;
|
|
||||||
let y = 0; // Also fine
|
|
||||||
```
|
|
||||||
- A single line `if` is fine, all others have braces. This prevents errors when adding to the code.:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
if (x) return true; // Fine
|
|
||||||
|
|
||||||
if (x) {
|
|
||||||
return true; // Also fine
|
|
||||||
}
|
|
||||||
|
|
||||||
if (x)
|
|
||||||
return true; // Not fine
|
|
||||||
```
|
|
||||||
- Terminate all multi-line lists, object literals, imports and ideally function calls with commas (if using a transpiler). Note that trailing function commas require explicit configuration in babel at time of writing:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var mascots = [
|
|
||||||
"Patrick",
|
|
||||||
"Shirley",
|
|
||||||
"Colin",
|
|
||||||
"Susan",
|
|
||||||
"Sir Arthur David" // Bad
|
|
||||||
];
|
|
||||||
|
|
||||||
var mascots = [
|
|
||||||
"Patrick",
|
|
||||||
"Shirley",
|
|
||||||
"Colin",
|
|
||||||
"Susan",
|
|
||||||
"Sir Arthur David", // Good
|
|
||||||
];
|
|
||||||
```
|
|
||||||
- Use `null`, `undefined` etc consistently with node:
|
|
||||||
Boolean variables and functions should always be either true or false. Don't set it to 0 unless it's supposed to be a number.
|
|
||||||
When something is intentionally missing or removed, set it to null.
|
|
||||||
If returning a boolean, type coerce:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
function hasThings() {
|
|
||||||
return !!length; // bad
|
|
||||||
return new Boolean(length); // REALLY bad
|
|
||||||
return Boolean(length); // good
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Don't set things to undefined. Reserve that value to mean "not yet set to anything."
|
|
||||||
Boolean objects are verboten.
|
|
||||||
- Use JSDoc
|
|
||||||
|
|
||||||
ECMAScript
|
|
||||||
----------
|
|
||||||
- Use `const` unless you need a re-assignable variable. This ensures things you don't want to be re-assigned can't be.
|
|
||||||
- Be careful migrating files to newer syntax.
|
|
||||||
- Don't mix `require` and `import` in the same file. Either stick to the old style or change them all.
|
|
||||||
- Likewise, don't mix things like class properties and `MyClass.prototype.MY_CONSTANT = 42;`
|
|
||||||
- Be careful mixing arrow functions and regular functions, eg. if one function in a promise chain is an
|
|
||||||
arrow function, they probably all should be.
|
|
||||||
- Apart from that, newer ES features should be used whenever the author deems them to be appropriate.
|
|
||||||
- Flow annotations are welcome and encouraged.
|
|
||||||
|
|
||||||
React
|
|
||||||
-----
|
|
||||||
- Use React.createClass rather than ES6 classes for components, as the boilerplate is way too heavy on ES6 currently. ES7 might improve it.
|
|
||||||
- Pull out functions in props to the class, generally as specific event handlers:
|
|
||||||
|
|
||||||
```jsx
|
|
||||||
<Foo onClick={function(ev) {doStuff();}}> // Bad
|
|
||||||
<Foo onClick={(ev) => {doStuff();}}> // Equally bad
|
|
||||||
<Foo onClick={this.doStuff}> // Better
|
|
||||||
<Foo onClick={this.onFooClick}> // Best, if onFooClick would do anything other than directly calling doStuff
|
|
||||||
```
|
|
||||||
|
|
||||||
Not doing so is acceptable in a single case; in function-refs:
|
|
||||||
|
|
||||||
```jsx
|
|
||||||
<Foo ref={(self) => this.component = self}>
|
|
||||||
```
|
|
||||||
- Think about whether your component really needs state: are you duplicating
|
|
||||||
information in component state that could be derived from the model?
|
|
||||||
32
helpers.js
32
helpers.js
|
|
@ -16,6 +16,7 @@ limitations under the License.
|
||||||
|
|
||||||
// puppeteer helpers
|
// puppeteer helpers
|
||||||
|
|
||||||
|
// TODO: rename to queryAndInnertext?
|
||||||
async function tryGetInnertext(page, selector) {
|
async function tryGetInnertext(page, selector) {
|
||||||
const field = await page.$(selector);
|
const field = await page.$(selector);
|
||||||
if (field != null) {
|
if (field != null) {
|
||||||
|
|
@ -25,6 +26,11 @@ async function tryGetInnertext(page, selector) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function innerText(page, field) {
|
||||||
|
const text_handle = await field.getProperty('innerText');
|
||||||
|
return await text_handle.jsonValue();
|
||||||
|
}
|
||||||
|
|
||||||
async function newPage() {
|
async function newPage() {
|
||||||
const page = await browser.newPage();
|
const page = await browser.newPage();
|
||||||
await page.setViewport({
|
await page.setViewport({
|
||||||
|
|
@ -82,11 +88,34 @@ async function replaceInputText(input, text) {
|
||||||
await input.type(text);
|
await input.type(text);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: rename to waitAndQuery(Single)?
|
||||||
async function waitAndQuerySelector(page, selector, timeout = 500) {
|
async function waitAndQuerySelector(page, selector, timeout = 500) {
|
||||||
await page.waitForSelector(selector, {visible: true, timeout});
|
await page.waitForSelector(selector, {visible: true, timeout});
|
||||||
return await page.$(selector);
|
return await page.$(selector);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function waitAndQueryAll(page, selector, timeout = 500) {
|
||||||
|
await page.waitForSelector(selector, {visible: true, timeout});
|
||||||
|
return await page.$$(selector);
|
||||||
|
}
|
||||||
|
|
||||||
|
function waitForNewPage(timeout = 500) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const timeoutHandle = setTimeout(() => {
|
||||||
|
browser.removeEventListener('targetcreated', callback);
|
||||||
|
reject(new Error(`timeout of ${timeout}ms for waitForNewPage elapsed`));
|
||||||
|
}, timeout);
|
||||||
|
|
||||||
|
const callback = async (target) => {
|
||||||
|
clearTimeout(timeoutHandle);
|
||||||
|
const page = await target.page();
|
||||||
|
resolve(page);
|
||||||
|
};
|
||||||
|
|
||||||
|
browser.once('targetcreated', callback);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// other helpers
|
// other helpers
|
||||||
|
|
||||||
function randomInt(max) {
|
function randomInt(max) {
|
||||||
|
|
@ -103,6 +132,7 @@ function delay(ms) {
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
tryGetInnertext,
|
tryGetInnertext,
|
||||||
|
innerText,
|
||||||
newPage,
|
newPage,
|
||||||
logConsole,
|
logConsole,
|
||||||
logXHRRequests,
|
logXHRRequests,
|
||||||
|
|
@ -110,6 +140,8 @@ module.exports = {
|
||||||
printElements,
|
printElements,
|
||||||
replaceInputText,
|
replaceInputText,
|
||||||
waitAndQuerySelector,
|
waitAndQuerySelector,
|
||||||
|
waitAndQueryAll,
|
||||||
|
waitForNewPage,
|
||||||
randomInt,
|
randomInt,
|
||||||
riotUrl,
|
riotUrl,
|
||||||
delay,
|
delay,
|
||||||
|
|
|
||||||
2
riot/.gitignore
vendored
Normal file
2
riot/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
riot-web
|
||||||
|
riot.pid
|
||||||
33
riot/config-template/config.json
Normal file
33
riot/config-template/config.json
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
{
|
||||||
|
"default_hs_url": "http://localhost:8008",
|
||||||
|
"default_is_url": "https://vector.im",
|
||||||
|
"disable_custom_urls": false,
|
||||||
|
"disable_guests": false,
|
||||||
|
"disable_login_language_selector": false,
|
||||||
|
"disable_3pid_login": false,
|
||||||
|
"brand": "Riot",
|
||||||
|
"integrations_ui_url": "https://scalar.vector.im/",
|
||||||
|
"integrations_rest_url": "https://scalar.vector.im/api",
|
||||||
|
"bug_report_endpoint_url": "https://riot.im/bugreports/submit",
|
||||||
|
"features": {
|
||||||
|
"feature_groups": "labs",
|
||||||
|
"feature_pinning": "labs"
|
||||||
|
},
|
||||||
|
"default_federate": true,
|
||||||
|
"welcomePageUrl": "home.html",
|
||||||
|
"default_theme": "light",
|
||||||
|
"roomDirectory": {
|
||||||
|
"servers": [
|
||||||
|
"localhost:8008"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"piwik": {
|
||||||
|
"url": "https://piwik.riot.im/",
|
||||||
|
"whitelistedHSUrls": ["http://localhost:8008"],
|
||||||
|
"whitelistedISUrls": ["https://vector.im", "https://matrix.org"],
|
||||||
|
"siteId": 1
|
||||||
|
},
|
||||||
|
"enable_presence_by_hs_url": {
|
||||||
|
"https://matrix.org": false
|
||||||
|
}
|
||||||
|
}
|
||||||
13
riot/install.sh
Normal file
13
riot/install.sh
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
RIOT_BRANCH=master
|
||||||
|
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR
|
||||||
|
curl -L https://github.com/vector-im/riot-web/archive/${RIOT_BRANCH}.zip --output riot.zip
|
||||||
|
unzip riot.zip
|
||||||
|
rm riot.zip
|
||||||
|
mv riot-web-${RIOT_BRANCH} riot-web
|
||||||
|
cp config-template/config.json riot-web/
|
||||||
|
pushd riot-web
|
||||||
|
npm install
|
||||||
|
npm run build
|
||||||
|
popd
|
||||||
8
riot/start.sh
Normal file
8
riot/start.sh
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR
|
||||||
|
pushd riot-web/webapp/
|
||||||
|
python -m SimpleHTTPServer 8080 &
|
||||||
|
PID=$!
|
||||||
|
popd
|
||||||
|
echo $PID > riot.pid
|
||||||
|
popd
|
||||||
6
riot/stop.sh
Normal file
6
riot/stop.sh
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR > /dev/null
|
||||||
|
PIDFILE=riot.pid
|
||||||
|
kill $(cat $PIDFILE)
|
||||||
|
rm $PIDFILE
|
||||||
|
popd > /dev/null
|
||||||
4
run.sh
Normal file
4
run.sh
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
tmux \
|
||||||
|
new-session "sh riot/stop.sh; sh synapse/stop.sh; sh synapse/start.sh; sh riot/start.sh; read"\; \
|
||||||
|
split-window "sleep 5; node start.js; sh riot/stop.sh; sh synapse/stop.sh; read"\; \
|
||||||
|
select-layout even-vertical
|
||||||
18
start.js
18
start.js
|
|
@ -20,24 +20,32 @@ const assert = require('assert');
|
||||||
|
|
||||||
const signup = require('./tests/signup');
|
const signup = require('./tests/signup');
|
||||||
const join = require('./tests/join');
|
const join = require('./tests/join');
|
||||||
|
const createRoom = require('./tests/create-room');
|
||||||
|
const acceptServerNoticesInviteAndConsent = require('./tests/server-notices-consent');
|
||||||
|
|
||||||
|
const homeserver = 'http://localhost:8008';
|
||||||
|
|
||||||
global.riotserver = 'http://localhost:8080';
|
global.riotserver = 'http://localhost:8080';
|
||||||
global.homeserver = 'http://localhost:8008';
|
|
||||||
global.browser = null;
|
global.browser = null;
|
||||||
|
|
||||||
async function runTests() {
|
async function runTests() {
|
||||||
global.browser = await puppeteer.launch();
|
global.browser = await puppeteer.launch();
|
||||||
const page = await helpers.newPage();
|
const page = await helpers.newPage();
|
||||||
|
|
||||||
const username = 'bruno-' + helpers.randomInt(10000);
|
const username = 'user-' + helpers.randomInt(10000);
|
||||||
const password = 'testtest';
|
const password = 'testtest';
|
||||||
process.stdout.write(`* signing up as ${username} ... `);
|
process.stdout.write(`* signing up as ${username} ... `);
|
||||||
await signup(page, username, password, homeserver);
|
await signup(page, username, password);
|
||||||
|
process.stdout.write('done\n');
|
||||||
|
|
||||||
|
const noticesName = "Server Notices";
|
||||||
|
process.stdout.write(`* accepting "${noticesName}" and accepting terms & conditions ...`);
|
||||||
|
await acceptServerNoticesInviteAndConsent(page, noticesName);
|
||||||
process.stdout.write('done\n');
|
process.stdout.write('done\n');
|
||||||
|
|
||||||
const room = 'test';
|
const room = 'test';
|
||||||
process.stdout.write(`* joining room ${room} ... `);
|
process.stdout.write(`* creating room ${room} ... `);
|
||||||
await join(page, room);
|
await createRoom(page, room);
|
||||||
process.stdout.write('done\n');
|
process.stdout.write('done\n');
|
||||||
|
|
||||||
await browser.close();
|
await browser.close();
|
||||||
|
|
|
||||||
2
synapse/.gitignore
vendored
Normal file
2
synapse/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
installations
|
||||||
|
synapse.zip
|
||||||
697
synapse/config-templates/consent/homeserver.yaml
Normal file
697
synapse/config-templates/consent/homeserver.yaml
Normal file
|
|
@ -0,0 +1,697 @@
|
||||||
|
# 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: "{{SYNAPSE_ROOT}}localhost.tls.crt"
|
||||||
|
|
||||||
|
# PEM encoded private key for TLS
|
||||||
|
tls_private_key_path: "{{SYNAPSE_ROOT}}localhost.tls.key"
|
||||||
|
|
||||||
|
# PEM dh parameters for ephemeral keys
|
||||||
|
tls_dh_params_path: "{{SYNAPSE_ROOT}}localhost.tls.dh"
|
||||||
|
|
||||||
|
# Don't bind to the https port
|
||||||
|
no_tls: True
|
||||||
|
|
||||||
|
# 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 the fingerprint of its own certificate
|
||||||
|
# to the list. So if federation traffic is handled 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.
|
||||||
|
#
|
||||||
|
# You can calculate a fingerprint from a given TLS listener via:
|
||||||
|
# openssl s_client -connect $host:$port < /dev/null 2> /dev/null |
|
||||||
|
# openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '='
|
||||||
|
# or by checking matrix.org/federationtester/api/report?server_name=$host
|
||||||
|
#
|
||||||
|
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: "localhost"
|
||||||
|
|
||||||
|
# When running as a daemon, the file to store the pid in
|
||||||
|
pid_file: {{SYNAPSE_ROOT}}homeserver.pid
|
||||||
|
|
||||||
|
# CPU affinity mask. Setting this restricts the CPUs on which the
|
||||||
|
# process will be scheduled. It is represented as a bitmask, with the
|
||||||
|
# lowest order bit corresponding to the first logical CPU and the
|
||||||
|
# highest order bit corresponding to the last logical CPU. Not all CPUs
|
||||||
|
# may exist on a given system but a mask may specify more CPUs than are
|
||||||
|
# present.
|
||||||
|
#
|
||||||
|
# For example:
|
||||||
|
# 0x00000001 is processor #0,
|
||||||
|
# 0x00000003 is processors #0 and #1,
|
||||||
|
# 0xFFFFFFFF is all processors (#0 through #31).
|
||||||
|
#
|
||||||
|
# Pinning a Python process to a single CPU is desirable, because Python
|
||||||
|
# is inherently single-threaded due to the GIL, and can suffer a
|
||||||
|
# 30-40% slowdown due to cache blow-out and thread context switching
|
||||||
|
# if the scheduler happens to schedule the underlying threads across
|
||||||
|
# different cores. See
|
||||||
|
# https://www.mirantis.com/blog/improve-performance-python-programs-restricting-single-cpu/.
|
||||||
|
#
|
||||||
|
# cpu_affinity: 0xFFFFFFFF
|
||||||
|
|
||||||
|
# Whether to serve a web client from the HTTP/HTTPS root resource.
|
||||||
|
web_client: True
|
||||||
|
|
||||||
|
# The root directory to server for the above web client.
|
||||||
|
# If left undefined, synapse will serve the matrix-angular-sdk web client.
|
||||||
|
# Make sure matrix-angular-sdk is installed with pip if web_client is True
|
||||||
|
# and web_client_location is undefined
|
||||||
|
# web_client_location: "/path/to/web/root"
|
||||||
|
|
||||||
|
# The public-facing base URL for the client API (not including _matrix/...)
|
||||||
|
public_baseurl: http://localhost:8008/
|
||||||
|
|
||||||
|
# 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]
|
||||||
|
|
||||||
|
# Set the limit on the returned events in the timeline in the get
|
||||||
|
# and sync operations. The default value is -1, means no upper limit.
|
||||||
|
# filter_timeline_limit: 5000
|
||||||
|
|
||||||
|
# Whether room invites to users on this server should be blocked
|
||||||
|
# (except those sent by local server admins). The default is False.
|
||||||
|
# block_non_admin_invites: True
|
||||||
|
|
||||||
|
# Restrict federation to the following whitelist of domains.
|
||||||
|
# N.B. we recommend also firewalling your federation listener to limit
|
||||||
|
# inbound federation traffic as early as possible, rather than relying
|
||||||
|
# purely on this application-layer restriction. If not specified, the
|
||||||
|
# default is to whitelist everything.
|
||||||
|
#
|
||||||
|
# federation_domain_whitelist:
|
||||||
|
# - lon.example.com
|
||||||
|
# - nyc.example.com
|
||||||
|
# - syd.example.com
|
||||||
|
|
||||||
|
# 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 addresses to listen on.
|
||||||
|
# On Linux and Mac OS, `::` will listen on all IPv4 and IPv6
|
||||||
|
# addresses by default. For most other OSes, this will only listen
|
||||||
|
# on IPv6.
|
||||||
|
bind_addresses:
|
||||||
|
- '::'
|
||||||
|
- '0.0.0.0'
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# optional list of additional endpoints which can be loaded via
|
||||||
|
# dynamic modules
|
||||||
|
# additional_resources:
|
||||||
|
# "/_matrix/my/custom/endpoint":
|
||||||
|
# module: my_module.CustomRequestHandler
|
||||||
|
# config: {}
|
||||||
|
|
||||||
|
# Unsecure HTTP listener,
|
||||||
|
# For when matrix traffic passes through loadbalancer that unwraps TLS.
|
||||||
|
- port: 8008
|
||||||
|
tls: false
|
||||||
|
bind_addresses: ['::', '0.0.0.0']
|
||||||
|
type: http
|
||||||
|
|
||||||
|
x_forwarded: false
|
||||||
|
|
||||||
|
resources:
|
||||||
|
- names: [client, webclient, consent]
|
||||||
|
compress: true
|
||||||
|
- names: [federation]
|
||||||
|
compress: false
|
||||||
|
|
||||||
|
# Turn on the twisted ssh manhole service on localhost on the given
|
||||||
|
# port.
|
||||||
|
# - port: 9000
|
||||||
|
# bind_addresses: ['::1', '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: ":memory:"
|
||||||
|
|
||||||
|
# Number of events to cache in memory.
|
||||||
|
event_cache_size: "10K"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# A yaml python logging config file
|
||||||
|
log_config: "{{SYNAPSE_ROOT}}localhost.log.config"
|
||||||
|
|
||||||
|
|
||||||
|
## 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: "{{SYNAPSE_ROOT}}media_store"
|
||||||
|
|
||||||
|
# Media storage providers allow media to be stored in different
|
||||||
|
# locations.
|
||||||
|
# media_storage_providers:
|
||||||
|
# - module: file_system
|
||||||
|
# # Whether to write new local files.
|
||||||
|
# store_local: false
|
||||||
|
# # Whether to write new remote media
|
||||||
|
# store_remote: false
|
||||||
|
# # Whether to block upload requests waiting for write to this
|
||||||
|
# # provider to complete
|
||||||
|
# store_synchronous: false
|
||||||
|
# config:
|
||||||
|
# directory: /mnt/some/other/directory
|
||||||
|
|
||||||
|
# Directory where in-progress uploads are stored.
|
||||||
|
uploads_path: "{{SYNAPSE_ROOT}}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'
|
||||||
|
# - '::1/128'
|
||||||
|
# - 'fe80::/64'
|
||||||
|
# - 'fc00::/7'
|
||||||
|
#
|
||||||
|
# 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"
|
||||||
|
|
||||||
|
# The Username and password if the TURN server needs them and
|
||||||
|
# does not use a token
|
||||||
|
#turn_username: "TURNSERVER_USERNAME"
|
||||||
|
#turn_password: "TURNSERVER_PASSWORD"
|
||||||
|
|
||||||
|
# How long generated TURN credentials last
|
||||||
|
turn_user_lifetime: "1h"
|
||||||
|
|
||||||
|
# Whether guests should be allowed to use the TURN server.
|
||||||
|
# This defaults to True, otherwise VoIP will be unreliable for guests.
|
||||||
|
# However, it does introduce a slight security risk as it allows users to
|
||||||
|
# connect to arbitrary endpoints without having first signed up for a
|
||||||
|
# valid account (e.g. by passing a CAPTCHA).
|
||||||
|
turn_allow_guests: True
|
||||||
|
|
||||||
|
|
||||||
|
## Registration ##
|
||||||
|
|
||||||
|
# Enable registration for new users.
|
||||||
|
enable_registration: True
|
||||||
|
|
||||||
|
# The user must provide all of the below types of 3PID when registering.
|
||||||
|
#
|
||||||
|
# registrations_require_3pid:
|
||||||
|
# - email
|
||||||
|
# - msisdn
|
||||||
|
|
||||||
|
# Mandate that users are only allowed to associate certain formats of
|
||||||
|
# 3PIDs with accounts on this server.
|
||||||
|
#
|
||||||
|
# allowed_local_3pids:
|
||||||
|
# - medium: email
|
||||||
|
# pattern: ".*@matrix\.org"
|
||||||
|
# - medium: email
|
||||||
|
# pattern: ".*@vector\.im"
|
||||||
|
# - medium: msisdn
|
||||||
|
# pattern: "\+44"
|
||||||
|
|
||||||
|
# If set, allows registration by anyone who also has the shared
|
||||||
|
# secret, even if registration is otherwise disabled.
|
||||||
|
registration_shared_secret: "{{REGISTRATION_SHARED_SECRET}}"
|
||||||
|
|
||||||
|
# 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 is 12 (which equates to 2^12 rounds).
|
||||||
|
# N.B. that increasing this will exponentially increase the time required
|
||||||
|
# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
|
||||||
|
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
|
||||||
|
- riot.im
|
||||||
|
|
||||||
|
# Users who register on this homeserver will automatically be joined
|
||||||
|
# to these roomsS
|
||||||
|
#auto_join_rooms:
|
||||||
|
# - "#example:example.com"
|
||||||
|
|
||||||
|
|
||||||
|
## 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: "{{MACAROON_SECRET_KEY}}"
|
||||||
|
|
||||||
|
# Used to enable access token expiration.
|
||||||
|
expire_access_token: False
|
||||||
|
|
||||||
|
# a secret which is used to calculate HMACs for form values, to stop
|
||||||
|
# falsification of values
|
||||||
|
form_secret: "{{FORM_SECRET}}"
|
||||||
|
|
||||||
|
## Signing Keys ##
|
||||||
|
|
||||||
|
# Path to the signing key to sign messages with
|
||||||
|
signing_key_path: "{{SYNAPSE_ROOT}}localhost.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.block_non_admin_invites
|
||||||
|
|
||||||
|
# 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: "{{SYNAPSE_ROOT}}sp_conf.py"
|
||||||
|
# idp_redirect_url: "http://localhost/idp"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Enable CAS for registration and login.
|
||||||
|
#cas_config:
|
||||||
|
# enabled: true
|
||||||
|
# server_url: "https://cas-server.com"
|
||||||
|
# service_url: "https://homeserver.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
|
||||||
|
# Defining a custom URL for Riot is only needed if email notifications
|
||||||
|
# should contain links to a self-hosted installation of Riot; when set
|
||||||
|
# the "app_name" setting is ignored.
|
||||||
|
#
|
||||||
|
# If your SMTP server requires authentication, the optional smtp_user &
|
||||||
|
# smtp_pass variables should be used
|
||||||
|
#
|
||||||
|
#email:
|
||||||
|
# enable_notifs: false
|
||||||
|
# smtp_host: "localhost"
|
||||||
|
# smtp_port: 25
|
||||||
|
# smtp_user: "exampleusername"
|
||||||
|
# smtp_pass: "examplepassword"
|
||||||
|
# require_transport_security: False
|
||||||
|
# notif_from: "Your Friendly %(app)s Home Server <noreply@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
|
||||||
|
# riot_base_url: "http://localhost/riot"
|
||||||
|
|
||||||
|
|
||||||
|
# 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)"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Clients requesting push notifications can either have the body of
|
||||||
|
# the message sent in the notification poke along with other details
|
||||||
|
# like the sender, or just the event ID and room ID (`event_id_only`).
|
||||||
|
# If clients choose the former, this option controls whether the
|
||||||
|
# notification request includes the content of the event (other details
|
||||||
|
# like the sender are still included). For `event_id_only` push, it
|
||||||
|
# has no effect.
|
||||||
|
|
||||||
|
# For modern android devices the notification content will still appear
|
||||||
|
# because it is loaded by the app. iPhone, however will send a
|
||||||
|
# notification saying only that a message arrived and who it came from.
|
||||||
|
#
|
||||||
|
#push:
|
||||||
|
# include_content: true
|
||||||
|
|
||||||
|
|
||||||
|
# spam_checker:
|
||||||
|
# module: "my_custom_project.SuperSpamChecker"
|
||||||
|
# config:
|
||||||
|
# example_option: 'things'
|
||||||
|
|
||||||
|
|
||||||
|
# Whether to allow non server admins to create groups on this server
|
||||||
|
enable_group_creation: false
|
||||||
|
|
||||||
|
# If enabled, non server admins can only create groups with local parts
|
||||||
|
# starting with this prefix
|
||||||
|
# group_creation_prefix: "unofficial/"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# User Directory configuration
|
||||||
|
#
|
||||||
|
# 'search_all_users' defines whether to search all users visible to your HS
|
||||||
|
# when searching the user directory, rather than limiting to users visible
|
||||||
|
# in public rooms. Defaults to false. If you set it True, you'll have to run
|
||||||
|
# UPDATE user_directory_stream_pos SET stream_id = NULL;
|
||||||
|
# on your database to tell it to rebuild the user_directory search indexes.
|
||||||
|
#
|
||||||
|
#user_directory:
|
||||||
|
# search_all_users: false
|
||||||
|
|
||||||
|
|
||||||
|
# User Consent configuration
|
||||||
|
#
|
||||||
|
# for detailed instructions, see
|
||||||
|
# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md
|
||||||
|
#
|
||||||
|
# Parts of this section are required if enabling the 'consent' resource under
|
||||||
|
# 'listeners', in particular 'template_dir' and 'version'.
|
||||||
|
#
|
||||||
|
# 'template_dir' gives the location of the templates for the HTML forms.
|
||||||
|
# This directory should contain one subdirectory per language (eg, 'en', 'fr'),
|
||||||
|
# and each language directory should contain the policy document (named as
|
||||||
|
# '<version>.html') and a success page (success.html).
|
||||||
|
#
|
||||||
|
# 'version' specifies the 'current' version of the policy document. It defines
|
||||||
|
# the version to be served by the consent resource if there is no 'v'
|
||||||
|
# parameter.
|
||||||
|
#
|
||||||
|
# 'server_notice_content', if enabled, will send a user a "Server Notice"
|
||||||
|
# asking them to consent to the privacy policy. The 'server_notices' section
|
||||||
|
# must also be configured for this to work. Notices will *not* be sent to
|
||||||
|
# guest users unless 'send_server_notice_to_guests' is set to true.
|
||||||
|
#
|
||||||
|
# 'block_events_error', if set, will block any attempts to send events
|
||||||
|
# until the user consents to the privacy policy. The value of the setting is
|
||||||
|
# used as the text of the error.
|
||||||
|
#
|
||||||
|
user_consent:
|
||||||
|
template_dir: res/templates/privacy
|
||||||
|
version: 1.0
|
||||||
|
server_notice_content:
|
||||||
|
msgtype: m.text
|
||||||
|
body: >-
|
||||||
|
To continue using this homeserver you must review and agree to the
|
||||||
|
terms and conditions at %(consent_uri)s
|
||||||
|
send_server_notice_to_guests: True
|
||||||
|
block_events_error: >-
|
||||||
|
To continue using this homeserver you must review and agree to the
|
||||||
|
terms and conditions at %(consent_uri)s
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Server Notices room configuration
|
||||||
|
#
|
||||||
|
# Uncomment this section to enable a room which can be used to send notices
|
||||||
|
# from the server to users. It is a special room which cannot be left; notices
|
||||||
|
# come from a special "notices" user id.
|
||||||
|
#
|
||||||
|
# If you uncomment this section, you *must* define the system_mxid_localpart
|
||||||
|
# setting, which defines the id of the user which will be used to send the
|
||||||
|
# notices.
|
||||||
|
#
|
||||||
|
# It's also possible to override the room name, the display name of the
|
||||||
|
# "notices" user, and the avatar for the user.
|
||||||
|
#
|
||||||
|
server_notices:
|
||||||
|
system_mxid_localpart: notices
|
||||||
|
system_mxid_display_name: "Server Notices"
|
||||||
|
system_mxid_avatar_url: "mxc://localhost:8008/oumMVlgDnLYFaPVkExemNVVZ"
|
||||||
|
room_name: "Server Notices"
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<title>Test Privacy policy</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
{% if has_consented %}
|
||||||
|
<p>
|
||||||
|
Thank you, you've already accepted the license.
|
||||||
|
</p>
|
||||||
|
{% else %}
|
||||||
|
<p>
|
||||||
|
Please accept the license!
|
||||||
|
</p>
|
||||||
|
<form method="post" action="consent">
|
||||||
|
<input type="hidden" name="v" value="{{version}}"/>
|
||||||
|
<input type="hidden" name="u" value="{{user}}"/>
|
||||||
|
<input type="hidden" name="h" value="{{userhmac}}"/>
|
||||||
|
<input type="submit" value="Sure thing!"/>
|
||||||
|
</form>
|
||||||
|
{% endif %}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,9 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<title>Test Privacy policy</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p>Danke schon</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
33
synapse/install.sh
Normal file
33
synapse/install.sh
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# config
|
||||||
|
SYNAPSE_BRANCH=master
|
||||||
|
INSTALLATION_NAME=consent
|
||||||
|
SERVER_DIR=installations/$INSTALLATION_NAME
|
||||||
|
CONFIG_TEMPLATE=consent
|
||||||
|
PORT=8008
|
||||||
|
# set current directory to script directory
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR
|
||||||
|
mkdir -p installations/
|
||||||
|
curl https://codeload.github.com/matrix-org/synapse/zip/$SYNAPSE_BRANCH --output synapse.zip
|
||||||
|
unzip synapse.zip
|
||||||
|
mv synapse-$SYNAPSE_BRANCH $SERVER_DIR
|
||||||
|
pushd $SERVER_DIR
|
||||||
|
virtualenv -p python2.7 env
|
||||||
|
source env/bin/activate
|
||||||
|
pip install --upgrade pip
|
||||||
|
pip install --upgrade setuptools
|
||||||
|
pip install .
|
||||||
|
python -m synapse.app.homeserver \
|
||||||
|
--server-name localhost \
|
||||||
|
--config-path homeserver.yaml \
|
||||||
|
--generate-config \
|
||||||
|
--report-stats=no
|
||||||
|
# apply configuration
|
||||||
|
cp -r $BASE_DIR/config-templates/$CONFIG_TEMPLATE/. ./
|
||||||
|
sed -i "s#{{SYNAPSE_ROOT}}#$(pwd)/#g" homeserver.yaml
|
||||||
|
sed -i "s#{{SYNAPSE_PORT}}#${PORT}/#g" homeserver.yaml
|
||||||
|
sed -i "s#{{FORM_SECRET}}#$(uuidgen)#g" homeserver.yaml
|
||||||
|
sed -i "s#{{REGISTRATION_SHARED_SECRET}}#$(uuidgen)#g" homeserver.yaml
|
||||||
|
sed -i "s#{{MACAROON_SECRET_KEY}}#$(uuidgen)#g" homeserver.yaml
|
||||||
|
popd #back to synapse root dir
|
||||||
|
popd #back to wherever we were
|
||||||
7
synapse/start.sh
Normal file
7
synapse/start.sh
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR
|
||||||
|
pushd installations/consent
|
||||||
|
source env/bin/activate
|
||||||
|
./synctl start
|
||||||
|
popd
|
||||||
|
popd
|
||||||
7
synapse/stop.sh
Normal file
7
synapse/stop.sh
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
BASE_DIR=$(realpath $(dirname $0))
|
||||||
|
pushd $BASE_DIR > /dev/null
|
||||||
|
pushd installations/consent > /dev/null
|
||||||
|
source env/bin/activate
|
||||||
|
./synctl stop
|
||||||
|
popd > /dev/null
|
||||||
|
popd > /dev/null
|
||||||
28
tests/consent.js
Normal file
28
tests/consent.js
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
/*
|
||||||
|
Copyright 2018 New Vector Ltd
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const helpers = require('../helpers');
|
||||||
|
const assert = require('assert');
|
||||||
|
|
||||||
|
module.exports = async function acceptTerms(page) {
|
||||||
|
const reviewTermsButton = await helpers.waitAndQuerySelector(page, '.mx_QuestionDialog button.mx_Dialog_primary', 5000);
|
||||||
|
const termsPagePromise = helpers.waitForNewPage();
|
||||||
|
await reviewTermsButton.click();
|
||||||
|
const termsPage = await termsPagePromise;
|
||||||
|
const acceptButton = await termsPage.$('input[type=submit]');
|
||||||
|
await acceptButton.click();
|
||||||
|
await helpers.delay(500); //TODO yuck, timers
|
||||||
|
}
|
||||||
32
tests/create-room.js
Normal file
32
tests/create-room.js
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
/*
|
||||||
|
Copyright 2018 New Vector Ltd
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const helpers = require('../helpers');
|
||||||
|
const assert = require('assert');
|
||||||
|
|
||||||
|
module.exports = async function createRoom(page, roomName) {
|
||||||
|
//TODO: brittle selector
|
||||||
|
const createRoomButton = await helpers.waitAndQuerySelector(page, '.mx_RoleButton[aria-label="Create new room"]');
|
||||||
|
await createRoomButton.click();
|
||||||
|
|
||||||
|
const roomNameInput = await helpers.waitAndQuerySelector(page, '.mx_CreateRoomDialog_input');
|
||||||
|
await helpers.replaceInputText(roomNameInput, roomName);
|
||||||
|
|
||||||
|
const createButton = await helpers.waitAndQuerySelector(page, '.mx_Dialog_primary');
|
||||||
|
await createButton.click();
|
||||||
|
|
||||||
|
await page.waitForSelector('.mx_MessageComposer');
|
||||||
|
}
|
||||||
44
tests/server-notices-consent.js
Normal file
44
tests/server-notices-consent.js
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
/*
|
||||||
|
Copyright 2018 New Vector Ltd
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const helpers = require('../helpers');
|
||||||
|
const assert = require('assert');
|
||||||
|
|
||||||
|
module.exports = async function acceptServerNoticesInviteAndConsent(page, name) {
|
||||||
|
//TODO: brittle selector
|
||||||
|
const invitesHandles = await helpers.waitAndQueryAll(page, '.mx_RoomTile_name.mx_RoomTile_invite');
|
||||||
|
const invitesWithText = await Promise.all(invitesHandles.map(async (inviteHandle) => {
|
||||||
|
const text = await helpers.innerText(page, inviteHandle);
|
||||||
|
return {inviteHandle, text};
|
||||||
|
}));
|
||||||
|
const inviteHandle = invitesWithText.find(({inviteHandle, text}) => {
|
||||||
|
return text.trim() === name;
|
||||||
|
}).inviteHandle;
|
||||||
|
|
||||||
|
await inviteHandle.click();
|
||||||
|
|
||||||
|
const acceptInvitationLink = await helpers.waitAndQuerySelector(page, ".mx_RoomPreviewBar_join_text a:first-child");
|
||||||
|
await acceptInvitationLink.click();
|
||||||
|
|
||||||
|
const consentLink = await helpers.waitAndQuerySelector(page, ".mx_EventTile_body a", 1000);
|
||||||
|
|
||||||
|
const termsPagePromise = helpers.waitForNewPage();
|
||||||
|
await consentLink.click();
|
||||||
|
const termsPage = await termsPagePromise;
|
||||||
|
const acceptButton = await termsPage.$('input[type=submit]');
|
||||||
|
await acceptButton.click();
|
||||||
|
await helpers.delay(500); //TODO yuck, timers
|
||||||
|
}
|
||||||
|
|
@ -15,6 +15,7 @@ limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const helpers = require('../helpers');
|
const helpers = require('../helpers');
|
||||||
|
const acceptTerms = require('./consent');
|
||||||
const assert = require('assert');
|
const assert = require('assert');
|
||||||
|
|
||||||
module.exports = async function signup(page, username, password, homeserver) {
|
module.exports = async function signup(page, username, password, homeserver) {
|
||||||
|
|
@ -22,11 +23,13 @@ module.exports = async function signup(page, username, password, homeserver) {
|
||||||
const xhrLogs = helpers.logXHRRequests(page);
|
const xhrLogs = helpers.logXHRRequests(page);
|
||||||
await page.goto(helpers.riotUrl('/#/register'));
|
await page.goto(helpers.riotUrl('/#/register'));
|
||||||
//click 'Custom server' radio button
|
//click 'Custom server' radio button
|
||||||
const advancedRadioButton = await helpers.waitAndQuerySelector(page, '#advanced');
|
if (homeserver) {
|
||||||
await advancedRadioButton.click();
|
const advancedRadioButton = await helpers.waitAndQuerySelector(page, '#advanced');
|
||||||
|
await advancedRadioButton.click();
|
||||||
|
}
|
||||||
|
// wait until register button is visible
|
||||||
|
await page.waitForSelector('.mx_Login_submit[value=Register]', {visible: true, timeout: 500});
|
||||||
//fill out form
|
//fill out form
|
||||||
await page.waitForSelector('.mx_ServerConfig', {visible: true, timeout: 500});
|
|
||||||
const loginFields = await page.$$('.mx_Login_field');
|
const loginFields = await page.$$('.mx_Login_field');
|
||||||
assert.strictEqual(loginFields.length, 7);
|
assert.strictEqual(loginFields.length, 7);
|
||||||
const usernameField = loginFields[2];
|
const usernameField = loginFields[2];
|
||||||
|
|
@ -36,7 +39,10 @@ module.exports = async function signup(page, username, password, homeserver) {
|
||||||
await helpers.replaceInputText(usernameField, username);
|
await helpers.replaceInputText(usernameField, username);
|
||||||
await helpers.replaceInputText(passwordField, password);
|
await helpers.replaceInputText(passwordField, password);
|
||||||
await helpers.replaceInputText(passwordRepeatField, password);
|
await helpers.replaceInputText(passwordRepeatField, password);
|
||||||
await helpers.replaceInputText(hsurlField, homeserver);
|
if (homeserver) {
|
||||||
|
await page.waitForSelector('.mx_ServerConfig', {visible: true, timeout: 500});
|
||||||
|
await helpers.replaceInputText(hsurlField, homeserver);
|
||||||
|
}
|
||||||
//wait over a second because Registration/ServerConfig have a 1000ms
|
//wait over a second because Registration/ServerConfig have a 1000ms
|
||||||
//delay to internally set the homeserver url
|
//delay to internally set the homeserver url
|
||||||
//see Registration::render and ServerConfig::props::delayTimeMs
|
//see Registration::render and ServerConfig::props::delayTimeMs
|
||||||
|
|
@ -57,20 +63,8 @@ module.exports = async function signup(page, username, password, homeserver) {
|
||||||
await continueButton.click();
|
await continueButton.click();
|
||||||
//wait for registration to finish so the hash gets set
|
//wait for registration to finish so the hash gets set
|
||||||
//onhashchange better?
|
//onhashchange better?
|
||||||
await helpers.delay(1000);
|
await helpers.delay(2000);
|
||||||
/*
|
|
||||||
await page.screenshot({path: "afterlogin.png", fullPage: true});
|
|
||||||
console.log('browser console logs:');
|
|
||||||
console.log(consoleLogs.logs());
|
|
||||||
console.log('xhr logs:');
|
|
||||||
console.log(xhrLogs.logs());
|
|
||||||
*/
|
|
||||||
|
|
||||||
|
|
||||||
//printElements('page', await page.$('#matrixchat'));
|
|
||||||
// await navigation_promise;
|
|
||||||
|
|
||||||
//await page.waitForSelector('.mx_MatrixChat', {visible: true, timeout: 3000});
|
|
||||||
const url = page.url();
|
const url = page.url();
|
||||||
assert.strictEqual(url, helpers.riotUrl('/#/home'));
|
assert.strictEqual(url, helpers.riotUrl('/#/home'));
|
||||||
}
|
}
|
||||||
Loading…
Reference in a new issue