ในการทำให้โฮมเซิร์ฟเวอร์ Matrix Synapse ทำงานแบบเฟเดอเรต (federate) คุณต้องทำให้ชื่อเซิร์ฟเวอร์สามารถค้นพบและเข้าถึงได้จากอินเทอร์เน็ตสาธารณะผ่าน HTTPS จากนั้นจึงกำหนดเส้นทางการร้องขอระหว่างเซิร์ฟเวอร์ Matrix ไปยัง Synapse ในการตั้งค่าทั่วไป รีเวิร์สพร็อกซีจะจัดการ TLS บนพอร์ต 443 และ/.well-known/matrix/serverไฟล์จะชี้โดเมน Matrix ของคุณไปยังพร็อกซีนั้น หาก Synapse ตอบรับบนโดเมนชื่อเซิร์ฟเวอร์ของคุณที่พอร์ต 8448 อยู่แล้ว คุณอาจไม่จำเป็นต้องทำการมอบหมายสิทธิ์ (delegation)
คู่มือนี้ใช้example.comชื่อเซิร์ฟเวอร์ Matrix ถาวรเป็น `<ชื่อเซิร์ฟเวอร์>` และmatrix.example.comใช้ชื่อเครื่องหรือปลายทางพร็อกซีเป็น `<ชื่อปลายทาง>` แทน `<ชื่อเครื่องหรือปลายทางพร็อกซี>` ด้วยชื่อของคุณเอง โฮมเซิร์ฟเวอร์จะจัดเก็บบัญชีและห้องต่างๆ ของ Matrix การเชื่อมต่อแบบเฟเดอเรชันช่วยให้โฮมเซิร์ฟเวอร์สามารถสื่อสารกันได้ DNS กฎไฟร์วอลล์ ไวยากรณ์พร็อกซี เครือข่ายคอนเทนเนอร์ และใบรับรองขึ้นอยู่กับโฮสต์ของคุณ
ก่อนที่คุณจะเปลี่ยนการตั้งค่า
ตัดสินใจว่า Matrix ID ของผู้ใช้ควรมีลักษณะ@name:example.comอย่างไร@name:matrix.example.comค่าของserver_nameในhomeserver.yamlจะกลายเป็นส่วนหนึ่งของ Matrix ID และที่อยู่ห้อง เอกสารการติดตั้งของ Synapse ระบุว่าให้เลือกค่านี้ก่อนการติดตั้ง เนื่องจากไม่สามารถเปลี่ยนแปลงได้ในภายหลังโดยไม่มีผลกระทบ หากใช้งาน Synapse อยู่แล้ว อย่าเปลี่ยนค่าเพียงเพื่อให้ตรงกับที่อยู่เว็บ ให้ใช้การมอบหมายเพื่อรักษา ID ที่มีอยู่เดิม
ชื่อเซิร์ฟเวอร์เป็นส่วนหนึ่งของ Matrix ID ดังนั้นโปรดยืนยันก่อนดำเนินการต่อ
ก่อนทำการแก้ไข โปรดตรวจสอบให้แน่ใจว่าคุณสามารถเข้าถึง Synapse, พร็อกซี และ DNS สาธารณะได้ และมีใบรับรอง TLS ที่ถูกต้องสำหรับปลายทางของเฟเดอเรชัน สำรองhomeserver.yamlข้อมูลคีย์ลงนาม ซึ่งใช้ในการสร้างตัวตนของโฮมเซิร์ฟเวอร์ เก็บรักษาคีย์นั้นไว้ให้ปลอดภัย การตั้งค่าเฟเดอเรชันตามปกติไม่จำเป็นต้องสร้างคีย์ใหม่
จัดตั้งเส้นทางสาธารณะ
1. ยืนยันตัวรับฟัง HTTP ของ Synapse
โดยทั่วไป Synapse จะรับฟังการรับส่งข้อมูล HTTP บนพอร์ต8008ที่อยู่เบื้องหลังพร็อกซีแบบย้อนกลับ ในตัวรับฟังที่รับx_forwarded: trueการรับส่งข้อมูลจากพร็อกซี ให้ตั้งค่าเพื่อให้ Synapse สามารถใช้ที่อยู่ไคลเอ็นต์และรูปแบบที่พร็อกซีส่งต่อมาได้ พร็อกซีต้องตั้งค่าส่วนหัวที่เหมาะสมX-Forwarded-Forแทนที่จะX-Forwarded-Protoส่งค่าแบบสุ่มที่ไคลเอ็นต์ภายนอกส่งมา
ตัวรับฟังจะรับ HTTP จากพร็อกซีภายในเครื่องและเปิดใช้งานการจัดการส่วนหัวที่ส่งต่อของ Synapse
การผูกกับที่อยู่ IP 127.0.0.1ที่เหมาะสมนั้นเหมาะสำหรับกรณีที่พร็อกซีทำงานอยู่บนโฮสต์เดียวกัน ไม่เหมาะสมหากพร็อกซีอยู่ในคอนเทนเนอร์หรือเครื่องอื่น เว้นแต่ว่าที่อยู่ดังกล่าวจะสามารถเข้าถึงได้จากพร็อกซี ในการใช้งานแบบคอนเทนเนอร์ ให้ใช้ที่อยู่เครือข่ายหรือชื่อบริการที่พร็อกซีสามารถเข้าถึงได้ และจำกัดการเข้าถึงผ่านเครือข่ายคอนเทนเนอร์หรือไฟร์วอลล์ คงโครงสร้างตัวรับฟังที่มีอยู่และแก้ไขค่าที่เกี่ยวข้อง อย่าคัดลอกส่วนใดส่วนหนึ่งไปวางทับส่วนที่เหลือของการกำหนดค่าโดยไม่ดูข้อมูล
2. กำหนดเส้นทางเมทริกซ์ผ่านพร็อกซี
กำหนดค่าโฮสต์เสมือน HTTPS ของพร็อกซีให้ส่งต่อทั้งสองเส้นทาง/_matrixไป/_synapse/clientยังตัวรับฟัง HTTP ของ Synapse เส้นทางแรกใช้สำหรับ API ของ Matrix รวมถึงการรวมระบบ ส่วนเส้นทางที่สองใช้สำหรับปลายทางไคลเอ็นต์ของ Synapse ปฏิบัติตามตัวอย่างอย่างเป็นทางการสำหรับซอฟต์แวร์พร็อกซีของคุณ รักษาเส้นทางคำขอ และส่งส่วนหัวที่ส่งต่อซึ่ง Synapse คาดหวังไว้ อย่าทำการปรับให้เป็นมาตรฐาน ถอดรหัส หรือเขียนเส้นทาง URI ใหม่: ลายเซ็นคำขอของ Matrix อาจล้มเหลวหากพร็อกซีเปลี่ยนแปลงเส้นทางที่เข้ารหัส
พร็อกซีต้องส่งผ่านเส้นทาง API ของ Matrix ทั้งสองเส้นทางไปยัง Synapse โดยไม่เขียน URI ใหม่
การตั้งค่าที่แน่นอนจะแตกต่างกันไปตาม Nginx, Caddy, Apache, โหลดบาลานเซอร์ และบริการโฮสติ้งแบบจัดการ ให้ใช้ไวยากรณ์ปัจจุบันของผู้ให้บริการและเอกสารประกอบการใช้งาน Synapse reverse-proxyเป็นข้อมูลอ้างอิง กฎพร็อกซีที่ให้บริการเว็บไคลเอ็นต์แต่ละเลยเส้นทาง API ของเฟเดอเรชันนั้นไม่เพียงพอ
3. ตรวจสอบให้แน่ใจว่า DNS, HTTPS และพอร์ตที่เลือกนั้นตรงกัน
ตัวอย่างเช่นmatrix.example.comต้องระบุเส้นทางไปยังพร็อกซีหรือโหลดบาลานเซอร์ และพอร์ต443ต้องสามารถเข้าถึงได้จากภายนอก พร็อกซีจำเป็นต้องมีใบรับรองที่ถูกต้องสำหรับmatrix.example.comหากคุณให้บริการเฟเดอเรชันโดยตรงที่example.com:8448ให้เผยแพร่เส้นทางและใบรับรองนั้น และเปิดพอร์ต8448ใช้พอร์ต 8448 โดยตรง ซึ่งเป็นค่าเริ่มต้นทั่วไป หรือมอบหมายไปยังโฮสต์และพอร์ตอื่น เช่น 443
ตรวจสอบความถูกต้องของ DNS, ไฟร์วอลล์ หรือกฎกลุ่มความปลอดภัยบนคลาวด์ และใบรับรองจากภายนอกเครือข่ายส่วนตัวของคุณ หากมี CDN หรืออุโมงค์อยู่ด้านหน้า การรองรับทราฟฟิก Matrix ที่ต้องการนั้นขึ้นอยู่กับการกำหนดค่าปัจจุบันของบริการนั้นๆ ตรวจสอบเอกสารประกอบและทดสอบเส้นทางจริงแทนที่จะสันนิษฐานว่าใช้งานร่วมกันได้
เผยแพร่การค้นพบสหพันธ์เมื่อจำเป็น
4. เพิ่มการมอบหมายเซิร์ฟเวอร์สำหรับเอนด์พอยต์แยกต่างหาก
หากโดเมน Matrix ID คือexample.comแต่สามารถเข้าถึง Synapse ได้ที่matrix.example.com:443ให้ส่ง JSON นี้ผ่าน HTTPS ที่https://example.com/.well-known/matrix/server:
{
"m.server": "matrix.example.com:443"
}
บันทึกการค้นหาแบบเฟเดอเรชันนี้มอบหมาย example.com ไปยังเอนด์พอยต์ HTTPS ที่ matrix.example.com บนพอร์ต 443
ในตัวอย่างนี้ พอร์ต 443 ถูกระบุไว้อย่างชัดเจน หากคุณละเว้นพอร์ต การค้นหาของ Matrix จะใช้พอร์ต 8448 เป็นค่าเริ่มต้น อย่าสับสนไฟล์นี้กับไฟล์/.well-known/matrix/clientที่ช่วยให้ไคลเอ็นต์ค้นหา API ระหว่างไคลเอ็นต์และเซิร์ฟเวอร์ และแยกต่างหากจากการเชื่อมโยงเซิร์ฟเวอร์ต่อเซิร์ฟเวอร์ Synapse สามารถให้บริการไฟล์ที่เซิร์ฟเวอร์รู้จักได้เองเมื่อโดเมนชื่อเซิร์ฟเวอร์ถูกกำหนดเส้นทางโดยตรงไปยัง Synapse แต่หากใช้เอนด์พอยต์แยกต่างหาก คุณมักจะเผยแพร่ไฟล์นั้นบนเว็บเซิร์ฟเวอร์ของโดเมนชื่อเซิร์ฟเวอร์
การค้นหาเครือข่ายแบบเฟเดอเรชันถูกกำหนดโดย Matrix และมีเอกสารอธิบายโดย Synapse ข้อกำหนดของ Matrix อนุญาตให้ค้นหาผ่าน/.well-known/matrix/server; ตรวจสอบคำแนะนำการมอบหมายของ Synapseก่อนเลือกวิธีการอื่น เช่น ระเบียน SRV ซึ่งส่งผลต่อความคาดหวังของ TLS ด้วย
ทดสอบจากภายนอกเซิร์ฟเวอร์
5. ตรวจสอบบันทึก จากนั้นทำการตรวจสอบการเชื่อมโยงเครือข่าย
ร้องขอ URL สำหรับการค้นหาจากเครื่องภายนอกเครือข่ายส่วนตัวของเซิร์ฟเวอร์ ควรส่งคืนออบเจ็กต์ JSON ด้านบนผ่าน HTTPS โดยไม่มีหน้าล็อกอิน การเปลี่ยนเส้นทาง HTML คำเตือนเกี่ยวกับใบรับรอง หรือเว็บไซต์ที่ไม่เกี่ยวข้อง จากนั้นตรวจสอบว่าชื่อโฮสต์ที่ได้รับมอบหมายสามารถใช้งานได้ ใบรับรองถูกต้อง และพอร์ตที่ประกาศไว้สามารถเข้าถึง Synapse ได้ ใช้เครื่องมือตรวจสอบการกำหนดค่าและขั้นตอนการรีโหลดของพร็อกซีของคุณก่อนทำการทดสอบ
สุดท้ายนี้ ให้ป้อนชื่อเซิร์ฟเวอร์ของคุณ (ตัวอย่างเช่นexample.comไม่ใช่ชื่อโฮสต์ที่ได้รับมอบหมาย เว้นแต่ว่านั่นคือเซิร์ฟเวอร์ของคุณserver_name) ในโปรแกรมทดสอบการเชื่อมต่อเครือข่าย Matrix Federation Tester อย่างเป็นทางการคู่มือการใช้งาน Synapse federation ยังแนะนำให้ทดสอบโดยการเข้าร่วมห้องสาธารณะ เช่นการตรวจสอบ#synapse:matrix.orgที่สำเร็จจะยืนยันว่าการตรวจสอบการค้นหาและการเข้าถึงทั่วไปผ่านแล้ว แต่ไม่ได้รับประกันว่าเซิร์ฟเวอร์ระยะไกลทุกเครื่องหรือการทำงานของห้องทุกห้องจะทำงานได้ เนื่องจากนโยบายระยะไกลและสภาพเครือข่ายแตกต่างกันไป
หากโปรแกรมทดสอบรายงานว่าไม่สามารถเข้าถึงเซิร์ฟเวอร์ของคุณได้ โปรดตรวจสอบโดเมนและพอร์ตที่โปรแกรมลองใช้, DNS, กฎไฟร์วอลล์, ชื่อใบรับรอง, เส้นทางพร็อกซี, ส่วนหัวที่ส่งต่อ และตรวจสอบว่าการเปลี่ยนเส้นทางได้เปลี่ยนแปลงคำขอหรือไม่ เอกสารประกอบการใช้งาน Synapse federation ในปัจจุบันได้เตือนไว้อย่างชัดเจนว่าเซิร์ฟเวอร์ federation ของ Synapse อาจไม่ปฏิบัติตามการเปลี่ยนเส้นทาง HTTP 308 ในบางกรณี หลีกเลี่ยงการพึ่งพาการเปลี่ยนเส้นทาง 308 สำหรับปลายทาง federation และทดสอบอีกครั้งหลังจากแก้ไขแล้ว โปรดดูเอกสารประกอบที่ตรงกับเวอร์ชัน Synapse ที่คุณติดตั้งไว้สำหรับพฤติกรรมเฉพาะเวอร์ชัน
การเชื่อมต่อแบบเฟเดอเรชันจำเป็นต้องให้โฮมเซิร์ฟเวอร์ระยะไกลค้นหาและเข้าถึง API ของเฟเดอเรชันของคุณ ไม่สามารถทราบได้ว่าการทำงานนี้จะใช้ได้กับทุกเซิร์ฟเวอร์ระยะไกลหรือไม่จากเพียงแค่การตั้งค่า โปรดตรวจสอบเส้นทางด้วยโปรแกรมทดสอบและการเข้าร่วมห้องจริง จากนั้นจึงตรวจสอบจุดเชื่อมต่อหรือข้อผิดพลาดที่ล้มเหลวโดยเฉพาะ
แผงอินเทอร์เฟซเหล่านี้เป็นเพียงตัวอย่างแผนผังของข้อมูลการกำหนดค่าและการค้นหา ไม่ใช่ภาพหน้าจอจากเซิร์ฟเวอร์ที่ใช้งานจริง ข้อมูลอ้างอิงได้รับการตรวจสอบเมื่อวันที่ 10 ตุลาคม 2569