วิธีตั้งค่าการเชื่อมต่อ Etherpad กับ BigBlueButton

การเชื่อมต่อ Etherpad เข้ากับ BigBlueButton นั้นสามารถกำหนดค่าได้ผ่านส่วนประกอบ shared-notes ของเซิร์ฟเวอร์ ใน BigBlueButton 4.0 beta.4 นั้น Etherpad เป็นตัวเลือกเสริม: ติดตั้ง แพ็ก bbb-padsเกbbb-etherpadจ จากนั้นเลือก Etherpad สำหรับการประชุมครั้งเดียว หรือตั้งค่าเป็นค่าเริ่มต้นทั่วทั้งเซิร์ฟเวอร์ สำหรับการติดตั้งเวอร์ชันก่อนหน้าที่มีแพ็กเกจ Etherpad อยู่แล้ว งานหลักคือการเลือกโปรแกรมแก้ไขและรีสตาร์ทบริการที่เกี่ยวข้อง

ขั้นแรก โปรดตรวจสอบเวอร์ชัน BigBlueButton ของคุณ เอกสารเวอร์ชัน 4.0 ปัจจุบันอธิบายถึงการเปลี่ยนแปลงจากค่าเริ่มต้นก่อนหน้านี้: BlockNote เป็นโปรแกรมแก้ไขบันทึกย่อที่ใช้ร่วมกันโดยค่าเริ่มต้น ในขณะที่แพ็กเกจ Etherpad เป็นตัวเลือกเสริม ดังนั้น การเลือก Etherpad อย่างชัดเจนจะช่วยหลีกเลี่ยงการพึ่งพาค่าเริ่มต้นเฉพาะเวอร์ชัน โปรดดูบันทึกย่อคุณสมบัติใหม่ BigBlueButton 4.0 อย่างเป็นทางการ และ เอกสารอ้างอิง API ของBigBlueButton

การบูรณาการทำอะไรได้บ้าง

BigBlueButton นำเสนอโน้ตที่ใช้ร่วมกันภายในที่ประชุมและประสานการเข้าถึงแผ่นบันทึก Etherpad ให้บริการโปรแกรมแก้ไขร่วมกันแบบเรียลไทม์ที่ใช้ในส่วนนั้น ในการติดตั้งแบบมาตรฐาน ส่วนประกอบ Etherpad ของ BigBlueButton จะถูกติดตั้งบนเซิร์ฟเวอร์เดียวกัน โดยปกติแล้วคุณไม่จำเป็นต้องเพิ่ม URL สาธารณะของ Etherpad แยกต่างหากหรือวางคีย์ API ของ Etherpad ลงในอินเทอร์เฟซการประชุม

คู่มือนี้ครอบคลุมการตั้งค่าเซิร์ฟเวอร์แบบแพ็กเกจ และตัวเลือกที่รองรับทั้งในระดับการประชุมและระดับเซิร์ฟเวอร์ การใช้งานคลัสเตอร์หรือรีเวิร์สพร็อกซีจำเป็นต้องมีการกำหนดค่า URL และต้นทางเพิ่มเติม การตั้งค่าเหล่านี้ไม่สามารถใช้ทดแทนการติดตั้งและเปิดใช้งานส่วนประกอบ Etherpad ได้

1. ตรวจสอบเวอร์ชัน BigBlueButton และแพ็กเกจที่ติดตั้งไว้

เรียกใช้คำสั่งเหล่านี้บนโฮสต์ BigBlueButton:

sudo bbb-conf --check
dpkg -l | grep -E 'bbb-(etherpad|pads|shared-notes-server)'

รายการแพ็กเกจช่วยแยกแยะความแตกต่างระหว่างการติดตั้ง Etherpad ที่หายไปกับปัญหาการเลือกแพ็กเกจ ในระบบ BigBlueButton 4.0 beta.4 เอกสารทางการระบุว่าbbb-shared-notes-server(BlockNote) เป็นแพ็กเกจเริ่มต้นที่จำเป็น และ มีแพ็กเกจเสริม bbb-etherpadเพิ่มเติมbbb-padsเวอร์ชันก่อนหน้าอาจแสดงแพ็กเกจที่แตกต่างกัน ดังนั้นควรใช้เอกสารสำหรับเวอร์ชันที่ติดตั้งจริงแทนที่จะคัดลอกคำแนะนำสำหรับเวอร์ชัน 4.0 ไปยังเซิร์ฟเวอร์เวอร์ชันเก่ากว่า

2. ติดตั้งแพ็กเกจ Etherpad เมื่อจำเป็น

