bigbluebutton-Github/record-and-playback/core/scripts
Calvin Walton 010153cbb9 Recording: Remove the red5 race workaround that delays processing
This was added to workaround for red5 taking a while to rewrite the
serialized (.ser) data that it streams to disk back to the .flv format.

The workaround is no longer needed, for two reasons:
* The sanity scripts run the red5 code to generate the .flv from the .ser
  if needed, and
* We're expecting more people to be using WebRTC media in the future anyways

This makes recordings available up to 2 minutes earlier than they would have
been otherwise.
2019-02-28 11:13:12 -05:00
..
archive Merge branch 'master' of github.com:bigbluebutton/bigbluebutton into 21-and-20-merge-working-branch 2018-06-06 08:23:13 -07:00
events Copying events.xml from archived recordings 2018-12-13 15:21:10 -02:00
post_archive
post_process
post_publish Use the right bigbluebutton user for recording directories. 2019-02-08 17:53:57 +01:00
process
publish
sanity RaP sanity: Don't delete .ser file unless repair succeeded 2018-05-23 12:03:20 -04:00
utils Handle out of order inserts at the start of a caption stream. 2017-10-12 14:16:34 -04:00
bbb-0.9-beta-recording-update Update bbb-0.9-beta-recording-update 2016-06-26 11:52:09 -04:00
bbb-0.9-recording-size
bbb-1.1-meeting-tag Script for fixing meeting tag in recordings migrated from BBB 1.0 and before 2018-09-20 14:23:29 +00:00
bigbluebutton.yml Created property keepEvents at bbb-web to make redis record the events for all meetings 2018-12-11 18:37:31 -02:00
cleanup.rb cleanup 2018-07-12 00:06:14 -03:00
rap-archive-worker.rb Recording: Remove the red5 race workaround that delays processing 2019-02-28 11:13:12 -05:00
rap-process-worker.rb Set up rap publish/process scripts for segments 2017-11-07 11:50:28 -05:00
rap-publish-worker.rb Fix parsing meeting id for segments in publish step 2017-11-10 13:10:58 -05:00
rap-sanity-worker.rb Fix syntax issues in sanity scripts 2017-11-07 09:53:08 -05:00
README record-and-playback: Split rap-worker into separate workers per step. 2017-03-22 17:20:29 -04:00

README

This instructions below are for testing by running scripts manually:

1. Create some temp scratch dirs:
    mkdir -p ~/temp/log/presentation ~/temp/recording/{process,publish,raw} ~/temp/recording/status/{recorded,archived,processed,sanity} ~/temp/published

2. Edit core/scripts/bigbluebutton.yml and comment out the PRODUCTION dirs while uncommenting the DEVELOPMENT dir. The dir should match what you created above.

raw_audio_src: /var/freeswitch/meetings
raw_video_src: /usr/share/red5/webapps/video/streams
raw_deskshare_src: /var/bigbluebutton/deskshare
raw_presentation_src: /var/bigbluebutton
redis_host: 127.0.0.1
redis_port: 6379


# For PRODUCTION
log_dir: /var/log/bigbluebutton
recording_dir: /var/bigbluebutton/recording
published_dir: /var/bigbluebutton/published
playback_host: 10.0.3.203

# 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: 192.168.22.137

3. Create a recording using BigBlueButton. After logging out, it should have created a <meeting-id>.done file in
   /var/bigbluebutton/recording/status/recorded dir. Make note of this meeting-id as we use that to tell the script
   which recording to process.

4. Before running the scripts, we have to make sure our scripts have the PATHs setup correctly.
   Edit presentation/scripts/process/presentation.rb and uncomment the DEVELOPMENT PATH while
   commenting the PRODUCTION PATH. We need to do this so the script will be able to find the
   core library.

5. Now we run the archive step. Go to record-and-playback/core/scripts dir and type
     ruby archive/archive.rb -m <meeting-id>

6. If everything goes well, you should have the raw files in ~/temp/recording/raw/<meeting-id>
   You can also check the logs at ~/temp/log/archive-<meeting-id>.log

   You should also have an entry in ~/temp/recording/status/archived dir

7. Then we need to do a sanity check if the raw recordings are complete. Type
     ruby sanity/sanity.rb -m <meeting-id>

   Check the log in ~/temp/log/sanity.log

   You should also have an entry in ~/temp/recording/status/sanity dir

8. Assuming the recording passed the sanity check, it's time to process the recording.
     cd record-and-playback/presentation/scripts
     ruby process/presentation.rb -m <meeting-id>

     You can monitor the progress by tailing the log at ~/temp/log/presentation/process-<meeting-id>.log

9. Assuming that everything goes well. We can now run the publish script. However, we need to cheat a little bit.
   The publish script will be looking for a "processing_time" file which contains information on how long the
   processing took. Unfortunately, that file is created by the rap-worker.rb script which we don't run.

   So we create that file manually at 
    vi  ~/temp/recording/process/presentation/<meeting-d>/processing_time

   Enter any number (e.g. 46843) and save the file.

10. Now run the publish script
      ruby publish/presentation.rb -m <meeting-id>-presentation

    Notice we appended "presentation" to the meeting-id, this will tell the script to publish using the "presentation" format.