Skip to content
This repository has been archived by the owner on May 18, 2022. It is now read-only.

Add info on ssb-room to README #149

Merged
merged 2 commits into from
Feb 1, 2021
Merged

Conversation

KyleMaas
Copy link
Collaborator

@KyleMaas KyleMaas commented Feb 1, 2021

Adds information to the README for how to add WebSockets support to ssb-room. See #145.

(Going to try to upstream this as well, but at least for now it would be publicly documented.)

README.md Outdated

To run an ssb-room which this can connect to, you will need to enable WebSockets support. This requires three things:

1. Add a line to `connections` so configure the WebSockets port (external, key, and cert need to be customized for your installation):
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so configure -> to configure. And this probably needs to a bit more information about where this connections can be found. Might be good to explain that the key and cert are only needed for secure web sockets.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How's that look?

@KyleMaas
Copy link
Collaborator Author

KyleMaas commented Feb 1, 2021

Upstreamed configuration here:

staltz/ssb-room#27

@arj03
Copy link
Owner

arj03 commented Feb 1, 2021

Thanks

@arj03 arj03 merged commit e51a380 into arj03:master Feb 1, 2021
@KyleMaas KyleMaas deleted the add-server-to-readme branch February 1, 2021 14:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants