วิธีการสำรองข้อมูลและกู้คืนฐานข้อมูล PostgreSQL ของ Matrix Synapse

การกู้คืน Synapse ที่เชื่อถือได้เริ่มต้นด้วยการสำรองข้อมูล PostgreSQL ที่สามารถอ่านได้ ฐานข้อมูลปลายทางที่สะอาด และไฟล์ homeserver ที่ตรงกัน สำหรับการติดตั้งฐานข้อมูลเดียวทั่วไป คู่มือการสำรองข้อมูลของ Synapse เองแนะนำรูปแบบการสำรองข้อมูลแบบกำหนดเองของ PostgreSQL และไม่รวมเนื้อหาของe2e_one_time_keys_json. กู้คืนลงในฐานข้อมูลใหม่ที่ว่างเปล่า อย่าสำรองข้อมูลทับตารางที่เหลือจากการติดตั้งครั้งก่อน จากนั้นตรวจสอบว่า Synapse เริ่มทำงานกับฐานข้อมูลที่กู้คืนแล้ว และมีสื่อในเครื่องและคีย์ลงนามอยู่หรือไม่

คู่มือนี้ใช้ระบบปฏิบัติการ Linux เป็นโฮสต์, ฐานข้อมูล PostgreSQL ชื่อ `<database_name>` synapseและบทบาทฐานข้อมูลชื่อ `<database_role> synapse_user` โปรดแทนที่ชื่อฐานข้อมูล บทบาท เส้นทางสำรองข้อมูล ชื่อบริการ และเส้นทางไฟล์กำหนดค่าด้วยชื่อฐานข้อมูลที่ใช้ในสภาพแวดล้อมของคุณ การใช้งาน Docker Compose, Kubernetes, PostgreSQL แบบจัดการ และการใช้งาน Synapse แบบหลายฐานข้อมูล จำเป็นต้องใช้คำสั่งที่เทียบเท่ากันสำหรับสภาพแวดล้อมนั้นๆ

สิ่งที่การสำรองข้อมูลฐานข้อมูลปกป้องได้ และสิ่งที่ไม่ได้ปกป้อง

pg_dumpการสำรองข้อมูลจะบันทึกฐานข้อมูล PostgreSQL หนึ่งฐานในรูปแบบสแนปช็อตที่สอดคล้องกัน ดังนั้น PostgreSQL และ Synapse จึงสามารถออนไลน์ได้ในขณะที่ทำการสำรองข้อมูล-Fcสามารถตรวจสอบและกู้คืน ไฟล์เก็บถาวรในรูปแบบที่กำหนดเอง pg_restoreได้ คู่มือของ Synapse แนะนำเป็นพิเศษให้ยกเว้นข้อมูลตารางที่มีคีย์แบบใช้ครั้งเดียว: การกู้คืนคีย์ที่ใช้แล้วเก่าอาจทำให้ไคลเอ็นต์ได้รับคีย์อีกครั้งและอาจนำไปสู่ข้อผิดพลาดในการถอดรหัสข้อความ คำจำกัดความของตารางอาจยังคงปรากฏในไฟล์เก็บถาวร เมื่อตรวจสอบรายการไฟล์เก็บถาวร ให้มองหาข้อมูลตารางแทนที่จะสันนิษฐานว่าตารางที่แสดงนั้นมีแถวอยู่

การสำรองข้อมูลฐานข้อมูลเพียงอย่างเดียวไม่ถือเป็นการสำรองข้อมูลโฮมเซิร์ฟเวอร์ที่สมบูรณ์ ควรเก็บรักษาhomeserver.yamlไฟล์ที่เกี่ยวข้องทั้งหมด รวมถึงคีย์ลงนามเซิร์ฟเวอร์ และไดเร็กทอรีจัดเก็บสื่อด้วย คู่มือการสำรองข้อมูลของ Synapse ระบุว่าสื่อที่อัปโหลดไปยังเครื่องภายในมีความสำคัญ เนื่องจากโฮมเซิร์ฟเวอร์อาจมีสำเนาเพียงชุดเดียว หากการกำหนดค่าของคุณใช้ฐานข้อมูลมากกว่าหนึ่งรายการ ควรวางแผนสำรองข้อมูลสำหรับฐานข้อมูลทุกรายการที่ Synapse ใช้

