chatbridge/README.md

# chatbridge

Like guppe groups but for slack, discord, matrix, etc.

Invite people to a matterbridge group with a token

Using matterbridge - https://github.com/42wim/matterbridge

Very unfinished!! Mostly a programming exercise for me for now to practice fullstack. Theoretically it should be possible to reuse this but i make no guarantees especially while it is yno unfinished and potentially insecure. run at your own risk!

## TODO

- [x] Manage matterbridge processes
- [ ] Sanitize user inputs
- [ ] Check status of matterbridge processes
- [x] Complete slack login workflow
- [ ] Kill group processes & delete config when group is deleted

## Supported Clients 

(the ones that can use the website to join)

- [Slack](#Slack)
- [Discord](#Discord)

### Slack

- Set up Slack App with old style bot according to matterbridge instructions: https://github.com/42wim/matterbridge/wiki/Slack-bot-setup
- Configure slack app to use the callback API url: `<yourdomain.etc.>/api/slack/oauth_redirect`
- Set your `.env` variables!

### Discord

- Set up Discord App according to matterbridge instructions: https://github.com/42wim/matterbridge/wiki/Discord-bot-setup
- Additionally enable "[Requires OAUTH2 Code Grant](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization)" in your bot's authorization flow settings
- Set the redirect URL to `<yourdomain.etc>/api/discord/oauth_redirect`

## Deployment

Use the ansible role!!!


## References

idk i'm just learnin

- https://typeorm.io/active-record-data-mapper#what-is-the-active-record-pattern
  - https://typeorm.io/example-with-express
- https://github.com/wpcodevo/node_typeorm/tree/restapi-node-typeorm
- https://www.axllent.org/docs/nodejs-service-with-systemd/
- https://github.com/wpcodevo/Blog_MUI_React-hook-form/tree/login-signup-form
- https://blog.alexdevero.com/build-react-app-express-api/
- https://www.react.express/
- https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
	- https://www.typescriptlang.org/docs/handbook/compiler-options.html
- https://galaxy.ansible.com/jwflory/matterbridge
Basic ansible role for installation and some skeleton structure for the server app 2023-07-24 20:27:36 +00:00			`# chatbridge`
Initial commit 2023-07-21 02:40:32 +00:00
Warnings in readme Add some warning ssince I mirrored it to my github 2023-07-26 06:52:15 +00:00			`Like guppe groups but for slack, discord, matrix, etc.`
working group controller 2023-07-25 01:40:22 +00:00
Warnings in readme Add some warning ssince I mirrored it to my github 2023-07-26 06:52:15 +00:00			`Invite people to a matterbridge group with a token`
empty 2023-07-21 04:06:30 +00:00
			`Using matterbridge - https://github.com/42wim/matterbridge`

Warnings in readme Add some warning ssince I mirrored it to my github 2023-07-26 06:52:15 +00:00			`Very unfinished!! Mostly a programming exercise for me for now to practice fullstack. Theoretically it should be possible to reuse this but i make no guarantees especially while it is yno unfinished and potentially insecure. run at your own risk!`
empty 2023-07-21 04:06:30 +00:00
process manager draft 2023-07-27 02:06:38 +00:00			`## TODO`

discord is working 2023-08-04 02:42:05 +00:00			`- [x] Manage matterbridge processes`
process manager draft 2023-07-27 02:06:38 +00:00			`- [ ] Sanitize user inputs`
			`- [ ] Check status of matterbridge processes`
discord is working 2023-08-04 02:42:05 +00:00			`- [x] Complete slack login workflow`
working on discord 2023-08-02 03:13:11 +00:00			`- [ ] Kill group processes & delete config when group is deleted`
process manager draft 2023-07-27 02:06:38 +00:00
empty 2023-07-21 04:06:30 +00:00			`## Supported Clients`

			`(the ones that can use the website to join)`

			`- [Slack](#Slack)`
Starting on discord, switching to remote env 2023-08-02 02:06:25 +00:00			`- [Discord](#Discord)`
empty 2023-07-21 04:06:30 +00:00
			`### Slack`

Starting on discord, switching to remote env 2023-08-02 02:06:25 +00:00			`- Set up Slack App with old style bot according to matterbridge instructions: https://github.com/42wim/matterbridge/wiki/Slack-bot-setup`
			- Configure slack app to use the callback API url: `<yourdomain.etc.>/api/slack/oauth_redirect`
			- Set your `.env` variables!
empty 2023-07-21 04:06:30 +00:00
Starting on discord, switching to remote env 2023-08-02 02:06:25 +00:00			`### Discord`

			`- Set up Discord App according to matterbridge instructions: https://github.com/42wim/matterbridge/wiki/Discord-bot-setup`
			`- Additionally enable "[Requires OAUTH2 Code Grant](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization)" in your bot's authorization flow settings`
			- Set the redirect URL to `<yourdomain.etc>/api/discord/oauth_redirect`
empty 2023-07-21 04:06:30 +00:00
			`## Deployment`

			`Use the ansible role!!!`
some notes on project structure and deps 2023-07-21 09:06:16 +00:00

			`## References`

			`idk i'm just learnin`
Basic ansible role for installation and some skeleton structure for the server app 2023-07-24 20:27:36 +00:00
			`- https://typeorm.io/active-record-data-mapper#what-is-the-active-record-pattern`
			`- https://typeorm.io/example-with-express`
some notes on project structure and deps 2023-07-21 09:06:16 +00:00			`- https://github.com/wpcodevo/node_typeorm/tree/restapi-node-typeorm`
			`- https://www.axllent.org/docs/nodejs-service-with-systemd/`
			`- https://github.com/wpcodevo/Blog_MUI_React-hook-form/tree/login-signup-form`
			`- https://blog.alexdevero.com/build-react-app-express-api/`
			`- https://www.react.express/`
			`- https://www.typescriptlang.org/docs/handbook/tsconfig-json.html`
Basic ansible role for installation and some skeleton structure for the server app 2023-07-24 20:27:36 +00:00			`- https://www.typescriptlang.org/docs/handbook/compiler-options.html`
Warnings in readme Add some warning ssince I mirrored it to my github 2023-07-26 06:52:15 +00:00			`- https://galaxy.ansible.com/jwflory/matterbridge`