วิธีตั้งค่าการหมดเวลาเมื่อไม่ได้ใช้งานสำหรับเซสชันการแก้ไขใน Collabora

Collabora Online มีการตั้งค่าหลายอย่างที่ฟังดูเหมือน "การหมดเวลาเมื่อไม่ได้ใช้งาน" แต่การตั้งค่าเหล่านี้ควบคุมพฤติกรรมที่แตกต่างกัน หากหน้าต่างแก้ไขมืดลงหรือหยุดอัปเดตในขณะที่ผู้ใช้ยังคงทำงานอยู่ ให้ปรับการตั้งค่าการไม่ใช้งานต่อมุมมอง หากเอกสารยังคงโหลดอยู่หลังจากทุกคนออกจากหน้าต่าง ให้ปรับการหมดเวลาต่อเอกสาร หากหน้าต่างแก้ไขตัดการเชื่อมต่อจริง ๆ ให้ตรวจสอบการหมดเวลาของ WebSocket ของพร็อกซีแบบย้อนกลับก่อนที่จะเปลี่ยนนโยบายการไม่ได้ใช้งานของ Collabora

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

เลือกการตั้งค่าตามลักษณะการทำงานที่คุณต้องการ

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

จุดเริ่มต้นที่แนะนำ

• ป้องกันไม่ให้แท็บที่ผู้ใช้ใช้งานอยู่จางลงเร็วเกินไป:เพิ่มระยะper_view.idle_timeout_secsเวลาจากค่าเริ่มต้นที่ติดตั้งไว้เป็นช่วงเวลาที่เหมาะสม เช่น 1,800 วินาที (30 นาที) นี่เป็นเพียงจุดเริ่มต้นที่ใช้งานได้จริง ไม่ใช่คำแนะนำที่ใช้ได้กับทุกกรณี
• อนุญาตให้ผู้ใช้สลับแท็บได้โดยที่เอกสารยังคงแสดงผลอย่างสม่ำเสมอ:ให้เพิ่มค่าความถี่ใน การรีเฟรช per_view.out_of_focus_timeout_secsแยกต่างหาก อย่าเพิ่มค่าความถี่เพียงเพราะผู้ใช้ไม่ได้ใช้งานในแท็บที่กำลังรีเฟรชอยู่
• ลดการใช้หน่วยความจำหลังจากละทิ้งเอกสาร:ปล่อยค่าต่อการดูแต่ละครั้งไว้ตามเดิม และพิจารณาลดค่าลงper_document.idle_timeout_secsหลังจากยืนยันแล้วว่าเอกสารนั้นไม่ได้ใช้งานจริง และการบันทึกข้อมูลลงพื้นที่จัดเก็บอยู่ในสภาพสมบูรณ์
• แก้ไขปัญหาการตัดการเชื่อมต่อที่เกิดขึ้นตามเวลาที่กำหนด:ตรวจสอบค่าหมดเวลาของ WebSocket ในพร็อกซี, อินเกรส หรือโหลดบาลานเซอร์ การเปลี่ยนการตั้งค่าการหรี่แสงต่อมุมมองจะไม่สามารถแก้ไขปัญหา WebSocket ที่พร็อกซีปิดไปได้
• รักษาการตั้งค่าการบันทึกบ่อยๆ:ปล่อยค่าการบันทึกเมื่อไม่ได้ใช้งานและการบันทึกอัตโนมัติไว้ที่การตั้งค่าปัจจุบัน เว้นแต่คุณจะมีเหตุผลอื่นที่ต้องเปลี่ยนแปลงค่าเหล่านั้น

เปลี่ยนการตั้งค่าในไฟล์ coolwsd.xml

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

สำรองไฟล์ที่ใช้งานอยู่ จากนั้นแก้ไขเฉพาะค่าที่เกี่ยวข้องในส่วนที่มีอยู่แล้ว<per_view>ตัวอย่าง<per_document>เช่น ข้อความที่ตัดตอนมานี้ตั้งค่าการหมดเวลาของผู้ใช้ที่ไม่ได้ใช้งาน 30 นาที การหมดเวลาของแท็บพื้นหลัง 15 นาที และการปิดเอกสารที่ไม่ได้ใช้งาน 2 ชั่วโมง:

<per_view>
    <idle_timeout_secs>1800</idle_timeout_secs>
    <out_of_focus_timeout_secs>900</out_of_focus_timeout_secs>
</per_view>
<per_document>
    <idle_timeout_secs>7200</idle_timeout_secs>
</per_document>

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

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

ตั้งค่าตัวเลือกเดียวกันทั้งใน Docker และ Kubernetes

ในอิมเมจ Docker ของ Collabora ผู้ดูแลระบบมักส่งผ่านตัวเลือกการกำหนดค่าโดยextra_paramsใช้--o:ไวยากรณ์ตัวเลือก ตัวอย่างค่าแบบ Compose ต่อไปนี้แสดงให้เห็นตัวอย่างเดียวกัน:

extra_params=--o:per_view.idle_timeout_secs=1800 --o:per_view.out_of_focus_timeout_secs=900 --o:per_document.idle_timeout_secs=7200

