Discourse - TeamSpeak 3 Server Bridge

Getting started

This Bridge Server syncs specified user groups from the Discourse Board to the TeamSpeak 3 Server. The server runs a cronjob every 5 minutes to sync both servers. This server is in early dev stage but it is fully working. On server start the server will create a database file which has to be filled by you. It is a pivot table which contains the Group_ID of Discourse and TeamSpeak3.

Small Note

By default this project can be accessed by everybody. This is OK if you have it only running locally but if you deploy it on a server which is accessible from the web you have to make sure that this project is protected (e.g. with Basic Auth)!

Docker

You can simply pull the provided docker image.

svenc56/discourse-teamspeak-bridge

Please add the following environment variables depending on your setup:

• Example

Installing

1.) Install dependencies:

$ yarn install

2.) Configure Environment Variables

Edit the .env.example file with your data.

3.) Install the Dataexplorer Plugin in Discourse.

4.) Add the following query:

-- [params]
-- string :custom_field_name

SELECT
   u.id AS user_id,
   u.username AS username,
   g.id AS group_id,
   ucf.value  AS user_field_value
FROM
   users u
   JOIN user_custom_fields ucf
         ON ucf.user_id = u.id
   join
      group_users gu
      ON gu.user_id = u.id
   join
      GROUPS g
      ON g.id = gu.group_id
WHERE  ucf.name = :custom_field_name
       AND ucf.value <> ''
ORDER BY g.id

4.1.) Note the ID of the created query. This is the DISCOURSE_USER_LIST_QUERY_ID variable.

5.) Create a custom Field in Discourse for the TeamSpeak UID.

6.) Then you have to know which userfield name you are searching for.

This query will help you:

SELECT * FROM user_custom_fields

6.1) The userfield will look like this: user_field_X. This is the DISCOURSE_CUSTOM_FIELD_NAME variable.

Database

After starting the container you will have to run yarn db:migration:deploy or npm run db:migration:deploy to run the database migrations.

Note: The connection string will look like this: DATABASE_URL="mysql://USER:PASSWORD@HOST:PORT/DATABASE"

API Documentation

This application has a full API description available under: /api/swagger

Deployment

$ yarn start:dev

Built With

• Nest.js

Authors

• SvenC56 - SvenC56

License

This project is licensed under the MIT License - see the LICENSE file for details