bbb-webhooks/config/default.example.yml at develop · bigbluebutton/bbb-webhooks · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
log:
  level: info
  # Wether to log to stdout or not
  stdout: true
  # Wether to log to log.filename or not
  file: false
  filename: /var/log/bbb-webhooks.log

prometheus:
  enabled: false
  host: 127.0.0.1
  port: 3004
  path: /metrics
  collectDefaultMetrics: false

# Shared secret of your BigBlueButton server.
bbb:
  serverDomain: myserver.com
  sharedSecret: mysharedsecret
  # Whether to use Auth2.0 or not, Auth2.0 sends the sharedSecret whithin an Authorization header as a bearer
  auth2_0: false
  apiPath: /bigbluebutton/api

# Mappings of internal to external meeting IDs
mappings:
  cleanupInterval: 10000 # 10 secs, in ms
  timeout: 604800000 # 1 week, in ms

# Redis
redis:
  host: 127.0.0.1
  port: 6379
  keys:
    hookPrefix: bigbluebutton:webhooks:out:hook
    hooks: bigbluebutton:webhooks:out:hooks
    mappings: bigbluebutton:webhooks:proc:mappings
    mappingPrefix: bigbluebutton:webhooks:proc:mapping
    userMaps: bigbluebutton:webhooks:proc:userMaps
    userMapPrefix: bigbluebutton:webhooks:proc:userMap

# Basic module config entry template:
#   key: <relative file path to app root if drop-in or module name if npm/github>,
#     enabled: true|false (optional, default: true)
#     mandatory: true|false (optional, default: true) - when false, a module that
#       fails to load is logged and skipped; otherwise startup is aborted
#     type: in|out|db,
#     config: <module-specific config> (optional)
#
modules:
  ../db/redis/index.js:
    enabled: true
    type: db
    config:
      host: 127.0.0.1
      port: 6379
  ../in/redis/index.js:
    enabled: true
    type: in
    config:
      redis:
        host: 127.0.0.1
        port: 6379
        #password: foobar
        inboundChannels:
          - from-akka-apps-redis-channel
          - from-bbb-web-redis-channel
          - from-akka-apps-chat-redis-channel
          - from-akka-apps-pres-redis-channel
          - bigbluebutton:from-bbb-apps:meeting
          - bigbluebutton:from-bbb-apps:users
          - bigbluebutton:from-rap
  ../out/webhooks/index.js:
    enabled: true
    type: out
    config:
      api:
        bind: 127.0.0.1
        port: 3005
        # Supported checksum generation algorithms for BBB API calls
        # This should mirror the supportedChecksumAlgorithms configuration
        # in bbb-web.properties
        supportedChecksumAlgorithms:
          - sha1
          - sha256
          - sha384
          - sha512
      queue:
        enabled: false
        maxSize: 10000
        concurrency: 1
      # Defines the algorithm to be used when generating checksums for
      # callback POST requests. One of: sha1, sha256, sha384 or sha512
      # Default: sha1
      hookChecksumAlgorithm: sha1
      # Events to be included on the callback POST request. If not set,
      # all events will that aren't excluded will be included.
      includeEvents: []
      # Events to be excluded on the callback POST request.
      excludeEvents: []
      # IP where permanent hook will post data (more than 1 URL means more than 1 permanent hook)
      permanentURLs: []
      # How many messages will be enqueued to be processed at the same time
      queueSize: 10000
      # If set to higher than 1, will send events on the format:
      # "event=[{event1},{event2}],timestamp=000" or "[{event1},{event2}]" (based on using auth2_0 or not)
      # when there are more than 1 event on the queue at the moment of processing the queue.
      multiEvent: 1
      # Retry intervals for failed attempts for perform callback calls.
      # In ms. Totals to around 5min.
      retryIntervals:
        - 100
        - 500
        - 1000
        - 2000
        - 4000
        - 8000
        - 10000
        - 30000
        - 60000
        - 60000
        - 60000
        - 60000
      # Reset permanent interval when exceeding maximum attemps (ms)
      permanentIntervalReset: 60000
      # Hook's request module timeout for socket conn establishment and/or responses (ms)
      requestTimeout: 5000
      retry:
        attempts: 12
        initialInterval: 1
        increaseFactor: 2
  ../out/xapi/index.js:
    enabled: false
    type: out
    config:
      lrs:
        lrs_endpoint: https://your_lrs.endpoint
        lrs_username: user
        lrs_password: pass
      uuid_namespace: 01234567-89ab-cdef-0123-456789abcdef
      redis:
        keys:
          meetings: bigbluebutton:webhooks:xapi:meetings
          meetingPrefix: bigbluebutton:webhooks:xapi:meeting
          users: bigbluebutton:webhooks:xapi:users
          userPrefix: bigbluebutton:webhooks:xapi:user
          polls: bigbluebutton:webhooks:xapi:polls
          pollPrefix: bigbluebutton:webhooks:xapi:poll