ใน BigBlueButton เวอร์ชัน 4.0 beta.4 ให้ติดตั้งแพ็กเกจเสริมโดยใช้ APT:

sudo apt update
sudo apt install bbb-pads bbb-etherpad

ตรวจสอบการเปลี่ยนแปลงที่ตัวจัดการแพ็กเกจเสนอมาก่อนยืนยัน หาก APT ไม่พบแพ็กเกจใด ๆ ให้ตรวจสอบว่าที่เก็บ BigBlueButton ถูกกำหนดค่าสำหรับเวอร์ชันเดียวกันกับเซิร์ฟเวอร์ อย่าดาวน์โหลดแพ็กเกจที่สร้างขึ้นสำหรับ BigBlueButton เวอร์ชันอื่นเพียงเพื่อดำเนินการติดตั้งต่อไป

หลังจากติดตั้งเสร็จแล้ว โปรดตรวจสอบว่าทั้งสองแพ็กเกจปรากฏในรายการแพ็กเกจ หากคุณกำลังอัปเกรดเซิร์ฟเวอร์ที่ใช้งานจริงอยู่แล้ว โปรดปฏิบัติตามขั้นตอนการอัปเกรดอย่างเป็นทางการของเวอร์ชันนั้น และกำหนดช่วงเวลาสำหรับการบำรุงรักษา การติดตั้งแพ็กเกจเสริมเป็นการเปลี่ยนแปลงเซิร์ฟเวอร์ ไม่ใช่การตั้งค่าไคลเอ็นต์สำหรับการประชุม

3. เปิดใช้งาน Etherpad สำหรับการประชุมหนึ่งครั้ง

หากต้องการใช้ Etherpad ในเซสชันเฉพาะโดยไม่เปลี่ยนแปลงค่าเริ่มต้นของเซิร์ฟเวอร์ ให้ตั้งค่าsharedNotesEditorพารามิเตอร์เป็น ใน การเรียกใช้ API etherpadBigBlueButton ของการประชุมนั้น :create

sharedNotesEditor=etherpad

พารามิเตอร์นี้ควรอยู่ในส่วนของการผสานรวมฝั่งเซิร์ฟเวอร์ที่สร้างการประชุม แอปพลิเคชันต้องรวมพารามิเตอร์นี้ไว้ในคำขอสร้างที่ลงนามแล้วก่อนที่จะคำนวณค่าตรวจสอบความถูกต้องของ API API ของ BigBlueButton ยอมรับค่าetherpadหรือblockNoteสำหรับตัวเลือกนี้ โปรดตรวจสอบเอกสารประกอบ API สำหรับพฤติกรรมของเวอร์ชันที่คุณติดตั้ง เนื่องจากวิธีการตรวจสอบความถูกต้องและค่าเริ่มต้นอาจแตกต่างกันไปตามเวอร์ชัน

เก็บรหัสลับ BigBlueButton ไว้บนเซิร์ฟเวอร์ อย่าเปิดเผยรหัสลับนี้ใน JavaScript ของเบราว์เซอร์ ซอร์สโค้ดของหน้าเว็บ หรือแอปพลิเคชันบนมือถือ ผู้ใดก็ตามที่ได้รับรหัสลับนี้สามารถสร้างการเรียกใช้ API ที่ลงชื่อในนามของเซิร์ฟเวอร์ของคุณได้ หากคุณใช้ Greenlight หรือส่วนหน้าสำหรับการประชุมอื่นๆ ให้กำหนดค่าพารามิเตอร์ผ่านการตั้งค่าที่รองรับของการผสานรวมนั้นๆ แทนที่จะแก้ไข URL การประชุมในเบราว์เซอร์

4. ตั้งค่า Etherpad ให้เป็นค่าเริ่มต้นทั่วทั้งเซิร์ฟเวอร์

หากต้องการใช้ Etherpad ในการประชุมทุกครั้ง ให้แก้ไขไฟล์การตั้งค่าเว็บของ BigBlueButton:

sudo nano /etc/bigbluebutton/bbb-web.properties

เพิ่มบรรทัดนี้ โดยคงการตั้งค่าอื่นๆ ในไฟล์ไว้:

sharedNotesEditor=etherpad

บันทึกไฟล์และรีสตาร์ท BigBlueButton:

sudo bbb-conf --restart

