Skip to content

Skyedra/discourse-mumble

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mumble plugin for Discourse

A 2024 revival of nunof07's discourse-mumble plugin.

Discourse Mumble Plugin Screenshot

Mumble Viewer plugin for Discourse that displays channel and user information.

  • Discourse is an open source discussion platform.
  • Mumble is an open source voice chat software.

New Features

I have added the following new features:

  • Compatability with Discourse's changes to how the header is rendered, so it can run on 2024 Discourse
  • Show mute or deafened status in user list.
  • Include connection info to guide user on how to install Mumble and connect to your server.
  • Optional ability to set a time when your group meets every day, this will be converted to the local time and shown to the user.
  • Increase polling updates to every 20 seconds.
  • For better or worse, I rewrote almost the whole javascript frontend part of this. I do not know much about Discourse coding or anything about Glimmer, so I am sure I wrote it in a sub-optimal way. Further forking and improvement is welcomed :)

Old Features

The plugin adds a button to the header.

  • The button displays the number of users connected to the Mumble server.
  • Clicking the button opens a menu with the list of channels and users.
  • Idle users have a toned down icon.
  • Information is refreshed periodically (configurable).

Backend

The Mumble server needs to support the Channel Viewer Protocol. Most Mumble servers support this. If you manage your own server you can install a 3rd party application to do this.

(Currently the mumble wiki is down, but the above links are still available via Way Back Machine)

The CVP server I used specifically was mumble-fastapi -- however, be warned that as of 11/6/24 the author has not updated their docker image to be in sync with the repo. This means the CVP can't connect to the latest mumble version.
Fortunately, the author updated the github repo with a fix, so it's just a matter of pulling the github repo and rebuilding the docker file.

I have some general Mumble install tips / configs that may be helpful to you if you are setting up a Mumble server for the first time.

How to install

Follow the guide on how to Install a Plugin for Discourse but add this repository URL instead.

Then go to Admin > Plugins and choose Mumble settings:

  • mumble_interval: the interval between information refreshes
  • mumble_cvp: the URL to the Channel Viewer Protocol service
  • mumble_xml: whether the URL to the CVP service is for XML, otherwise will use JSON

NOTE: I have found that the plugin likes to be installed into the 'mumble' folder for the settings to show up when you click settings in the admin panel plugins list. So you may wish to use the syntax in your app.yml to add 'mumble' at the end (sudo -E -u discourse git clone <url> mumble)

Contributors

About

Mumble Viewer plugin for Discourse

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 78.6%
  • Ruby 15.9%
  • SCSS 5.5%