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.

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

Make the default port (8090) documented and used consistently #1427

Merged
merged 4 commits into from
Nov 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions Dockerfile.README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespaces:
aliases:
- exclusive: true
regex: '#irc_.*:localhost' # localhost should be your homeserver's server_name
url: 'http://localhost:9999'
url: 'http://localhost:8090'
sender_localpart: irc_bot
rate_limited: false
protocols:
Expand All @@ -39,4 +39,4 @@ If you are storing passwords for users, you should also run:
openssl genpkey -out ./dockerdata/passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048
```

You can now run your shiny new image using `docker run --publish 9999:9999 --volume $PWD/dockerdata:/app/data`.
You can now run your shiny new image using `docker run --publish 8090:8090 --volume $PWD/dockerdata:/app/data`.
1 change: 1 addition & 0 deletions changelog.d/1427.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document 8090 to be the default port, to match the code's behaviour.
2 changes: 1 addition & 1 deletion config.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ homeserver:

# Which port should the appservice bind to. Can be overriden by the one provided in the
# command line! Optional.
# bindPort: 9999
# bindPort: 8090

# Use this option to force the appservice to listen on another hostname for transactions.
# This is NOT your synapse hostname. E.g. use 127.0.0.1 to only listen locally. Optional.
Expand Down
2 changes: 1 addition & 1 deletion docker/start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ then
ip route add local $PREFIX dev lo
fi

exec node app.js -c /data/config.yaml -p 9999 -f /data/appservice-registration-irc.yaml -u http://localhost:9999
exec node app.js -c /data/config.yaml -p 8090 -f /data/appservice-registration-irc.yaml -u http://localhost:8090
10 changes: 5 additions & 5 deletions docs/bridge_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ homeserver which Matrix events the bridge should receive.
Execute the following command:

```
node app.js -r -f appservice-registration-irc.yaml -u "http://localhost:9999" -c config.yaml -l my_bot
node app.js -r -f appservice-registration-irc.yaml -u "http://localhost:8090" -c config.yaml -l my_bot
```

Change `-u "http://localhost:9999"` to wherever your Matrix server can contact this IRC bridge.
Change `-u "http://localhost:8090"` to wherever your Matrix server can contact this IRC bridge.
By changing the option `-l my_bot` you can modify the localpart of the bridge bot user. It contacts
Matrix users of your bridge to control their usage of the bridge (e.g. to change their nickname).

Expand All @@ -96,7 +96,7 @@ namespaces:
aliases:
- exclusive: true
regex: '#irc_.*:yourhomeserverdomain'
url: 'http://localhost:9999'
url: 'http://localhost:8090'
sender_localpart: appservice-irc
rate_limited: false
protocols:
Expand All @@ -119,12 +119,12 @@ app_service_config_files: ["appservice-registration-irc.yaml"]
Finally, the bridge can be run using the following command:

```
$ node app.js -c config.yaml -f appservice-registration-irc.yaml -p 9999
$ node app.js -c config.yaml -f appservice-registration-irc.yaml -p 8090
```

Or for Docker:

```
# Remember to expose ports for metrics, debug API if you need to.
docker run --volume $PWD/data:/data --publish 9999 matrixdotorg/matrix-appservice-irc
docker run --volume $PWD/data:/data --publish 8090 matrixdotorg/matrix-appservice-irc
```