bigbluebutton-Github/record-and-playback/core/scripts/bigbluebutton.yml

bbb_version: '3.0.0'
raw_audio_src: /var/freeswitch/meetings
mediasoup_video_src: /var/mediasoup/recordings
mediasoup_screenshare_src: /var/mediasoup/screenshare
webrtc_recorder_video_src: /var/lib/bbb-webrtc-recorder/recordings
webrtc_recorder_screenshare_src: /var/lib/bbb-webrtc-recorder/screenshare
raw_deskshare_src: /var/bigbluebutton/deskshare
raw_presentation_src: /var/bigbluebutton
notes_endpoint: http://127.0.0.1:9002/p
# Specify the notes formats we archive
# txt, doc and odt are also supported
notes_formats:
  - etherpad
  - html
  - pdf
redis_host: 127.0.0.1
redis_port: 6379
# Uncomment and set password if redis require it.
# redis_password: changeme

# redis_workers_host: 127.0.0.1
# redis_workers_port: 6379

# Set to true to insert recording process status into
# redis list with key "store_recording_status: true".
# This is useful if you want to track progress status
# and have another script process it.
store_recording_status: false

# Whether to anonymize the sender of chat messages in the processed
# recordings. The settings here are the defaults; they can be overridden
# by passing meta parameters on the meeting create call.
# meta param: meta_bbb-anonymize-chat (true/false)
anonymize_chat: false
# By default only names of viewers are anonymized - if you would also
# like to anonymize moderators, you can set this to true:
# meta param: meta_bbb-anonymize-chat-moderators (true/false)
anonymize_chat_moderators: false

# By default, recordings assume the Viewer viewpoint (with all locks)
# so when webcamsOnlyForModerator=true, only moderators webcams are included in recordings.
# Use this option to ignore locks and assume Moderator viewpoint instead.
show_moderator_viewpoint: false

# Sequence of recording steps. Keys are the current step, values
# are the next step(s). Examples:
#   current_step: next_step
#   "current_step-format": "next_step-format"
#   current_step:
#     - next_step
#     - another_step-format
steps:
  archive: "sanity"
  sanity: "captions"
  captions: "process:presentation"
  "process:presentation": "publish:presentation"

# For PRODUCTION
log_dir: /var/log/bigbluebutton
events_dir: /var/bigbluebutton/events
recording_dir: /var/bigbluebutton/recording
published_dir: /var/bigbluebutton/published
captions_dir: /var/bigbluebutton/captions
playback_host: 127.0.0.1
playback_protocol: http

# For DEVELOPMENT
# This allows us to run the scripts manually
#scripts_dir: /home/ubuntu/dev/bigbluebutton/record-and-playback/core/scripts
#log_dir: /home/ubuntu/temp/log
#recording_dir: /home/ubuntu/temp/recording
#published_dir: /home/ubuntu/temp/published
#playback_host: 127.0.0.1
Use semantic versioning Both bbb-playback and the recording processing scripts fail if the version string is not in the format MAJOR.MINOR.PATCH (3.0.0 in this case instead of 3.0) 2023-12-15 06:10:24 +08:00			`bbb_version: '3.0.0'`
- remove some files we don't need - break down properties file for bbb core and matterhorn 2011-05-12 23:58:48 +08:00			`raw_audio_src: /var/freeswitch/meetings`
chore(recording): track mediasoup raw media files locations I was going to resort to some trickery to make mediasoup raw files end up in the same directory as KMS to reduce changes, but it ended up being too dirty. I am adding a third directory (/var/mediasoup) to be tracked by the rap scripts which is where the new raw files end up in. 2021-10-05 01:33:13 +08:00			`mediasoup_video_src: /var/mediasoup/recordings`
			`mediasoup_screenshare_src: /var/mediasoup/screenshare`
build: add bbb-webrtc-recorder 2023-04-19 04:02:26 +08:00			`webrtc_recorder_video_src: /var/lib/bbb-webrtc-recorder/recordings`
			`webrtc_recorder_screenshare_src: /var/lib/bbb-webrtc-recorder/screenshare`
- remove some files we don't need - break down properties file for bbb core and matterhorn 2011-05-12 23:58:48 +08:00			`raw_deskshare_src: /var/bigbluebutton/deskshare`
			`raw_presentation_src: /var/bigbluebutton`
