ติดตั้ง Element Web บน Nginx ด้วยโฮมเซิร์ฟเวอร์แบบกำหนดเอง

ในการโฮสต์ไคลเอ็นต์ Element Web แบบกำหนดเองบน Nginx ให้ดาวน์โหลด Element Web เวอร์ชันที่สร้างไว้ล่วงหน้าอย่างเป็นทางการ วางไฟล์คงที่ไว้บนเว็บเซิร์ฟเวอร์ของคุณ กำหนดค่าconfig.jsonด้วยโฮมเซิร์ฟเวอร์ Matrix ของคุณ และให้บริการเว็บไซต์ผ่าน HTTPS Nginx ไม่ได้รัน Element เอง: มันให้บริการไฟล์แอปเบราว์เซอร์ ในขณะที่แอปเชื่อมต่อกับโฮมเซิร์ฟเวอร์ Matrix ของคุณแยกต่างหาก ใช้ชื่อโฮสต์ที่แตกต่างกันสำหรับไคลเอ็นต์และโฮมเซิร์ฟเวอร์เช่นchat.example.comและmatrix.example.com

คู่มือนี้สมมติว่าใช้ Debian หรือ Ubuntu, เซิร์ฟเวอร์ Nginx ที่มีชื่อ DNS สาธารณะ และโฮมเซิร์ฟเวอร์ Matrix ที่สามารถเข้าถึงได้ผ่าน HTTPS โดยใช้เวอร์ชันที่เผยแพร่อย่างเป็นทางการแทนเวอร์ชันสำหรับการพัฒนา เอกสารโครงการปัจจุบันของ Element อธิบายว่าเว็บแอปที่ติดตั้งใช้งานเป็นเนื้อหาแบบคงที่ และต้องมีการกำหนดค่าคีย์และ URL จุดเริ่มต้นเพื่อหลีกเลี่ยงการแคช โปรดตรวจสอบบันทึกการเผยแพร่และเอกสารการกำหนดค่าปัจจุบันเมื่อเลือกเวอร์ชันหรือเปลี่ยนแปลงตัวเลือกต่างๆ

1. เตรียมชื่อโฮสต์และเซิร์ฟเวอร์

สร้างเรคอร์ด A เพื่อchat.example.comชี้ไปยังที่อยู่ IPv4 สาธารณะของเซิร์ฟเวอร์ Nginx เพิ่มเรคอร์ด AAAA เฉพาะในกรณีที่สามารถเข้าถึงเซิร์ฟเวอร์ผ่าน IPv6 ได้เท่านั้น อนุญาตพอร์ต TCP ขาเข้า 80 และ 443 ผ่านไฟร์วอลล์ของโฮสต์และไฟร์วอลล์ของระบบคลาวด์ ตรวจสอบให้แน่ใจว่าพอร์ตเหล่านี้ไม่ได้ถูกใช้งานโดยเว็บเซิร์ฟเวอร์อื่นอยู่แล้ว

ติดตั้ง Nginx และสร้างไดเร็กทอรีสำหรับเว็บแอปพลิเคชัน:

sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element

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

2. ติดตั้งไฟล์คงที่และตั้งค่าโฮมเซิร์ฟเวอร์

แตกไฟล์เก็บถาวรของเวอร์ชันลงในไดเร็กทอรีชั่วคราวก่อน ตรวจสอบโครงสร้างระดับบนสุดของไฟล์เก็บถาวร จากนั้นคัดลอกไฟล์เว็บลงในไดเร็กทอรีนั้น/var/www/elementโดยรักษาโครงสร้างไดเร็กทอรีของเวอร์ชันนั้นไว้ โครงสร้างของแพ็กเกจอาจเปลี่ยนแปลงได้ ดังนั้นตรวจสอบให้แน่ใจว่าindex.htmlไฟล์ , bundles i18n, และไฟล์การกำหนดค่าอยู่ในตำแหน่งที่ไดเร็กทอรีหลักของ Nginx ชี้ไป

sudo mkdir -p /tmp/element-release
tar -xzf /tmp/element-web-REPLACE_WITH_RELEASE.tar.gz -C /tmp/element-release
find /tmp/element-release -maxdepth 2 -name index.html

