docker/mod/html5/settings.yml

567 lines
15 KiB
YAML
Raw Normal View History

2020-04-09 02:11:32 +02:00
public:
app:
mobileFontSize: 16px
desktopFontSize: 14px
audioChatNotification: false
autoJoin: true
2020-07-13 16:34:09 +02:00
listenOnlyMode: {{ .Env.LISTEN_ONLY_MODE }}
2020-04-09 02:11:32 +02:00
forceListenOnly: false
skipCheck: {{ .Env.DISABLE_ECHO_TEST }}
2020-04-10 13:29:06 +02:00
clientTitle: {{ .Env.CLIENT_TITLE }}
2020-04-09 02:11:32 +02:00
appName: BigBlueButton HTML5 Client
2020-09-06 18:36:02 +02:00
bbbServerVersion: 2.3-dev
2020-06-23 00:08:41 +02:00
copyright: "©2020 BigBlueButton Inc."
2020-09-06 18:36:02 +02:00
html5ClientBuild: 1250
2020-04-09 02:11:32 +02:00
helpLink: https://bigbluebutton.org/html5/
lockOnJoin: true
cdn: ""
basename: "/html5client"
askForFeedbackOnLogout: false
2020-10-20 20:43:12 +02:00
# the default logoutUrl matches window.location.origin i.e. bigbluebutton.org for demo.bigbluebutton.org
# in some cases we want only custom logoutUrl to be used when provided on meeting create. Default value: true
allowDefaultLogoutUrl: true
2020-04-09 02:11:32 +02:00
allowUserLookup: false
enableNetworkInformation: false
enableLimitOfViewersInWebcam: false
2020-09-06 18:36:02 +02:00
enableMultipleCameras: true
2020-04-09 02:11:32 +02:00
enableTalkingIndicator: true
2020-06-23 00:08:41 +02:00
mirrorOwnWebcam: false
2020-04-09 02:11:32 +02:00
viewersInWebcam: 8
ipv4FallbackDomain: ""
allowLogout: true
allowFullscreen: true
2020-09-06 18:36:02 +02:00
preloadNextSlides: 2
mutedAlert:
enabled: true
interval: 200
threshold: -50
duration: 4000
2020-06-23 00:08:41 +02:00
remainingTimeThreshold: 30
remainingTimeAlertThreshold: 1
2020-09-16 00:24:38 +02:00
# Warning: increasing the limit of breakout rooms per meeting
# can generate excessive overhead to the server. We recommend
# this value to be kept under 12.
2020-10-21 00:04:47 +02:00
breakoutRoomLimit: {{ .Env.BREAKOUTROOM_LIMIT }}
2020-12-22 00:41:01 +01:00
# https://github.com/bigbluebutton/bigbluebutton/pull/10826
customHeartbeat: true
2020-04-09 02:11:32 +02:00
defaultSettings:
application:
animations: true
chatAudioAlerts: false
chatPushAlerts: false
userJoinAudioAlerts: false
userJoinPushAlerts: false
2020-09-06 18:36:02 +02:00
raiseHandAudioAlerts: true
raiseHandPushAlerts: true
2020-04-09 02:11:32 +02:00
fallbackLocale: en
overrideLocale: null
audio:
inputDeviceId: undefined
outputDeviceId: undefined
dataSaving:
viewParticipantsWebcams: true
viewScreenshare: true
shortcuts:
openOptions:
accesskey: O
descId: openOptions
toggleUserList:
accesskey: U
descId: toggleUserList
toggleMute:
accesskey: M
descId: toggleMute
joinAudio:
accesskey: J
descId: joinAudio
leaveAudio:
accesskey: L
descId: leaveAudio
togglePublicChat:
accesskey: P
descId: togglePublicChat
hidePrivateChat:
accesskey: H
descId: hidePrivateChat
closePrivateChat:
accesskey: G
descId: closePrivateChat
openActions:
accesskey: A
descId: openActions
branding:
2020-09-06 18:36:02 +02:00
displayBrandingArea: true
2020-04-09 02:11:32 +02:00
connectionTimeout: 60000
showHelpButton: true
effectiveConnection:
2020-05-23 08:59:33 +02:00
- critical
- danger
- warning
2020-04-09 02:11:32 +02:00
externalVideoPlayer:
enabled: true
networkMonitoring:
enableNetworkMonitoring: false
packetLostThreshold: 10
kurento:
2020-04-10 13:29:06 +02:00
wsUrl: wss://{{ .Env.DOMAIN }}/bbb-webrtc-sfu
2020-09-06 18:36:02 +02:00
# Valid for video-provider. Time (ms) before its WS connection times out
# and tries to reconnect.
wsConnectionTimeout: 4000
cameraTimeouts:
# Base camera timeout: used as the camera *sharing* timeout and
# as the minimum camera subscribe reconnection timeout
baseTimeout: 15000
# Max timeout: used as the max camera subscribe reconnection timeout. Each
# subscribe reattempt increases the reconnection timer up to this
maxTimeout: 60000
chromeDefaultExtensionKey: akgoaoikmbmhcopjgakkcepdgdgkjfbc
chromeDefaultExtensionLink: https://chrome.google.com/webstore/detail/bigbluebutton-screenshare/akgoaoikmbmhcopjgakkcepdgdgkjfbc
2020-04-09 02:11:32 +02:00
chromeExtensionKey: KEY
chromeExtensionLink: LINK
2020-05-23 08:59:33 +02:00
screenshare:
constraints:
video:
frameRate:
ideal: 5
max: 10
width:
max: 2560
height:
max: 1600
audio: false
chromeScreenshareSources:
- window
- screen
firefoxScreenshareSource: window
2020-08-12 18:08:07 +02:00
# cameraProfiles is an array of:
# - id: profile identifier
# name: human-readable profile name
# bitrate
# hidden: whether this profile will be hidden in the video preview dropdown
# constraints: a video media constraints dictionary (without the video key)
2020-04-09 02:11:32 +02:00
cameraProfiles:
2020-09-06 18:36:02 +02:00
# id: unique identifier of the profile
# name: name of the profile visible to users
# default: if this is the default profile which is pre-selected
# bitrate: the average bitrate for used for a webcam stream
# constraints:
# # Optional constraints put on the requested video a browser MAY honor
# # For a detailed list on possible values see:
# # https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints
# # Examples:
# width: requested width of the camera stream
# frameRate: requested framerate
2020-08-12 18:08:07 +02:00
- id: low-u30
name: low-u30
bitrate: 30
hidden: true
constraints:
frameRate: 3
- id: low-u25
name: low-u25
bitrate: 40
hidden: true
constraints:
frameRate: 3
- id: low-u20
name: low-u20
bitrate: 50
hidden: true
constraints:
frameRate: 5
- id: low-u15
name: low-u15
bitrate: 70
hidden: true
constraints:
frameRate: 8
- id: low-u12
name: low-u12
bitrate: 90
hidden: true
constraints:
frameRate: 10
- id: low-u8
name: low-u8
bitrate: 100
hidden: true
constraints:
frameRate: 10
2020-05-23 08:59:33 +02:00
- id: low
2020-09-06 12:03:57 +02:00
name: Low
2020-05-23 08:59:33 +02:00
default: false
bitrate: 100
- id: medium
2020-09-06 12:03:57 +02:00
name: Medium
2020-05-23 08:59:33 +02:00
default: true
bitrate: 200
- id: high
2020-09-06 12:03:57 +02:00
name: High
2020-05-23 08:59:33 +02:00
default: false
bitrate: 500
2020-09-06 18:36:02 +02:00
constraints:
width: 1280
frameRate: 15
2020-05-23 08:59:33 +02:00
- id: hd
name: High definition
default: false
bitrate: 800
2020-09-06 18:36:02 +02:00
constraints:
width: 1280
frameRate: 30
2020-04-09 02:11:32 +02:00
enableScreensharing: true
enableVideo: true
enableVideoMenu: true
enableListenOnly: true
2020-07-13 16:34:09 +02:00
autoShareWebcam: {{ .Env.AUTO_SHARE_WEBCAM }}
skipVideoPreview: {{ .Env.DISABLE_VIDEO_PREVIEW }}
# Entry `thresholds` is an array of:
# - threshold: minimum number of cameras being shared for profile to applied
# profile: a camera profile id from the cameraProfiles configuration array
# that will be applied to all cameras when threshold is hit
cameraQualityThresholds:
2020-12-22 00:53:40 +01:00
enabled: true
thresholds:
- threshold: 8
profile: low-u8
- threshold: 12
profile: low-u12
- threshold: 15
profile: low-u15
- threshold: 20
profile: low-u20
- threshold: 25
profile: low-u25
- threshold: 30
profile: low-u30
pagination:
# whether to globally enable or disable pagination.
enabled: false
# how long (in ms) the negotiation will be debounced after a page change.
pageChangeDebounceTime: 2500
# video page sizes for DESKTOP endpoints. It stands for the number of SUBSCRIBER streams.
# PUBLISHERS aren't accounted for .
# A page size of 0 (zero) means that the page size is unlimited (disabled).
desktopPageSizes:
moderator: 0
viewer: 5
# video page sizes for MOBILE endpoints
mobilePageSizes:
moderator: 2
viewer: 2
2020-04-09 02:11:32 +02:00
pingPong:
clearUsersInSeconds: 180
pongTimeInSeconds: 15
allowOutsideCommands:
2020-09-06 18:36:02 +02:00
toggleRecording: false
2020-04-09 02:11:32 +02:00
toggleSelfVoice: false
poll:
enabled: true
max_custom: 5
captions:
enabled: true
enableDictation: false
backgroundColor: "#000000"
fontColor: "#FFFFFF"
fontFamily: Calibri
fontSize: 24px
takeOwnership: true
lines: 2
time: 5000
chat:
2020-07-13 16:34:09 +02:00
enabled: {{ .Env.CHAT_ENABLED }}
2020-12-22 00:41:01 +01:00
bufferChatInsertsMs: 0
2020-07-13 16:34:09 +02:00
startClosed: {{ .Env.CHAT_START_CLOSED }}
2020-04-09 02:11:32 +02:00
min_message_length: 1
max_message_length: 5000
grouping_messages_window: 10000
type_system: SYSTEM_MESSAGE
type_public: PUBLIC_ACCESS
type_private: PRIVATE_ACCESS
system_userid: SYSTEM_MESSAGE
system_username: SYSTEM_MESSAGE
public_id: public
public_group_id: MAIN-PUBLIC-GROUP-CHAT
public_userid: public_chat_userid
public_username: public_chat_username
storage_key: UNREAD_CHATS
system_messages_keys:
chat_clear: PUBLIC_CHAT_CLEAR
typingIndicator:
enabled: true
note:
enabled: true
2020-04-10 13:29:06 +02:00
url: https://{{ .Env.DOMAIN }}/pad
2020-04-09 02:11:32 +02:00
config:
showLineNumbers: false
showChat: false
2020-08-12 18:08:07 +02:00
noColors: true
2020-04-09 02:11:32 +02:00
showControls: true
rtl: false
layout:
autoSwapLayout: false
hidePresentation: false
2020-07-11 12:37:00 +02:00
webcamsDefaultPlacement: "top"
2020-04-09 02:11:32 +02:00
media:
stunTurnServersFetchAddress: "/bigbluebutton/api/stuns"
2020-05-23 08:59:33 +02:00
cacheStunTurnServers: true
fallbackStunServer: ''
2020-11-23 15:49:05 +01:00
recvonlyIceGatheringCheck: true
2020-04-09 02:11:32 +02:00
mediaTag: "#remote-media"
callTransferTimeout: 5000
callHangupTimeout: 2000
callHangupMaximumRetries: 10
echoTestNumber: 'echo'
2020-04-09 02:11:32 +02:00
relayOnlyOnReconnect: false
2020-10-20 20:43:12 +02:00
listenOnlyCallTimeout: 25000
2020-11-23 15:49:05 +01:00
#Timeout (ms) for gathering ICE candidates. When this timeout expires
#the SDP is sent to the server with the candidates the browser gathered
#so far. Increasing this value might help avoiding 1004 error when
#user activates microphone.
iceGatheringTimeout: 5000
sipjsHackViaWs: false
2020-12-22 00:41:01 +01:00
#Websocket keepAlive interval (seconds). You may set this to prevent
#websocket disconnection in some environments. When set, BBB will send
#'\r\n\r\n' string through SIP.js's websocket. If not set, default value
#is 0.
websocketKeepAliveInterval: 30
#Debounce time (seconds) for sending SIP.js's websocket keep alive message.
#If not set, default value is 10.
websocketKeepAliveDebounce: 10
#Trace sip/audio messages in browser. If not set, default value is false.
traceSip: false
2020-07-11 12:37:00 +02:00
stats:
enabled: true
interval: 2000
length: 5
log: false
jitter:
- 10
- 20
- 30
loss:
- 0.05
- 0.1
- 0.2
level:
- warning
- danger
- critical
help: STATS_HELP_URL
2020-04-09 02:11:32 +02:00
presentation:
2020-07-11 12:37:00 +02:00
allowDownloadable: true
2020-04-09 02:11:32 +02:00
defaultPresentationFile: default.pdf
panZoomThrottle: 32
restoreOnUpdate: false
2020-04-09 02:11:32 +02:00
uploadEndpoint: "/bigbluebutton/presentation/upload"
uploadSizeMin: 0
uploadSizeMax: 50000000
uploadValidMimeTypes:
- extension: .pdf
mime: application/pdf
- extension: .doc
mime: application/msword
- extension: .docx
mime: application/vnd.openxmlformats-officedocument.wordprocessingml.document
- extension: .xls
mime: application/vnd.ms-excel
- extension: .xlsx
mime: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- extension: .ppt
mime: application/vnd.ms-powerpoint
- extension: .pptx
mime: application/vnd.openxmlformats-officedocument.presentationml.presentation
- extension: .txt
mime: text/plain
- extension: .rtf
mime: application/rtf
- extension: .odt
mime: application/vnd.oasis.opendocument.text
- extension: .ods
mime: application/vnd.oasis.opendocument.spreadsheet
- extension: .odp
mime: application/vnd.oasis.opendocument.presentation
- extension: .odg
mime: application/vnd.oasis.opendocument.graphics
- extension: .odc
mime: application/vnd.oasis.opendocument.chart
- extension: .odi
mime: application/vnd.oasis.opendocument.image
- extension: .jpg
mime: image/jpeg
2020-05-23 08:59:33 +02:00
- extension: .jpeg
mime: image/jpeg
2020-04-09 02:11:32 +02:00
- extension: .png
mime: image/png
user:
role_moderator: MODERATOR
role_viewer: VIEWER
whiteboard:
annotations:
status:
start: DRAW_START
update: DRAW_UPDATE
end: DRAW_END
toolbar:
multiUserPenOnly: false
colors:
- label: black
value: "#000000"
- label: white
value: "#ffffff"
- label: red
value: "#ff0000"
- label: orange
value: "#ff8800"
- label: eletricLime
value: "#ccff00"
- label: Lime
value: "#00ff00"
- label: Cyan
value: "#00ffff"
- label: dodgerBlue
value: "#0088ff"
- label: blue
value: "#0000ff"
- label: violet
value: "#8800ff"
- label: magenta
value: "#ff00ff"
- label: silver
value: "#c0c0c0"
thickness:
- value: 14
- value: 12
- value: 10
- value: 8
- value: 6
- value: 4
- value: 2
- value: 1
font_sizes:
- value: 36
- value: 32
- value: 28
- value: 24
- value: 20
- value: 16
tools:
- icon: text_tool
value: text
- icon: line_tool
value: line
- icon: circle_tool
value: ellipse
- icon: triangle_tool
value: triangle
- icon: rectangle_tool
value: rectangle
- icon: pen_tool
value: pencil
- icon: hand
value: hand
presenterTools:
- text
- line
- ellipse
- triangle
- rectangle
- pencil
- hand
multiUserTools:
- text
- line
- ellipse
- triangle
- rectangle
- pencil
- hand
clientLog:
2020-09-06 18:36:02 +02:00
server:
enabled: false
level: info
console:
enabled: true
level: debug
external:
enabled: false
level: info
url: https://LOG_HOST/html5Log
method: POST
throttleInterval: 400
flushOnClose: true
logTag: ""
2020-04-09 02:11:32 +02:00
private:
app:
2020-04-09 22:33:27 +02:00
host: 0.0.0.0
2020-04-09 02:11:32 +02:00
port: 3000
localesUrl: /locales
pencilChunkLength: 100
loadSlidesFromHttpAlways: false
etherpad:
2020-04-10 13:29:06 +02:00
apikey: {{ .Env.ETHERPAD_API_KEY }}
2020-04-09 02:11:32 +02:00
version: 1.2.13
2020-04-09 22:33:27 +02:00
host: etherpad
2020-04-09 02:11:32 +02:00
port: 9001
redis:
2020-04-09 22:33:27 +02:00
host: redis
2020-04-09 02:11:32 +02:00
port: '6379'
timeout: 5000
password: null
debug: false
2020-12-22 00:41:01 +01:00
metrics:
queueMetrics: false
metricsDumpIntervalMs: 60000
metricsFolderPath: METRICS_FOLDER
removeMeetingOnEnd: true
2020-04-09 02:11:32 +02:00
channels:
toAkkaApps: to-akka-apps-redis-channel
toThirdParty: to-third-party-redis-channel
subscribeTo:
- to-html5-redis-channel
- from-akka-apps-*
- from-third-party-redis-channel
- from-etherpad-redis-channel
async:
- from-akka-apps-wb-redis-channel
ignored:
- CheckAlivePongSysMsg
- DoLatencyTracerMsg
serverLog:
level: info
streamerLog: false
memoryMonitoring:
stat:
enabled: false
leak:
enabled: false
heapdump:
enabled: false
2020-12-22 00:41:01 +01:00
heapdumpFolderPath: HEAPDUMP_FOLDER
heapdumpIntervalMs: 3600000
2020-04-09 02:11:32 +02:00
minBrowserVersions:
2020-05-23 08:59:33 +02:00
- browser: chrome
2020-09-16 00:24:38 +02:00
version: 72
2020-05-23 08:59:33 +02:00
- browser: chromeMobileIOS
version: Infinity
- browser: firefox
2020-09-16 00:24:38 +02:00
version: 63
2020-05-23 08:59:33 +02:00
- browser: firefoxMobile
2020-09-16 00:24:38 +02:00
version: 68
2020-05-23 08:59:33 +02:00
- browser: edge
2020-09-16 00:24:38 +02:00
version: 79
2020-05-23 08:59:33 +02:00
- browser: ie
version: Infinity
- browser: safari
2020-09-16 00:24:38 +02:00
version: [12, 1]
2020-05-23 08:59:33 +02:00
- browser: mobileSafari
2020-09-16 00:24:38 +02:00
version: [12, 1]
2020-05-23 08:59:33 +02:00
- browser: opera
2020-09-16 00:24:38 +02:00
version: 50
2020-05-23 08:59:33 +02:00
- browser: electron
version: [0, 36]
2020-10-20 20:43:12 +02:00
- browser: SamsungInternet
version: 10
2020-09-16 00:24:38 +02:00
- browser: YandexBrowser
version: 19