diff --git a/changelog.d/573.doc b/changelog.d/573.doc new file mode 100644 index 00000000..f18afd91 --- /dev/null +++ b/changelog.d/573.doc @@ -0,0 +1 @@ +Improve installation instructions diff --git a/docs/getting_started.md b/docs/getting_started.md index 7b2be7d9..95b9706d 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -50,7 +50,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. By default, this is 5858. @@ -65,12 +65,14 @@ 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. When using bridge in Docker container: For `appservice_port`, enter the value of `$MATRIX_PORT`, unless it is `5858`, which is 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):