From 9ff03a01f0b840e3d5fa496177e966ae476b0c82 Mon Sep 17 00:00:00 2001 From: vincentlaucy Date: Mon, 1 Mar 2021 11:57:26 +0800 Subject: [PATCH 1/6] docs: tweaks install instructions re: port --- docs/getting_started.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 60617cb34..e5c9b4434 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -51,7 +51,7 @@ ever stuck, you can post a question in the 1. Create a new Matrix room to act as the administration control room. Note its internal room ID (Example: !abcdefg12345hijk:coolserver.com). -1. Decide on a spare local TCP port number to use. It will listen for messages +1. Decide on a spare local TCP port number to use. The Default is 5858. It will listen for messages from Matrix and needs to be visible to the homeserver. Take care to configure firewalls appropriately. This port will be notated as `$MATRIX_PORT` in the remaining instructions. @@ -66,9 +66,11 @@ ever stuck, you can post a question in the 1. For `matrix_admin_room`, enter the internal room ID of the administration control room (Example: !abcdefg12345hijk:coolserver.com). + + 1. For `homeserver.appservice_port`, specify the above $MATRIX_PORT if you would like to override 1. Generate the appservice registration file. This will be used by the - Matrix homeserver. Here, you must specify the direct link the + Matrix homeserver. Here, you must specify the direct link (the field url) the **Matrix Homserver** can use to access the bridge, including the Matrix port it will send messages through (if this bridge runs on the same machine you can use `localhost` as the `$HOST` name): @@ -78,7 +80,7 @@ ever stuck, you can post a question in the ```sh $ docker run -v /path/to/config/:/config/ matrixdotorg/matrix-appservice-slack \ - -r -c /config/config.yaml -u "http://$HOST:$MATRIX_PORT" -f /config/slack.yaml + -r -c /config/config.yaml -u "http://$HOST:$MATRIX_PORT" -f /config/slack-registration.yaml ``` 1. Start the actual application service: From 318e6743a412cbfc1e77d8aeda15fc0aaea56444 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Tue, 15 Feb 2022 00:05:49 +0100 Subject: [PATCH 2/6] Update docs/getting_started.md Co-authored-by: Will Hunt --- docs/getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index e5c9b4434..07eecd29a 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -51,7 +51,7 @@ ever stuck, you can post a question in the 1. Create a new Matrix room to act as the administration control room. Note its internal room ID (Example: !abcdefg12345hijk:coolserver.com). -1. Decide on a spare local TCP port number to use. The Default is 5858. It will listen for messages +1. Decide on a spare local TCP port number to use. The default is 5858. It will listen for messages from Matrix and needs to be visible to the homeserver. Take care to configure firewalls appropriately. This port will be notated as `$MATRIX_PORT` in the remaining instructions. From 5753de44a14c7b5c36c6086513f7b8489256cdd5 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Tue, 15 Feb 2022 00:05:55 +0100 Subject: [PATCH 3/6] Update docs/getting_started.md Co-authored-by: Will Hunt --- docs/getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 07eecd29a..8fded355a 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -70,7 +70,7 @@ ever stuck, you can post a question in the 1. For `homeserver.appservice_port`, specify the above $MATRIX_PORT if you would like to override 1. Generate the appservice registration file. This will be used by the - Matrix homeserver. Here, you must specify the direct link (the field url) the + Matrix homeserver. Here, you must specify the direct link (the url field) the **Matrix Homserver** can use to access the bridge, including the Matrix port it will send messages through (if this bridge runs on the same machine you can use `localhost` as the `$HOST` name): From 7439a924ccbcc1197d544543f723e28301d1bdf3 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Tue, 15 Feb 2022 00:06:35 +0100 Subject: [PATCH 4/6] Update getting_started.md --- docs/getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 8fded355a..9f6e5223d 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -51,7 +51,7 @@ ever stuck, you can post a question in the 1. Create a new Matrix room to act as the administration control room. Note its internal room ID (Example: !abcdefg12345hijk:coolserver.com). -1. Decide on a spare local TCP port number to use. The default is 5858. It will listen for messages +1. Decide on a spare local TCP port number to use. The default is 5858. It will listen for messages from Matrix and needs to be visible to the homeserver. Take care to configure firewalls appropriately. This port will be notated as `$MATRIX_PORT` in the remaining instructions. From 92041005f6bc62d92589b625d1c18042625eeb17 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Tue, 15 Feb 2022 00:15:41 +0100 Subject: [PATCH 5/6] Create 573.doc --- changelog.d/573.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/573.doc diff --git a/changelog.d/573.doc b/changelog.d/573.doc new file mode 100644 index 000000000..f18afd912 --- /dev/null +++ b/changelog.d/573.doc @@ -0,0 +1 @@ +Improve installation instructions From e514246d8670022e86c665f8c8a50a9214b06058 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Tue, 15 Feb 2022 00:16:35 +0100 Subject: [PATCH 6/6] Update docs/getting_started.md --- docs/getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 9f6e5223d..bbbf63044 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -67,7 +67,7 @@ ever stuck, you can post a question in the 1. For `matrix_admin_room`, enter the internal room ID of the administration control room (Example: !abcdefg12345hijk:coolserver.com). - 1. For `homeserver.appservice_port`, specify the above $MATRIX_PORT if you would like to override + 1. For `homeserver.appservice_port`, specify the above $MATRIX_PORT if you overwrote the default. 1. Generate the appservice registration file. This will be used by the Matrix homeserver. Here, you must specify the direct link (the url field) the