ก่อนที่คุณจะเริ่มต้น

• ตรวจสอบชื่อฐานข้อมูลที่กำหนดค่าไว้ ผู้ใช้ โฮสต์ พอร์ต และตรวจสอบว่า Synapse ใช้ฐานข้อมูลเดียวหรือหลายฐานข้อมูล
• ตรวจสอบว่ายูทิลิตี้ไคลเอ็นต์ PostgreSQL pg_dump, pg_restore, createdb, และpsqlได้รับการติดตั้งและใช้งานร่วมกับเซิร์ฟเวอร์ PostgreSQL ของคุณแล้ว
• เลือกสถานที่สำรองข้อมูลที่ปลอดภัยและมีพื้นที่ว่างเพียงพอ การสำรองข้อมูลอาจมีข้อความส่วนตัวและข้อมูลบัญชี ดังนั้นจึงควรจำกัดการเข้าถึงและเข้ารหัสข้อมูลสำรองทั้งในขณะจัดเก็บและในระหว่างการส่ง
• บันทึกไดเร็กทอรีการกำหนดค่า Synapse, เส้นทางคีย์ลงนาม และmedia_store_pathอื่นๆ สำรองข้อมูลลับโดยไม่เปิดเผยในประวัติคำสั่งเชลล์, แชท หรือบันทึกต่างๆ
• ตัดสินใจว่าจะทดสอบการกู้คืนอย่างไร การทดสอบการกู้คืนบนโฮสต์ที่แยกต่างหากหรือฐานข้อมูลทดสอบนั้นเป็นหลักฐานที่แข็งแกร่งกว่าการใช้คำสั่งดัมพ์ข้อมูลสำเร็จเพียงอย่างเดียว

สร้างและตรวจสอบการสำรองข้อมูล PostgreSQL

1. ยืนยันฐานข้อมูลเป้าหมายและบทบาท

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

2. สร้างไฟล์ดัมพ์ในรูปแบบที่กำหนดเอง

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

sudo -u postgres pg_dump -Fc \
  --exclude-table-data e2e_one_time_keys_json \
  synapse -f /var/backups/synapse/synapse.dump

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

3. ตรวจสอบไฟล์เก็บถาวรและบันทึกค่าตรวจสอบความถูกต้อง (checksum) ไว้

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

sudo -u postgres pg_restore --list /var/backups/synapse/synapse.dump
sha256sum /var/backups/synapse/synapse.dump

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

กู้คืนลงในฐานข้อมูลที่สะอาด

4. หยุดการทำงานของ Synapse และเตรียมปลายทางที่ว่างเปล่า

สำหรับการกู้คืนข้อมูล ให้หยุด Synapse ก่อน เพื่อป้องกันไม่ให้มันเชื่อมต่อใหม่ในขณะที่กำลังเปลี่ยนหรือทดสอบฐานข้อมูล ชื่อบริการด้านล่างนี้พบได้ทั่วไปในการติดตั้งแบบแพ็กเกจบางแบบ แต่ก็อาจแตกต่างกันไป ผู้ใช้ Docker ควรหยุดบริการ Synapse ผ่านโปรเจ็กต์ Compose ของตน และการใช้งานแบบ orchestrated deployment ควรใช้ขั้นตอนการบำรุงรักษาตามปกติ ไม่จำเป็นต้องหยุด PostgreSQL เอง