การตั้งค่านี้ใช้กับการประชุมที่ไม่ได้ระบุsharedNotesEditorค่าของตัวเอง พารามิเตอร์การสร้างระดับการประชุมสามารถระบุตัวเลือกได้อย่างชัดเจนสำหรับเซสชันเฉพาะ เอกสารบันทึกอย่างเป็นทางการของเวอร์ชัน 4.0 ระบุคุณสมบัติเดียวกันนี้สำหรับการเลือก Etherpad ทั่วโลกและระบุการเริ่มต้นใหม่ด้วยbbb-conf --restart.

5. ทดสอบผลลัพธ์ในการประชุมครั้งใหม่

หลังจากรีสตาร์ทแล้ว ให้เริ่มการประชุมทดสอบใหม่ การประชุมที่กำลังดำเนินอยู่อาจไม่แสดงค่าเริ่มต้นที่เปลี่ยนแปลงไป เข้าร่วมในฐานะผู้ดูแลและผู้เข้าร่วมคนที่สอง เปิดบันทึกที่แชร์ และยืนยันว่าผู้ใช้ทั้งสองสามารถมองเห็นและแก้ไขแผ่นบันทึกเดียวกันได้ ทำการแก้ไขทดสอบสั้นๆ จากแต่ละบัญชี รอให้มุมมองของผู้เข้าร่วมอีกคนอัปเดต และตรวจสอบผลลัพธ์หลังจากปิดและเปิดแผงบันทึกอีกครั้ง

หากคุณกำลังทดสอบการประชุมที่สร้างขึ้นผ่านการผสานรวม API โปรดตรวจสอบคำขอสร้างของการผสานรวมนั้นและยืนยันว่าได้รวมsharedNotesEditor=etherpadพารามิเตอร์ `.` ไว้แล้ว สำหรับการทดสอบค่าเริ่มต้นทั่วโลก ให้สร้างการประชุมโดยไม่ต้องตั้งค่าพารามิเตอร์ดังกล่าว วิธีนี้จะช่วยแยกความแตกต่างระหว่างตัวเลือกที่ขาดหายไปในระดับการประชุมกับปัญหาการกำหนดค่าทั่วทั้งเซิร์ฟเวอร์

การปรับใช้พร็อกซีคลัสเตอร์และ URL ภายนอก

เมื่อเบราว์เซอร์เข้าถึง BigBlueButton ผ่านพร็อกซีคลัสเตอร์หรือชื่อโฮสต์สาธารณะอื่น URL ของ shared-notes และต้นทางของเบราว์เซอร์ต้องตรงกับการออกแบบพร็อกซีคู่มือพร็อกซีคลัสเตอร์ อย่างเป็นทางการของ BigBlueButton ได้บันทึกpads.urlการตั้งค่าไว้ใน/etc/bigbluebutton/bbb-html5.ymlและรายการที่อนุญาตพร็อกซีคลัสเตอร์/etc/bigbluebutton/etherpad.jsonอยู่ใน ตัวอย่าง URL ในคู่มือใช้/padเส้นทางบนโฮสต์พร็อกซีสาธารณะ โปรดปฏิบัติตามคู่มือทั้งหมดสำหรับการตั้งค่าคลัสเตอร์ รวมถึงข้อกำหนดด้านต้นทางและพร็อกซี อย่าคัดลอกเฉพาะบรรทัด URL ไปยังการติดตั้งเซิร์ฟเวอร์เดี่ยวที่ไม่เกี่ยวข้อง

หลังจากเปลี่ยนการกำหนดค่าคลัสเตอร์แล้ว ให้ทำตามขั้นตอนการรีสตาร์ทและการตรวจสอบสำหรับเวอร์ชัน BigBlueButton ที่ติดตั้งไว้ หาก Etherpad โหลดบนชื่อโฮสต์โดยตรงของเซิร์ฟเวอร์ แต่ล้มเหลวผ่านพร็อกซี ให้ตรวจสอบเส้นทางพร็อกซี ชื่อโฮสต์ ใบรับรอง TLS และนโยบายต้นทางของเบราว์เซอร์ก่อนที่จะเปลี่ยนการเลือกตัวแก้ไข พร็อกซีแบบย้อนกลับต้องรองรับการเชื่อมต่อที่จำเป็นสำหรับอินเทอร์เฟซการแก้ไขแบบเรียลไทม์ของ Etherpad ด้วย

การแก้ไขปัญหาข้อผิดพลาดทั่วไป

