{"id":30197821,"url":"https://github.com/bigbluebutton/plugin-tour","last_synced_at":"2025-08-13T06:40:10.793Z","repository":{"id":274455402,"uuid":"820829633","full_name":"bigbluebutton/plugin-tour","owner":"bigbluebutton","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-11T19:05:04.000Z","size":1943,"stargazers_count":3,"open_issues_count":1,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-08-08T09:55:50.577Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigbluebutton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-27T09:03:24.000Z","updated_at":"2025-07-10T18:24:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"e7162f25-9815-465b-ab34-f2789281da3b","html_url":"https://github.com/bigbluebutton/plugin-tour","commit_stats":null,"previous_names":["bigbluebutton/bigbluebutton-plugin-tour","bigbluebutton/plugin-tour"],"tags_count":1,"template":false,"template_full_name":"bigbluebutton/plugin-template","purl":"pkg:github/bigbluebutton/plugin-tour","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbluebutton%2Fplugin-tour","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbluebutton%2Fplugin-tour/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbluebutton%2Fplugin-tour/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbluebutton%2Fplugin-tour/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigbluebutton","download_url":"https://codeload.github.com/bigbluebutton/plugin-tour/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigbluebutton%2Fplugin-tour/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270197647,"owners_count":24543463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-13T06:40:06.998Z","updated_at":"2025-08-13T06:40:10.729Z","avatar_url":"https://github.com/bigbluebutton.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tour Plugin\n\n## Description\n\nThis plugins adds a button in the options dropdown menu to start a Tour to guide user to some of the features of Bigbluebutton. It uses the [sheperd.js](https://github.com/shepherd-pro/shepherd) library.\n\n![Gif of plugin demo](./public/assets/plugin.gif)\n\nYou can configure some \"Learn More\" links that are shown in some steps (screenshare, whiteboard, general) in the settings of the plugin, see example below.\n\n## Running the Plugin From Source Code\n\n1. Start the development server:\n\n```bash\nnpm install\nnpm start\n```\n\n2. Add this to the `settings.yml` of the BBB HTML5-client:\n```yaml\npublic:\n  plugins:\n    - name: TourPlugin\n      settings:\n        url:\n          screenshare: \"https://some.url.with.more.information\"\n          whiteboard: \"https://some.url.with.more.information\"\n          general: \"https://some.url.with.more.information\"\n```\n\n## Building the Plugin\n\nTo build the plugin for production use, follow these steps:\n\n```bash\nnpm ci\nnpm run build-bundle\n```\n\nThe above command will generate the `dist` folder, containing the bundled JavaScript file named `TourPlugin.js`. This file can be hosted on any HTTPS server.\n\nAlternatively, you can host the bundled file on the BigBlueButton server by copying dist/TourPlugin.js to the folder /var/www/bigbluebutton-default/assets/plugins. In this case, the \u003c\u003cPLUGIN_URL\u003e\u003e will be https://\u003cyour-host\u003e/plugins/TourPlugin.js.\n\nIf you install the Plugin separated to the manifest, remember to change the `javascriptEntrypointUrl` in the `manifest.json` to the correct endpoint.\n\nTo use the plugin in BigBlueButton, send this parameter along in create call:\n\n```\npluginManifests=[{\"url\":\"\u003cyour-domain\u003e/path/to/manifest.json\"}]\n```\n\nOr additionally, you can add this same configuration in the `.properties` file from `bbb-web` in `/etc/bigbluebutton/bbb-web.properties`\n\n## Development mode\n\nAs for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`\n\n## Background\n\nBigBlueButton added supports for plugins in 2025 with BBB 3.0.\nCheck the official [documentation website](https://docs.bigbluebutton.org) for more information.\n\nThis plugin repository was created using the plugin [template repository for BigBlueButton](https://github.com/bigbluebutton/plugin-template) hosted on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigbluebutton%2Fplugin-tour","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigbluebutton%2Fplugin-tour","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigbluebutton%2Fplugin-tour/lists"}