ใช้ไดเร็กทอรีที่มี ไฟล์ต้นฉบับ index.htmlเป็นแหล่งที่มาเมื่อคัดลอกเนื้อหาของเวอร์ชันไปยัง/var/www/elementไดเร็กทอรีปลายทาง หากไฟล์เก็บถาวรมีไดเร็กทอรีระดับบนสุดที่มีการกำหนดเวอร์ชันเพียงไดเร็กทอรีเดียว ให้คัดลอกเนื้อหาของไดเร็กทอรีนั้นแทนที่จะสร้างระดับย่อยเพิ่มเติม อย่าแทนที่การใช้งานจริงจนกว่าไฟล์ใหม่จะเสร็จสมบูรณ์ การคัดลอกที่ไม่สมบูรณ์อาจทำให้ผู้ใช้ขาดชุด JavaScript ได้

คัดลอกไฟล์เวอร์ชันconfig.sample.jsonไปยัง โฟลเดอร์ config.jsonที่ต้องการ หากไฟล์เก็บถาวรมีให้ จากนั้นแก้ไขไฟล์ใหม่ Element ต้องการการตั้งค่าการเชื่อมต่อโฮมเซิร์ฟเวอร์เริ่มต้นเพื่อเริ่มการทำงาน รูปแบบที่แนะนำคือdefault_server_configโดยใช้ URL พื้นฐานของ API ไคลเอ็นต์ ตัวอย่างด้านล่างเป็นเพียงตัวอย่างประกอบ โปรดแทนที่ URL ด้วย URL จริงที่ให้บริการโดยโฮมเซิร์ฟเวอร์ Matrix ของคุณ:

{
  "default_server_config": {
    "m.homeserver": {
      "base_url": "https://matrix.example.com"
    }
  },
  "brand": "Example Chat"
}

เอกสารการกำหนดค่าของ Element ยังรองรับdefault_server_nameซึ่งอาศัย.well-knownการค้นหาของ Matrix ใช้default_server_configเมื่อคุณต้องการระบุ URL ของโฮมเซิร์ฟเวอร์โดยตรง อย่าใส่รหัสผ่าน โทเค็นการเข้าถึง คีย์ลงนาม หรือความลับอื่นๆ ในไฟล์ JSON สาธารณะนี้brandตัวเลือกนี้เปลี่ยนป้ายกำกับแอปบางส่วน ไม่ใช่การรีแบรนด์แบบไวท์เลเบลโดยสมบูรณ์

3. ตั้งค่า Nginx สำหรับแอปพลิเคชัน

สร้างบล็อกเซิร์ฟเวอร์ Nginx เช่น/etc/nginx/sites-available/element. แทนที่โดเมนหากจำเป็น การกำหนดค่าอย่างง่ายนี้จะให้บริการ Element เป็นไฟล์คงที่และส่งเส้นทางที่ขาดหายไปไปยังindex.htmlพร้อมทั้งทำเครื่องหมายการตอบกลับทั้งหมดเพื่อตรวจสอบความถูกต้องอีกครั้ง นโยบายแคชแบบอนุรักษ์นิยมนี้จะช่วยป้องกันไม่ให้ผู้ใช้ได้รับแอปพลิเคชันหรือการกำหนดค่าที่ล้าสมัยหลังจากการเผยแพร่ คุณสามารถปรับแต่งการแคชสินทรัพย์ได้ในภายหลังหากกระบวนการปรับใช้ของคุณยังคงรักษาเส้นทางที่ไม่ต้องแคชที่จำเป็นของ Element ไว้

server {
    listen 80;
    listen [::]:80;
    server_name chat.example.com;

    root /var/www/element;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
        add_header Cache-Control "no-cache" always;
        add_header X-Frame-Options SAMEORIGIN always;
        add_header X-Content-Type-Options nosniff always;
        add_header Content-Security-Policy "frame-ancestors 'self'" always;
    }
}

หมายเหตุเกี่ยวกับการโฮสต์เว็บของ Element ระบุว่าไม่ควรแคช/config.*.json, /i18n, /version, หรือ/index.htmlและแนะนำให้ตรวจสอบความถูกต้องของเบราว์เซอร์อีกครั้งเมื่อโหลดหน้าเว็บ ตัวอย่างนี้ใช้ได้no-cacheกับทุกอย่างเป็นจุดเริ่มต้นที่ตรงไปตรงมา นอกจากนี้ยังรวมถึงส่วนหัวด้านความปลอดภัยที่ Element แนะนำ เช่น นโยบายเฟรมและการป้องกันการตรวจสอบ MIME หากคุณกำหนดนโยบายความปลอดภัยของเนื้อหาไว้ที่อื่นแล้ว ให้รวมframe-ancestors 'self'เข้ากับนโยบายนั้นแทนที่จะส่งนโยบายที่ขัดแย้งกัน