ใช้ฐานข้อมูลใหม่ที่ว่างเปล่าสำหรับการกู้คืน อย่ากู้คืนทับฐานข้อมูล Synapse ที่มีอยู่แล้วหรือฐานข้อมูลที่มีตารางอยู่แล้ว หากคุณต้องการเก็บรักษาฐานข้อมูลปัจจุบันไว้สำหรับการย้อนกลับ ให้คงฐานข้อมูลเดิมไว้และกู้คืนภายใต้ชื่อฐานข้อมูลชั่วคราว จากนั้นตรวจสอบความถูกต้องก่อนที่จะเปลี่ยนแปลงการกำหนดค่า Synapse

sudo -u postgres createdb \
  --encoding=UTF8 --locale=C --template=template0 \
  --owner=synapse_user synapse

ชื่อเจ้าของฐานข้อมูลและภาษาควรตรงกับข้อกำหนดของการตั้งค่า Synapse ของคุณ หากชื่อเป้าหมายมีอยู่แล้ว ให้หยุดและยืนยันว่าคุณต้องการใช้ฐานข้อมูลใด อย่าคิดว่าการลบฐานข้อมูลนั้นปลอดภัย สร้างบทบาท PostgreSQL ที่จำเป็นก่อน ฐานข้อมูลเดียวpg_dumpไม่รวมบทบาทระดับคลัสเตอร์ ดังนั้นผู้ดูแลระบบที่ย้ายไปยังคลัสเตอร์ PostgreSQL ใหม่ อาจต้องมีการสำรองข้อมูลส่วนกลางที่ได้รับการปกป้องแยกต่างหากpg_dumpall --globals-onlyด้วย

5. กู้คืนไฟล์เก็บถาวรและจัดการคีย์แบบใช้ครั้งเดียว

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

sudo -u postgres pg_restore --exit-on-error \
  --dbname=synapse /var/backups/synapse/synapse.dump

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

sudo -u postgres psql -d synapse \
  -c 'TRUNCATE e2e_one_time_keys_json;'

หากคุณใช้การยกเว้นที่แนะนำ การกู้คืนจะไม่รวมแถวคีย์ใช้ครั้งเดียวเก่า และขั้นตอนการตัดแต่งนี้จึงไม่จำเป็น รายการตารางในไฟล์เก็บถาวรpg_restore --listสามารถแสดงถึงคำจำกัดความของตารางโดยไม่มีข้อมูลได้ ตรวจสอบTABLE DATAรายการเมื่อตรวจสอบเนื้อหาของไฟล์เก็บถาวร บันทึกการทำงานที่ปลอดภัยที่สุดคือคำสั่งดัมพ์ที่ใช้จริง

นำ Synapse กลับมาใช้งานและตรวจสอบการกู้คืน

6. กู้คืนไฟล์ที่เกี่ยวข้องและเริ่มต้น Synapse

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

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

7. ทดสอบฟังก์ชันที่ผู้ใช้พึ่งพา

• ยืนยันว่า Synapse เริ่มทำงานได้โดยไม่มีข้อผิดพลาดเกี่ยวกับการย้ายฐานข้อมูล สิทธิ์การเข้าถึง ภาษา หรือการเชื่อมต่อ
• ลงชื่อเข้าใช้ด้วยบัญชีทดสอบและอ่านห้องที่มีอยู่ ส่งข้อความทดสอบหากแผนการบำรุงรักษาของคุณอนุญาต
• ตรวจสอบการทำงานของระบบ Federation และ Application-Service หากฟีเจอร์เหล่านั้นเป็นส่วนหนึ่งของการใช้งานของคุณ
• เปิดไฟล์แนบหรือรูปโปรไฟล์ที่อัปโหลดไว้ในเครื่องเพื่อทดสอบว่าที่เก็บสื่อตรงกับฐานข้อมูลที่กู้คืนแล้วหรือไม่
• ตรวจสอบบันทึกของ Synapse และบันทึกของ PostgreSQL เพื่อหาข้อผิดพลาดที่เกิดขึ้นซ้ำหลังจากเริ่มต้นระบบ ไม่ใช่แค่การตรวจสอบสถานะครั้งแรกที่สำเร็จเท่านั้น

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

