Github/ocrcc-chatbox
1
0
Fork 1
mirror of https://github.com/Safe-Support-Chat/ocrcc-chatbox synced 2024-11-01 00:55:26 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/nomadic-labs/ocrcc-chatbox

Browse Source
This commit is contained in:
Sharon Kennedy 2020-03-22 11:07:49 -04:00
commit 8eee18ab44
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -10,18 +10,25 @@ Built on:
```
<script src="./chatbox.js"></script>
<script>
EmbeddableChatbox.mount({ matrixServerUrl: "https://matrix.org" });
EmbeddableChatbox.mount({
matrixServerUrl: "https://matrix.rhok.space",
botUsername: "@help-bot:rhok.space"
});
</script>
```
Options:
| Name | Description | Default
| ----------- | ----------- | --------- |
| `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://www.matrix.org` |
| `userToInvite` (required) | Username of the account that should be invited when a new chat is started | `null` |
| `termsUrl` (optional) | URL for the Terms of Use for the chat service | `null` |
| `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://matrix.rhok.space` |
| `botId` (required) | User ID for the bot account that handles invites | `@help-bot:rhok.space` |
| `introMessage` (optional) | First message the user sees before agreeing to the Terms of Use | `This chat application does not collect any of your personal data or any data from your use of this service.` |
| `termsUrl` (optional) | URL for the Terms of Use for the chat service | `https://tosdr.org/` |
| `roomName` (optional) | Name of the chatroom generated in Riot | 'Support Chat' |
| `introText` (optional) | Text to be shown before the Terms of Use url | `null` |
| `agreementText` (optional) | Text to be shown to ask for agreement to continue | `null` |
| `agreementMessage` (optional) | Text to show to request agreement to the Terms of Use | `Do you want to continue?` |
| `confirmationMessage` (optional) | Text to show to ask for agreement to continue | `Waiting for a facilitator to join the chat...` |
| `exitMessage` (optional) | Text to show if the user rejects the Terms of Use. | `The chat is closed. You may close this window.` |
| `anonymousDisplayName` (optional) | The display name for the chat user. | `Anonymous` |
| `chatUnavailableMessage` (optional) | Text to show if no-one is available to respond | `The chat service is not available right now. Please try again later.` |
## Local development