เปิดใช้งานเว็บไซต์และตรวจสอบความถูกต้องของ Nginx ก่อนที่จะโหลดหน้าเว็บใหม่:

sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx

4. เพิ่ม HTTPS และทดสอบฝั่งไคลเอ็นต์

ควรให้บริการ Element ผ่าน HTTPS เมื่อ DNS ชี้ไปยังเซิร์ฟเวอร์นี้และสามารถเข้าถึงพอร์ต 80 ได้แล้ว ให้ติดตั้ง Certbot โดยใช้คำแนะนำปัจจุบันสำหรับระบบปฏิบัติการของคุณ จากนั้นขอและติดตั้งใบรับรองโดยใช้การทำงานร่วมกับ Nginx โครงการ Certbot ได้จัดทำเอกสารcertbot --nginxขั้นตอนและวิธีการตรวจสอบการต่ออายุไว้ การติดตั้งแพ็กเกจจะแตกต่างกันไปตามระบบปฏิบัติการ ดังนั้นโปรดใช้คำแนะนำ Nginx ปัจจุบันสำหรับเวอร์ชันของคุณ หาก Certbot แก้ไขบล็อกเซิร์ฟเวอร์ ให้เรียกใช้sudo nginx -tอีกครั้งและยืนยันว่าได้กำหนดเวลาการต่ออายุไว้แล้ว

เปิดhttps://chat.example.comในหน้าต่างเบราว์เซอร์แบบส่วนตัว หน้าจอเข้าสู่ระบบ Element ควรโหลดได้โดยไม่มีสคริปต์หรือสไตล์ใดๆ หายไป แสดงโฮมเซิร์ฟเวอร์ที่คุณคาดหวัง และมีไอคอนรูปกุญแจที่ถูกต้องในแถบที่อยู่ของเบราว์เซอร์ เข้าสู่ระบบด้วยบัญชีทดสอบและยืนยันว่าเบราว์เซอร์สามารถเข้าถึงโฮมเซิร์ฟเวอร์ได้ หากการเข้าสู่ระบบล้มเหลว ให้ตรวจสอบคอนโซลสำหรับนักพัฒนาของเบราว์เซอร์และแผงเครือข่ายเพื่อหาคำขอที่ถูกบล็อก ข้อผิดพลาดของใบรับรอง หรือbase_url. ที่ไม่ถูกต้อง

ปัญหาการใช้งานทั่วไป

  • หน้าเว็บว่างเปล่าหรือโหลดไม่สมบูรณ์:ตรวจสอบว่า Nginx rootชี้ไปยังไดเร็กทอรีที่มีไฟล์index.htmlและตรวจสอบว่าไฟล์ bundles และi18nไดเร็กทอรีนั้นถูกคัดลอกไปพร้อมกันด้วย
  • ปรากฏว่าพบโฮมเซิร์ฟเวอร์ที่ไม่ถูกต้อง:ตรวจสอบความถูกต้องของไวยากรณ์ JSON config.jsonและยืนยันว่าไฟล์นั้นอยู่ที่รูทของเว็บ หากคุณกำหนดค่าเฉพาะโดเมนconfig.chat.example.com.jsonElement จะลองใช้ไฟล์นั้นก่อนconfig.jsonไฟล์จะไม่ถูกรวมเข้าด้วยกัน
  • ผู้ใช้จะเห็นการตั้งค่าเก่าหลังจากการอัปเดต:ตรวจสอบให้แน่ใจว่าindex.html, version, i18n, และไฟล์ JSON การกำหนดค่าไม่ได้ถูกแคชไว้ ล้างหรือตรวจสอบความถูกต้องของแคชเบราว์เซอร์อีกครั้งหลังจากเปลี่ยนนโยบาย Nginx
  • หน้าล็อกอินโหลดได้ แต่การร้องขอ API ล้มเหลว:ตรวจสอบว่า URL ของโฮมเซิร์ฟเวอร์ถูกต้อง ใช้ HTTPS และได้รับการกำหนดค่าสำหรับการเข้าถึงผ่านเบราว์เซอร์ รวมถึงพฤติกรรม CORS ที่เหมาะสมในกรณีที่จำเป็น Hosting Element บน Nginx ไม่ได้ทำหน้าที่เป็นพร็อกซีหรือแทนที่โฮมเซิร์ฟเวอร์ของ Matrix

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

ฝากความเห็น

