Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tweaks install instructions re: port #573

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

docs: tweaks install instructions re: port #573

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9ff03a0
docs: tweaks install instructions re: port
debuggingfuture Mar 1, 2021
318e674
Update docs/getting_started.md
jaller94 Feb 14, 2022
5753de4
Update docs/getting_started.md
jaller94 Feb 14, 2022
7439a92
Update getting_started.md
Feb 14, 2022
9204100
Create 573.doc
Feb 14, 2022
e514246
Update docs/getting_started.md
Feb 14, 2022
7fb24e7
Merge branch 'develop' into vincentlaucy/setup-doc-port
tadzik Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/573.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve installation instructions
8 changes: 5 additions & 3 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 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
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):
Expand All @@ -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:
Expand Down