https://github.com/bigbluebutton/custom-feedback

https://github.com/bigbluebutton/custom-feedback

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bigbluebutton/custom-feedback
• Owner: bigbluebutton
• License: lgpl-3.0
• Created: 2024-08-05T18:46:54.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2026-01-28T13:02:53.000Z (4 months ago)
• Last Synced: 2026-01-29T05:37:52.814Z (4 months ago)
• Language: JavaScript
• Size: 419 KB
• Stars: 0
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Customizable BigBlueButton feedback form

This project offers a customizable feedback solution that can be easily integrated into any other application via a redirect URL. It consists of an intuitive user interface (front-end) and an HTTP server (back-end) that handles webhooks to collect meeting and user data.

Compatible with Bigbluebutton >= 3.0

    Package coming soon

## Project Structure

### Front-end

The front-end is responsible for the entire user interface. It allows users to interact with the feedback system in a user-friendly and efficient manner.

Additional feedback options can be added or existing options can be modified via the feedbackData.json file. This file is mapped to render the feedback options and steps.

### Back-end

The back-end is an HTTP server that listens for webhooks and collects data on meetings and users. This data is processed and stored in the server's database.

At the end of the feedback process, the HTTP server receives the feedback data and data extracted from the URL, which contains meetingId and userId, and will be used to find their corresponding records in the server's database.

## Running with docker-compose

    docker-compose up

Changes the docker-compose.yml to fit your use case. **Note:** Ensure there are no spaces between the variable name and the equals sign (e.g., `VAR=value`, not `VAR = value`).

    FEEDBACK_URL (optional)

      Where to submit the feedback object. With no URL results will be exclusivelly logged

    SHARED_SECRET

      Your server's shared secret used to register web hooks

    BASIC_URL

      Domain of your server without the /bigbluebutton/

    REDIRECT_URL (optional)

      Where to redirect user after the feedback form. Can also be set by `userdata-feedbackredirecturl` or `metadata_feedbackredirecturl`

    REDIRECT_TIMEOUT

      default: 10000

    LOG_LEVEL

      default: info

      valid values: error, debug, info, verbose

    LOG_STDOUT

      default: true

    PORT

      default: 3009

## Deploying to Production

After spinning up the back-end server you'll need to drop this nginx file on your server:

```

/usr/share/bigbluebutton/feedback.nginx

location /feedback {

        proxy_pass http://localhost:3009/feedback;

}

```

Configure `bbb-web` to redirect logged out users to the custom feedback application after they leave the meeting:

The correct value should be https://YOUR_BBB_HOST/feedback?userId=%%USERID%%&meetingId=%%MEETINGID%%

* Edit `logoutURL` in `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`

* Or create your meeting with `logoutURL`

* Or send it via `userdata-logoutURL`

## Customizing the feedback form

Consult the example JSON feedback form for more details: [feedbackData.json](frontend/src/feedbackData.json).

## License

This project is licensed under the GNU Lesser General Public License v3.0 - see the [LICENSE](./LICENSE) file for details.