สัญญาณบ่งชี้ความล้มเหลวที่พบบ่อยและเวลาที่ควรเปลี่ยนวิธีการ

การสำรองข้อมูลแบบลอจิก (Logical dump) นั้นพกพาสะดวกและตรงไปตรงมาสำหรับระบบขนาดเล็กและขนาดกลางจำนวนมาก แต่การกู้คืนอาจใช้เวลานานเมื่อฐานข้อมูลเติบโตขึ้น สำหรับบริการขนาดใหญ่หรือบริการที่มีความพร้อมใช้งานสูง โปรดศึกษาเอกสารการสำรองข้อมูลล่าสุดของ PostgreSQL และวางแผนการสำรองข้อมูลทางกายภาพที่ผ่านการทดสอบแล้ว หรือการออกแบบการกู้คืน ณ จุดเวลาใดเวลาหนึ่ง เก็บการสำรองข้อมูลแบบลอจิกแยกต่างหากหากต้องการความสะดวกในการพกพาหรือการตรวจสอบ วิธีการทั้งสองนี้ไม่สามารถปกป้องไฟล์ที่จัดเก็บไว้นอก PostgreSQL ได้ เว้นแต่จะมีการสำรองข้อมูลเหล่านั้นแยกต่างหาก

รายการตรวจสอบการกู้คืน

• ไฟล์ดัมพ์สามารถอ่านได้pg_restore --listและค่าตรวจสอบความถูกต้องตรงกับสำเนาที่จัดเก็บไว้ภายนอกเครื่อง
• การกู้คืนข้อมูลได้ดำเนินการไปยังฐานข้อมูลใหม่ที่ว่างเปล่า โดยมีการเข้ารหัส ภาษา เจ้าของ และบทบาทตามที่คาดไว้
• แถวที่มีคีย์ใช้ครั้งเดียวจะถูกยกเว้น หรือตารางจะถูกตัดทอนก่อนที่ Synapse จะเริ่มต้นใหม่
• ไฟล์การกำหนดค่า คีย์ลงนาม และสื่อบันทึกข้อมูลในเครื่องที่จำเป็น ได้รับการกู้คืนจากข้อมูลสำรองที่เข้ากันได้
• บันทึกของ Synapse สะอาดเพียงพอสำหรับการใช้งาน และการตรวจสอบระดับไคลเอ็นต์สำหรับห้องและสื่อต่างๆ ก็ผ่านเกณฑ์
• การทดสอบการกู้คืนระบบได้ยืนยันขั้นตอนการกู้คืนที่บันทึกไว้และวัดเวลาการกู้คืนจริงแล้ว

เอกสารอ้างอิงอย่างเป็นทางการ

• คู่มือการสำรองข้อมูล Synapse — คำแนะนำเฉพาะสำหรับฐานข้อมูล การจัดการคีย์ใช้ครั้งเดียว การกำหนดค่า คีย์ลงนาม และที่เก็บสื่อ
• Synapse: การใช้งาน PostgreSQL — รายละเอียดการตั้งค่าและการกำหนดค่าฐานข้อมูล
• PostgreSQL: pg_dump , pg_restoreและการสำรองและกู้คืนข้อมูลของ PostgreSQL — ตัวเลือกการเก็บถาวรและกลยุทธ์การสำรองข้อมูลที่ครอบคลุมมากขึ้น

เอกสารนี้ได้รับการตรวจสอบเมื่อวันที่ 6 ตุลาคม 2569 ชื่อคำสั่งและการจัดการบริการอาจแตกต่างกันไปตามระบบปฏิบัติการ รูปภาพคอนเทนเนอร์ เวอร์ชัน PostgreSQL และวิธีการติดตั้ง Synapse โปรดตรวจสอบคำแนะนำกับเอกสารสำหรับเวอร์ชันและวิธีการบรรจุที่คุณใช้งาน