Github/safesupport-chatbox
1
0
Fork 1
mirror of https://github.com/nomadic-labs/safesupport-chatbox synced 2024-11-14 22:55:06 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Sharon Kennedy 2020-05-07 10:50:54 -04:00
parent ec22cb8585
commit 4cccd21f46
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,7 +2,7 @@
![Demo video of chatbox](https://media.giphy.com/media/IhmtP0NoG22k6FRQDF/giphy.gif) ![Demo video of chatbox](https://media.giphy.com/media/IhmtP0NoG22k6FRQDF/giphy.gif)
Live demo: https://nomadic-labs.github.io/safesupport-chatbox/ Live demo: https://safesupport.chat
Built on: Built on:
- [Embeddable React Widget](https://github.com/seriousben/embeddable-react-widget) - [Embeddable React Widget](https://github.com/seriousben/embeddable-react-widget)
@ -13,8 +13,8 @@ Built on:
<script src="https://unpkg.com/safesupport-chatbox" type="text/javascript"></script> <script src="https://unpkg.com/safesupport-chatbox" type="text/javascript"></script>
<script> <script>
var config = { var config = {
matrixServerUrl: 'https://matrix.rhok.space', matrixServerUrl: 'https://matrix-client.matrix.org',
botId: '@help-bot:rhok.space', botId: '@your-help-bot:matrix.org',
roomName: 'Support Chat', roomName: 'Support Chat',
termsUrl: 'https://tosdr.org/', termsUrl: 'https://tosdr.org/',
introMessage: 'This chat application does not collect any of your personal data or any data from your use of this service.', introMessage: 'This chat application does not collect any of your personal data or any data from your use of this service.',
@ -31,8 +31,8 @@ Built on:
Options: Options:
| Name | Description | Default | Name | Description | Default
| ----------- | ----------- | --------- | | ----------- | ----------- | --------- |
| `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://matrix.rhok.space` | | `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://matrix-client.matrix.org` |
| `botId` (required) | User ID for the bot account that handles invites | `@help-bot:rhok.space` | | `botId` (required) | User ID for the bot account that handles invites | null |
| `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.` | | `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/` | | `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' | | `roomName` (optional) | Name of the chatroom generated in Riot | 'Support Chat' |
@ -50,7 +50,7 @@ Options:
- [x] Support seekers are anonymous - [x] Support seekers are anonymous
- [x] Uses Matrix's end to end encryption - [x] Uses Matrix's end to end encryption
- [x] If encryption fails, falls back to unencrypted chat - [x] If encryption fails, falls back to unencrypted chat
- [x] Status texts are customizeable - [x] Status notifications are customizeable
- [x] Only initiates chat after user agrees to Terms of Service - [x] Only initiates chat after user agrees to Terms of Service
- [x] Upon exiting chat, user data is wiped - account deleted, local datastore cleared - [x] Upon exiting chat, user data is wiped - account deleted, local datastore cleared
- [x] If enabled, the bot account can provide transcript of the conversation - [x] If enabled, the bot account can provide transcript of the conversation
@ -74,7 +74,7 @@ You can find the code for the bot at [safesupport-bot](https://github.com/nomadi
The bookmarklet is a special link that runs a script on any website. The user saves the link by dragging it to their bookmarks bar. Then they can click on the bookmark on any page to run the script and load the chatbox. The bookmarklet is a special link that runs a script on any website. The user saves the link by dragging it to their bookmarks bar. Then they can click on the bookmark on any page to run the script and load the chatbox.
You can try this out on the [live demo](https://nomadic-labs.github.io/safesupport-chatbox/). You can try this out on the [live demo](https://safesupport.chat/).
## Local development ## Local development
@ -95,6 +95,8 @@ yarn start
Open the demo page at http://localhost:9000/ Open the demo page at http://localhost:9000/
Don't forget to also set up the bot account, otherwise you'll never get the chat invitations on Riot. Follow the instructions at [safesupport-bot](https://github.com/nomadic-labs/safesupport-bot).
## Production build ## Production build
``` ```
yarn build yarn build