refactor(etherpad): access control et al. Move all Etherpad's access control from Meteor to a separated [Node application](https://github.com/bigbluebutton/bbb-pads). This new app uses [Etherpad's API](https://etherpad.org/doc/v1.8.4/#index_overview) to create groups and manage session tokens for users to access them. Each group represents one distinct pad at the html5 client. - Removed locked users' access to pads: replaced readOnly pad's access with a new pad's content sharing routine - Pad's access is now controlled by [Etherpad's API](https://etherpad.org/doc/v1.8.4/#index_overview) - Closed captions edited content now reflects at it's live feedback - Improved closed caption's dictation mode live feedback - Moved all Etherpad's API control from Meteor to a separated [app](https://github.com/bigbluebutton/bbb-pads) - Included access control both in akka-apps and bbb-pads 2021-10-16 03:07:13 +08:00			`notes_endpoint: http://127.0.0.1:9002/p`
update notes formats archived 2019-03-19 01:33:29 +08:00			`# Specify the notes formats we archive`
			`# txt, doc and odt are also supported`
rename note to notes 2019-03-12 10:56:29 +08:00			`notes_formats:`
use etherpad api to archive exported note 2019-03-06 00:17:48 +08:00			`- etherpad`
			`- html`
			`- pdf`
Changed redis host for bigbluebutton.yml to 127.0.0.1 2011-07-10 23:38:12 +08:00			`redis_host: 127.0.0.1`
- remove some files we don't need - break down properties file for bbb core and matterhorn 2011-05-12 23:58:48 +08:00			`redis_port: 6379`
- add redis password to record and playback scripts 2018-12-15 05:37:21 +08:00			`# Uncomment and set password if redis require it.`
			`# redis_password: changeme`
- modify scripts so we can run it manually 2014-04-04 04:23:49 +08:00
Add option to configure a different redis server for rap workers Makes it possible to have a separate redis for workers, which helps when scaling the processing. 2017-07-14 04:48:02 +08:00			`# redis_workers_host: 127.0.0.1`
			`# redis_workers_port: 6379`
- modify scripts so we can run it manually 2014-04-04 04:23:49 +08:00
Track recording process status - store recording process status into a redis list. This option needs to be enabled in bigbluebutton.yml 2021-03-26 03:25:30 +08:00			`# Set to true to insert recording process status into`
			`# redis list with key "store_recording_status: true".`
			`# This is useful if you want to track progress status`
			`# and have another script process it.`
			`store_recording_status: false`

recording: Anonymize names in chat Move the handling of chat events into the shared library so it can be used by multiple recording formats. The anonymization of names is based on the external user id, if available, so users have a consistent name through the meeting. Note that no effort is made to edit chat messages - if someone is mentioned by name in a chat message, that will still be visible. Default settings for anonymization can be controlled in bigbluebutton.yml, and per-meeting overrides can be done using meta parameters on the create call. 2021-08-31 05:46:52 +08:00			`# Whether to anonymize the sender of chat messages in the processed`
			`# recordings. The settings here are the defaults; they can be overridden`
			`# by passing meta parameters on the meeting create call.`
			`# meta param: meta_bbb-anonymize-chat (true/false)`
			`anonymize_chat: false`
			`# By default only names of viewers are anonymized - if you would also`
			`# like to anonymize moderators, you can set this to true:`
			`# meta param: meta_bbb-anonymize-chat-moderators (true/false)`
			`anonymize_chat_moderators: false`

Changes in review Co-authored-by: Gustavo Trott <gustavo@trott.com.br> 2022-05-05 20:53:38 +08:00			`# By default, recordings assume the Viewer viewpoint (with all locks)`
			`# so when webcamsOnlyForModerator=true, only moderators webcams are included in recordings.`
			`# Use this option to ignore locks and assume Moderator viewpoint instead.`
[issue-9789] - Changes in review. 2022-05-02 20:42:00 +08:00			`show_moderator_viewpoint: false`
[issue-9789] - change property showModeratorViewpoint's file 2022-04-30 03:43:24 +08:00
Improve the yml for rec steps and run captions always before process 2019-12-11 03:28:13 +08:00			`# Sequence of recording steps. Keys are the current step, values`
			`# are the next step(s). Examples:`
			`# current_step: next_step`
			`# "current_step-format": "next_step-format"`
			`# current_step:`
			`# - next_step`
			`# - another_step-format`
Specify the sequence of rec steps in the props file Removed from the code, now it can be specified in the properties file. Makes it easier to include new processing scripts and control dependencies between them. 2017-08-08 05:08:17 +08:00			`steps:`
			`archive: "sanity"`
Improve the yml for rec steps and run captions always before process 2019-12-11 03:28:13 +08:00			`sanity: "captions"`
			`captions: "process:presentation"`
			`"process:presentation": "publish:presentation"`
Specify the sequence of rec steps in the props file Removed from the code, now it can be specified in the properties file. Makes it easier to include new processing scripts and control dependencies between them. 2017-08-08 05:08:17 +08:00
- modify scripts so we can run it manually 2014-04-04 04:23:49 +08:00			`# For PRODUCTION`
			`log_dir: /var/log/bigbluebutton`
Created property keepEvents at bbb-web to make redis record the events for all meetings 2018-12-12 04:37:31 +08:00			`events_dir: /var/bigbluebutton/events`
- modify scripts so we can run it manually 2014-04-04 04:23:49 +08:00			`recording_dir: /var/bigbluebutton/recording`
			`published_dir: /var/bigbluebutton/published`
Put captions files in the new directory. 2019-04-23 03:28:54 +08:00			`captions_dir: /var/bigbluebutton/captions`
Bump bbb version to 2.1 so we can identify the new events BBB 2.1 has multiple presentation pods and multiple chats, so the messages for those have been altered. 2017-11-09 06:06:00 +08:00			`playback_host: 127.0.0.1`
recording: Allow configuring recording metadata to use https This allows configuring a server to use https without having to edit any ruby files directly. (Ideally, the metadata files wouldn't include the server name/protocol at all; that should be set dynamically by bbb-web, but this is what we have for now.) 2015-11-07 00:46:58 +08:00			`playback_protocol: http`
- remove some files we don't need - break down properties file for bbb core and matterhorn 2011-05-12 23:58:48 +08:00
- modify scripts so we can run it manually 2014-04-04 04:23:49 +08:00			`# For DEVELOPMENT`
			`# This allows us to run the scripts manually`
			`#scripts_dir: /home/ubuntu/dev/bigbluebutton/record-and-playback/core/scripts`
			`#log_dir: /home/ubuntu/temp/log`
			`#recording_dir: /home/ubuntu/temp/recording`
			`#published_dir: /home/ubuntu/temp/published`
Bump bbb version to 2.1 so we can identify the new events BBB 2.1 has multiple presentation pods and multiple chats, so the messages for those have been altered. 2017-11-09 06:06:00 +08:00			`#playback_host: 127.0.0.1`