• บันทึกที่แชร์จะเปิดขึ้นใน BlockNoteยืนยันว่าการประชุมที่ใช้sharedNotesEditor=etherpadหรือที่sharedNotesEditor=etherpadมีอยู่ใน/etc/bigbluebutton/bbb-web.propertiesค่าเริ่มต้นทั่วโลก ในเวอร์ชัน 4.0 beta.4 ตรวจสอบว่าได้ติดตั้งแพ็กเกจเสริมสองแพ็กเกจแล้ว
• แผงบันทึกย่อหายไปหรือไม่โหลด เรียกใช้คำสั่งsudo bbb-conf --checkตรวจสอบสถานะของแพ็กเกจ และตรวจสอบบันทึกบริการ BigBlueButton และ Etherpad เพื่อหาข้อผิดพลาดในการเริ่มต้นหรือการเชื่อมต่อ ตรวจสอบให้แน่ใจว่าเบราว์เซอร์ใช้ชื่อโฮสต์และต้นทาง HTTPS ที่ปลอดภัยตามที่ต้องการ
• ผู้เข้าร่วมคนหนึ่งสามารถแก้ไขได้ แต่ผู้เข้าร่วมอีกคนไม่สามารถแก้ไขได้ ทดสอบด้วยการสร้างการประชุมใหม่และบัญชีจากเบราว์เซอร์ที่แยกจากกัน ตรวจสอบให้แน่ใจว่าผู้ใช้ทั้งสองเข้าร่วมการประชุมเดียวกัน และไม่มีพร็อกซีหรือเลเยอร์การตรวจสอบสิทธิ์ใดปิดกั้นเซสชันหรือการรับส่งข้อมูล WebSocket ของ Etherpad
• การเปลี่ยนแปลงจะไม่ปรากฏหลังจากแก้ไขการตั้งค่าสร้างการประชุมใหม่หลังจากรีสตาร์ท นอกจากนี้ ตรวจสอบด้วยว่าผู้สร้างการประชุมได้ส่งค่าตัวแก้ไขที่ระบุอย่างชัดเจนซึ่งแทนที่ค่าเริ่มต้นของเซิร์ฟเวอร์หรือไม่
• มันทำงานได้โดยตรง แต่จะล้มเหลวเมื่ออยู่หลังพร็อกซีเปรียบเทียบ URL ของบันทึกสาธารณะ เส้นทางพร็อกซี การตั้งค่า TLS ต้นทางที่อนุญาต และการกำหนดค่าคลัสเตอร์กับคู่มืออย่างเป็นทางการของคลัสเตอร์พร็อกซี หลีกเลี่ยงกฎพร็อกซีที่กว้างเกินไปซึ่งเปิดเผยบริการภายในที่ไม่เกี่ยวข้อง

การตรวจสอบการปฏิบัติงานและความปลอดภัย

หมั่นอัปเดต BigBlueButton, แพ็กเกจ Etherpad และระบบปฏิบัติการให้อยู่ในเส้นทางการอัปเดตที่รองรับ จำกัดการเข้าถึงข้อมูลลับ API สำหรับการดูแลระบบไว้เฉพาะโค้ดฝั่งเซิร์ฟเวอร์ที่เชื่อถือได้ ใช้ HTTPS สำหรับปลายทางสำหรับการประชุมสาธารณะและบันทึกย่อ และเปิดเผยเฉพาะเส้นทางที่จำเป็นสำหรับการใช้งานของคุณเท่านั้น หากบริการของคุณบันทึกการประชุม ให้ทดสอบวิธีการจัดการบันทึกย่อที่แชร์ในระหว่างการบันทึกและหลังจากสิ้นสุดการประชุม พฤติกรรมการบันทึกอาจขึ้นอยู่กับเวอร์ชันของ BigBlueButton และการกำหนดค่าการบันทึก

การกำหนดค่าจะเสร็จสมบูรณ์เมื่อการประชุมครั้งใหม่เลือกตัวแก้ไขที่ต้องการ ผู้เข้าร่วมหลายคนสามารถทำงานร่วมกันได้ คอนโซลของเบราว์เซอร์และบันทึกของเซิร์ฟเวอร์ไม่แสดงข้อผิดพลาดในการเชื่อมต่อ และผลลัพธ์ยังคงสอดคล้องกันหลังจากเปิดแผงบันทึกย่ออีกครั้ง สำหรับการใช้งานเวอร์ชัน 4.0 beta.4 การเปลี่ยนแปลงที่สำคัญคือ Etherpad ต้องติดตั้งเป็นส่วนประกอบเสริมและเลือกอย่างชัดเจน สำหรับเวอร์ชันอื่นๆ โปรดตรวจสอบแพ็กเกจและพฤติกรรม API กับเอกสารประกอบของเวอร์ชันนั้นก่อนที่จะเปลี่ยนแปลงเซิร์ฟเวอร์ที่ใช้งานจริง