Skip to content

Commit

Permalink
re-add instructions for settings.yml tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
antobinary committed Feb 24, 2025
1 parent bde3d4a commit ba6c0bc
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ This plugins adds a button in the options dropdown menu to start a Tour to guide

You can configure some "Learn More" links that are shown in some steps (screenshare, whiteboard, general) in the settings of the plugin, see example below.

## Running the Plugin From Source Code

1. Start the development server:

```bash
npm install
npm start
```

2. Add this to the `settings.yml` of the BBB HTML5-client:
```yaml
public:
plugins:
- name: TourPlugin
url: <<PLUGIN_URL>>
settings:
url:
screenshare: "https://some.url.with.more.information"
whiteboard: "https://some.url.with.more.information"
general: "https://some.url.with.more.information"
```
## Building the Plugin
To build the plugin for production use, follow these steps:
Expand Down

0 comments on commit ba6c0bc

Please sign in to comment.