ใช้เฉพาะในกรณีที่อิมเมจและแผนผังการปรับใช้ของคุณรองรับเท่านั้นextra_paramsสำหรับ Kubernetes, Helm หรือการติดตั้งที่จัดการโดยโอเปอเรเตอร์ ให้ใส่ตัวเลือกในฟิลด์การกำหนดค่าที่รองรับของแผนผังหรือทรัพยากรแบบกำหนดเอง แทนที่จะแก้ไขไฟล์คอนเทนเนอร์ที่สร้างขึ้น เมื่อเปลี่ยนตัวแปรสภาพแวดล้อมใน Compose ให้สร้างหรือปรับใช้บริการใหม่เพื่อให้ค่าใหม่ไปถึงคอนเทนเนอร์ การรีสตาร์ทธรรมดาอาจใช้การกำหนดค่าคอนเทนเนอร์ที่มีอยู่แล้วซ้ำ

อย่าตั้งค่าตัวเลือกเดียวกันในตำแหน่งที่ขัดแย้งกัน เช่น ทั้งในไฟล์ XML ที่ติดตั้งและพารามิเตอร์สภาพแวดล้อม โดยไม่ตรวจสอบกฎลำดับความสำคัญสำหรับเวอร์ชันนั้นเสียก่อน หลังจากปรับใช้ใหม่แล้ว ให้ตรวจสอบบันทึกการเริ่มต้นคอนเทนเนอร์และการกำหนดค่าที่ใช้งานอยู่คลังซอร์สโค้ด ของโครงการ Collabora และเอกสารการปรับใช้ที่ตรงกับเวอร์ชันนั้นเป็นข้อมูลอ้างอิงที่เหมาะสมเมื่อชื่อตัวเลือกหรือพฤติกรรมของคอนเทนเนอร์แตกต่างกัน

ตรวจสอบเวลาหมดอายุของรีเวิร์สพร็อกซีแยกต่างหาก

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

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

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

ทดสอบการหมดเวลาทีละครั้ง

1. บันทึกค่าปัจจุบันจากการกำหนดค่าที่ใช้งานอยู่ และจดบันทึกเวอร์ชัน Collabora และวิธีการปรับใช้ของคุณ
2. เปิดเอกสารทดสอบด้วยผู้ใช้สองคนหรือเซสชันเบราว์เซอร์สองเซสชัน เพื่อให้คุณสามารถสังเกตมุมมองทั้งแบบที่ใช้งานอยู่และแบบที่ไม่ได้ใช้งานได้
3. เปลี่ยนเฉพาะค่าหมดเวลาที่ตรงกับอาการเท่านั้น ตัวอย่างเช่น เพื่อป้องกันหน้าจอมืดลงในแท็บที่กำลังใช้งานอยู่แต่ไม่มีเสียงรบกวน ให้ปรับ เฉพาะค่า per_view.idle_timeout_secsหมดเวลาเท่านั้น
4. รีสตาร์ทหรือปรับใช้ใหม่โดยใช้วิธีการที่รองรับ จากนั้นตรวจสอบว่าค่าใหม่ปรากฏในการกำหนดค่าที่ใช้งานอยู่หรือบันทึกการเริ่มต้นระบบหรือไม่
5. รอจนพ้นช่วงเวลาที่กำหนดไว้ก่อนหน้านี้ ตรวจสอบว่าหน้าจอยังคงหรี่ลงหรือไม่ ผู้ใช้คนที่สองยังคงได้รับการอัปเดตหรือไม่ และการแก้ไขยังคงบันทึกอยู่หรือไม่
6. ปิดมุมมองทั้งหมดของเอกสารทดสอบ และสังเกตว่าเอกสารที่ไม่ได้ใช้งานนั้นถูกปิดภายในช่วงที่กำหนดหรือไม่
7. ตรวจสอบบันทึกของ Collabora และพร็อกซีเพื่อหาการปิด WebSocket ข้อผิดพลาดในการแยกวิเคราะห์ XML การบันทึกที่ไม่สำเร็จ หรือการล้างกระบวนการที่ไม่คาดคิด

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

สร้างสมดุลระหว่างความสะดวกสบาย การใช้ทรัพยากร และความน่าเชื่อถือ

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

สำหรับการใช้งานส่วนใหญ่ ให้เปลี่ยนแปลงการตั้งค่าให้น้อยที่สุดเท่าที่จำเป็นเพื่อให้ตรงกับพฤติกรรมที่สังเกตได้ รักษาช่วงเวลาการบันทึกไว้ กำหนดช่วงเวลาที่ไม่ใช้งานต่อมุมมองที่เหมาะสมสำหรับทีม คงค่าหมดเวลาของแท็บพื้นหลังไว้ตามที่ต้องการ และปรับแต่งขีดจำกัดของพร็อกซี WebSocket เฉพาะเมื่อบันทึกหรือเวลาบ่งชี้ว่ามีปัญหาที่เลเยอร์การเชื่อมต่อ ตรวจสอบเทมเพลตการกำหนดค่าของเวอร์ชันที่ติดตั้งอีกครั้งหลังจากการอัปเกรด เนื่องจากค่าเริ่มต้นและการตั้งค่าที่รองรับอาจเปลี่ยนแปลงได้