กู้คืน Matrix Synapse อย่างปลอดภัยด้วยการสำรองข้อมูล PostgreSQL

สำรองข้อมูล Synapse ด้วย pg_dump ป้องกันคีย์ลงนามและสื่อบันทึกข้อมูล และกู้คืนลงในฐานข้อมูล PostgreSQL ที่สะอาดโดยไม่ใช้คีย์แบบใช้ครั้งเดียวที่หมดอายุแล้ว

เรียกใช้ Mjölnir เป็นบอทควบคุมห้องสนทนาใน Matrix ด้วย Docker

เรียกใช้ Mjölnir เป็นบอทควบคุมห้องสนทนาใน Matrix ด้วย Docker

ตั้งค่า Mjölnir ด้วยบัญชี Matrix เฉพาะ, ห้องจัดการที่เข้ารหัส, Docker Compose, รายการนโยบาย และการตรวจสอบสิทธิ์

เปิดใช้งาน Native Matrix Sliding Sync เพื่อการโหลดบนมือถือที่เร็วขึ้น

เปิดใช้งาน Native Matrix Sliding Sync เพื่อการโหลดบนมือถือที่เร็วขึ้น

ข้ามขั้นตอนการใช้พร็อกซีที่เลิกใช้งานแล้ว และกำหนดค่า Sliding Sync ที่มีอยู่ใน Synapse ตรวจสอบการค้นหาไคลเอ็นต์ จากนั้นวัดการโหลดรายการห้องและพฤติกรรมการเชื่อมต่อใหม่บนโทรศัพท์ที่ใช้งานร่วมกันได้

ติดตั้ง Element Web บน Nginx ด้วยโฮมเซิร์ฟเวอร์แบบกำหนดเอง

ติดตั้ง Element Web เป็นเว็บไซต์แบบคงที่ ชี้ไปยังโฮมเซิร์ฟเวอร์ Matrix ของคุณ เพิ่ม HTTPS และกำหนดค่า Nginx เพื่อให้บริการอัปเดตโดยไม่มีไฟล์เก่าค้างอยู่

ใช้งาน Matrix Homeserver ขนาดเล็กบน Raspberry Pi 4

ติดตั้ง Conduit บน Raspberry Pi 4 แบบ 64 บิต โดยตั้งค่าให้เก็บข้อมูลถาวร การเชื่อมต่อ HTTPS การลงทะเบียนที่ปลอดภัย และตรวจสอบว่าโฮมเซิร์ฟเวอร์ทำงานได้หรือไม่

ตั้งค่านามแฝงห้องเมทริกซ์แบบกำหนดเองบนโดเมนของคุณเอง

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

ตั้งค่า coturn เพื่อการโทรด้วยเสียงและวิดีโอผ่าน Matrix ที่เชื่อถือได้

กำหนดค่า coturn และ Synapse ด้วยข้อมูลรับรอง TURN ที่ตรงกัน เปิดพอร์ตรีเลย์ที่จำเป็น และตรวจสอบว่าไคลเอ็นต์ Matrix สามารถรับผู้สมัครรีเลย์ได้

ติดตั้งใช้งาน Matrix Synapse ด้วย Docker Compose และ PostgreSQL

ติดตั้งใช้งาน Matrix Synapse ด้วย Docker Compose และ PostgreSQL

ตั้งค่าโฮมเซิร์ฟเวอร์ Synapse แบบถาวรด้วย Docker Compose, PostgreSQL, การกำหนดค่าส่วนตัว และการตรวจสอบต่างๆ ก่อนที่จะเปิดเผยผ่าน HTTPS

ปรับแต่งธีมและแบรนด์ของ Element Web

กำหนดชื่อแบรนด์ สีที่กำหนดเอง และองค์ประกอบการเข้าสู่ระบบสำหรับการใช้งาน Element Web ของคุณ พร้อมทั้งทำความเข้าใจว่าส่วนใดบ้างที่ยังคงใช้แบรนด์ Element อยู่

เพิ่มขีดจำกัดไฟล์ Systemd ของ Synapse โดยไม่ต้องคาดเดา

เพิ่มขีดจำกัดไฟล์ Systemd ของ Synapse โดยไม่ต้องคาดเดา

ตรวจสอบว่า Synapse ถึงขีดจำกัดการเปิดไฟล์ต่อกระบวนการแล้วหรือไม่ ตั้งค่า systemd drop-in สำหรับบริการหรือ worker ที่ถูกต้อง และตรวจสอบขีดจำกัดแบบเรียลไทม์