docs: tweaks install instructions re: port

[debuggingfuture]

Hi first of all thanks for this great life-saver project!

I installed this to my server recently, some feedback regarding the docs

my setup env:

• terraform to provision homeserver/this bridge
• docker-compose on ec2
• db: rds

feedback re: port

• I spent sometime to understand the port to be used. It is more obvious when I read the log of runnable process and check the source code. According to https://github.com/matrix-org/matrix-appservice-slack/issues/436 the default port is 5858, shall we provide in the instruction as well? (as changed in this PR)

• I understand it is the port homeserver will connect to, while the name MATRIX_PORT sounds a port homeserver is listening to. Potentially HOMESERVER_PORT SYNAPSE_PORT are more specific?

• By "specify the direct link", and generating the config with docker, it might not be too obvious that if refers to the "url field" in the config yml when I decided to modify directly. (added a note in this PR)

• changed the file name as slack-registration.yaml is the recommended name, not slack.yaml

re: /link

• Probably there are other issues pointing to this already. I was confused link to be a /link command and struggled when it didnt show up. There are nice feedback on the correctness of commands once the appservice is installed, so we can probably hint user to look for this to hint whether it is problem of appservice process or problem of access configurations.

re:slack token (link_channels.md)

• Seems there are some changes on slack side, so if we "Select bot token scopes", it will not work with below warning The RTM API is not accessible to updated Bot Tokens. If your app requires RTM functionality, please exit this update and continue using your existing scopes.
• instead I chose First, add a legacy bot user to make it work, without further changing its scopes
• I think screenshots could greatly help, I can create some in another PR

some thoughts for terraform/docker-compose

• I found out https://github.com/spantaleev/matrix-docker-ansible-deploy only after I have done the deployment. Shall we add a link to that repo?

• Will a sample terraform/ docker-compose sample of interest? There are some networking tweaks e.g. listen to "http://appservice:5858" instead of localhost, tweaking the volumes mount point etc

Signed-off-by: Vincent Lau [email protected]

[Half-Shot]

ping @vincentlaucy

[jaller94]

@Half-Shot Do we need to insist on the Sign-Off?

@vincentlaucy To ensure all code in this project has the same license, please modify the following line and add it to the PR description: Signed-off-by: Your Name <[email protected]> More info: https://github.com/matrix-org/synapse/blob/v1.4.0/CONTRIBUTING.rst#sign-off

[Half-Shot]

@Half-Shot Do we need to insist on the Sign-Off?

@vincentlaucy To ensure all code in this project has the same license, please modify the following line and add it to the PR description: Signed-off-by: Your Name <[email protected]> More info: https://github.com/matrix-org/synapse/blob/v1.4.0/CONTRIBUTING.rst#sign-off

Yep, we do!

[debuggingfuture]

Thanks appended the issue with sign off

[zhubonan]

Hi it would be great to have this merged. I have been following the current docs and using docker to setup but it did not work out right, mainly due to the port configuration and the default name of the registration file.

I managed to solve the issues eventually but then I found the changes I needed are all in this PR. 😂

The other thing I found is that to use a custom port (other than 5858) the docker has to run with the -p option explicitly, just like the system installed approach.