نصب و پیکربندی synapse

سیناپس(Synapse) یک پلتفرم لینوکس است و تحت مجوز Apache 2.0 در دسترس است. این پلتفرم، برای راه اندازی سیستم پیام رسان شخصی، شناسه‌های کاربری را برای کاربران روی سرور شما تعیین می‌کند.

Synapse یک سرور خانگی ماتریسی است که به زبان Python/Twisted نوشته شده است

این مطلب برگرفته از مستندات پلتفرم Synapse است که توسط بنیاد ماتریکس که برای نسخه‌های مختلف سیناپس تولید و نگهداری می‌شود، که تحت مجوز Apache 2.0 در دسترس است.( github.com/matrix-org/synapse )

از نسخه 1.99، Synapse اکنون توسط Element تحت یک مجوز جدید نگهداری می شود. ( github.com/element-hq/synapse ). اگر به مستندات آخرین نسخه از Synapse نیاز دارید، به مستندات Element Synapse مراجعه نمایید.

اتوجه: ممکن است اطلاعات این مطلب قدیمی شده باشد!

راهنمای نصب

دستورالعمل نصب پلتفرم سیناپس

انتخاب نام سرور خود

مهم است که قبل از نصب Synapse نام سرور خود را انتخاب کنید، زیرا بعداً نمی توان آن را تغییر داد.

نام سرور قسمت «دامنه» شناسه‌های کاربر را برای کاربران روی سرور شما تعیین می‌کند: همه اینها فرمت @user:my.domain.name. خواهند داشت و همچنین تعیین می کند که چگونه سرورهای ماتریسی دیگر به سرور شما یاری می رسند.

برای پیکربندی آزمایشی، این را روی نام میزبان سرور خود تنظیم کنید. برای راه‌اندازی آماده‌تر برای تولید، احتمالاً می‌خواهید دامنه خود را ( example.com) به جای نام میزبان مخصوص ماتریس در اینجا مشخص کنید (به همان صورتی که آدرس ایمیل شما احتمالاً user@example.comبه جای user@email.example.com) است – اما انجام این کار ممکن است به تنظیمات پیشرفته‌تری نیاز داشته باشد: راه اندازی فدراسیون را ببینید .

در حال نصب سیناپس

بسته های از پیش ساخته شده

بسته های از پیش ساخته شده برای تعدادی از پلتفرم ها در دسترس هستند. اینها برای اکثر کاربران توصیه می شود.

تصاویر داکر و کتاب های بازی Ansible

برای استفاده از سیناپس میتوانید از ایمیج رسمی که از فایل های سیناپس در مسیر https://hub.docker.com/r/matrixdotorg/synapse موجود است استفاده نمایید و یا ghcr.io/matrix-org/synapse می توان از آن با فایل docker-compose موجود در contrib/docker استفاده کرد .

برای راهنمایی و دریافت اطلاعات بیشتر در مورد سیناپس میتوانید از فایل های README در hub.docker.com که در بخش پیکربندی موجود است اسفاده نمایید.

در همین راستا، آندریاس پیترز (سیلویو فریک) یک Dockerfile برای خودکارسازی سرور سیناپس در یک فایل ایمیج Docker در https://hub.docker.com/r/avhost/docker-matrix/tags/ منتشر کرده است.

Slavi Pantaleev یک کتاب بازی Ansible ایجاد کرده است که تصویر رسمی Docker Matrix Synapse را به همراه بسیاری دیگر از خدمات مرتبط با Matrix (پایگاه داده Postgres، Element، coturn، ma1sd، پشتیبانی SSL و غیره) نصب می کند.

برای مشاهده جزئیات بیشتر، به https://github.com/spantaleev/matrix-docker-ansible-deploy مراجعه کنید.

دبیان/اوبونتو

بسته های Matrix.org

Matrix.org بسته‌های Debian/Ubuntu Synapse را برای معماری amd64 از طریق آدرس https://packages.matrix.org/debian/ فراهم می‌کند .

برای نصب آخرین نسخه دستور زیر را وارد کنید:

sudo apt install -y lsb-release wget apt-transport-https
sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" |
    sudo tee /etc/apt/sources.list.d/matrix-org.list
sudo apt update
sudo apt install matrix-synapse-py3

بسته هایی نیز برای نامزدهای آزادی منتشر می شود. برای فعال کردن کانال پیش از انتشار، prereleaseبه sources.list خط اضافه کنید.

به عنوان مثال:

sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease" |
    sudo tee /etc/apt/sources.list.d/matrix-org.list
sudo apt update
sudo apt install matrix-synapse-py3

اثر انگشت کلید امضای مخزن (همانطور که با نشان داده شده است gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) است AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058.

هنگام نصب با بسته‌های دبیان، ممکن است ترجیح دهید فایل‌ها را در آن قرار دهید /etc/matrix-synapse/conf.d/تا پیکربندی خود را بدون ویرایش فایل پیکربندی اصلی در /etc/matrix-synapse/homeserver.yaml. با انجام این کار، هنگامی که بسته Debian را به نسخه بعدی ارتقا می دهید، از شما سؤال نمی شود که آیا می خواهید فایل پیکربندی خود را جایگزین کنید.

بسته های پایین دستی دبیان

آندری شادورا matrix-synapse بسته ای را در مخازن دبیان نگهداری می کند. برای bookwormو sid، می توان آن را به سادگی با:

sudo apt install matrix-synapse

Synapse نیز در دسترس است bullseye-backports. لطفاً برای اطلاعات در مورد نحوه استفاده از backport ها به مستندات دبیان مراجعه نمایید.

matrix-synapseدیگر برای و قدیمی تر نگهداری نمی شود buster.

بسته های اوبونتو پایین دست

در حال حاضر استفاده از بسته‌ها در مخزن پیش‌فرض اوبونتو را توصیه نمی‌کنیم، زیرا قدیمی هستند و از آسیب‌پذیری‌های امنیتی شناخته شده رنج می‌برند . آخرین نسخه Synapse را می توان از مخزن ماتریس نصب کرد .

فدورا

سیناپس در مخازن فدورا به صورت زیر است matrix-synapse :

sudo dnf install matrix-synapse

علاوه بر این، اولگ گیرکو RPM های فدورا را در https://obs.infoserver.lv/project/monitor/matrix-synapse ارائه می دهد.

OpenSUSE

Synapse در مخازن OpenSUSE به صورت زیر است matrix-synapse :

sudo zypper install matrix-synapse

SUSE Linux Enterprise Server

بسته غیر رسمی برای SLES 15 در مخزن openSUSE:Backports:SLE-15 در https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ ساخته شده است.

ArchLinux

سریع‌ترین راه برای راه‌اندازی و راه‌اندازی با ArchLinux احتمالاً با بسته ارائه شده توسط ArchLinux https://archlinux.org/packages/extra/x86_64/matrix-synapse/ است که باید بیشتر وابستگی‌های ضروری را به همراه داشته باشد.

ممکن است پیپ قدیمی باشد (6.0.7-1 و باید به 6.0.8-1 ارتقا داده شود):

sudo pip install --upgrade pip

اگر با خطای lib bcrypt مواجه شدید که باعث ایجاد کلاس ELF اشتباه می‌شود: ELFCLASS32 (x64 Systems)، ممکن است لازم باشد py-bcrypt را مجدداً نصب کنید تا به درستی آن را تحت معماری مناسب کامپایل کنید. (در صورت نصب تحت virtualenv به این مورد نیاز نیست):

sudo pip uninstall py-bcrypt
sudo pip install py-bcrypt

آلپاین لینوکس

6543 بسته های Synapse را برای Alpine Linux در مخزن جامعه نگهداری می کند. نصب با:

sudo apk add synapse

لینوکس خالی

سیناپس را می توان در مخازن خالی به عنوان “سیناپس” یافت :

xbps-install -Su
xbps-install -S synapse

FreeBSD

Synapse را می توان از طریق پورت های FreeBSD یا بسته های ارائه شده توسط Brendan Molloy از:

پورت ها:cd /usr/ports/net-im/py-matrix-synapse && make install clean
بسته ها:pkg install py38-matrix-synapse

OpenBSD

از OpenBSD 6.7 Synapse به عنوان یک باینری از پیش کامپایل شده در دسترس است. سیستم فایلی که در دایرکتوری سرور خانگی قرار دارد (به طور پیش‌فرض به /var/synapse) باید با wxallowed(ر.ک. mount(8)) نصب شود، بنابراین ایجاد یک فایل سیستم جداگانه و نصب آن /var/synapseباید در نظر گرفته شود.

نصب سیناپس:

doas pkg_add synapse

دستور
نصب آخرین نسخه دبیان و لبونتو	sudo apt install -y lsb-release wget apt-transport-https sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg echo “deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main” \| sudo tee /etc/apt/sources.list.d/matrix-org.list sudo apt update sudo apt install matrix-synapse-py3
`matrix-synapse` بسته ای را در مخازن دبیان نگهداری می کند. برای `bookworm`و `sid`، می توان آن را به سادگی با:	sudo apt install matrix-synapse
بسته های پایین دستی دبیان
نصب سیناپس در فدورا	sudo dnf install matrix-synapse
نصب سیناپس در OpenSUSE	sudo zypper install matrix-synapse
نصب سیناپس در ArchLinux	sudo pip install –upgrade pip
نصب سیناپس در ArchLinux در صورت نصب تحت virtualenv	sudo pip uninstall py-bcrypt sudo pip install py-bcrypt
نصب سیناپس در Alpine Linux	sudo apk add synapse
نصب سیناپس در لینوکس خالی	xbps-install -Su xbps-install -S synapse
نصب سیناپس در FreeBSD پورت ها: بسته ها:	`cd /usr/ports/net-im/py-matrix-synapse && make install clean` `pkg install py38-matrix-synapse`
نصب سیناپس در
نصب سیناپس در OpenBSD	doas pkg_add synapse

NixOS

رابین لمبرتز Synapse را برای NixOS در آدرس زیر بسته بندی کرده است: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/synapse.nix

نصب به عنوان یک ماژول پایتون از PyPI

همچنین امکان نصب Synapse به عنوان یک ماژول پایتون از PyPI وجود دارد.

هنگامی که این مسیر را دنبال می کنید، لطفاً مطمئن شوید که پیش نیازهای خاص پلت فرم قبلاً نصب شده اند.

سیستم مورد نیاز:

سیستم سازگار با POSIX (تست شده روی Linux و OS X)
پایتون 3.8 یا بالاتر، تا پایتون 3.11.
اگر می‌خواهید به اتاق‌های عمومی بزرگ مانند #matrix:matrix.org بپیوندید، حداقل 1 گیگابایت رم رایگان دارید.

اگر بنا بر معماری غیر معمولی که چرخ های از پیش ساخته شده برای آن در دسترس نیستند، باید یک کامپایلر Rust اخیر نصب کنید. ساده ترین راه برای نصب آخرین نسخه استفاده از rustup است .

برای نصب سرور خانه Synapse اجرا کنید:

mkdir -p ~/synapse
virtualenv -p python3 ~/synapse/env
source ~/synapse/env/bin/activate
pip install --upgrade pip
pip install --upgrade setuptools
pip install matrix-synapse

این سیناپس را از PyPI دانلود کرده و آن را به همراه کتابخانه های پایتونی که استفاده می کند در یک محیط مجازی تحت نصب می کند ~/synapse/env. در صورت تمایل، دایرکتوری دیگری را انتخاب کنید.

این نصب سیناپس را می‌توان بعداً با استفاده از pip دوباره با پرچم به‌روزرسانی ارتقا داد:

source ~/synapse/env/bin/activate
pip install -U matrix-synapse

قبل از اینکه بتوانید Synapse را راه اندازی کنید، باید یک فایل پیکربندی ایجاد کنید. برای انجام این کار، (مانند قبل در virtualenv خود):

cd ~/synapse
python -m synapse.app.homeserver \
    --server-name my.domain.name \
    --config-path homeserver.yaml \
    --generate-config \
    --report-stats=[yes|no]

… جایگزین کردن یک مقدار مناسب برای --server-nameو انتخاب گزارش یا عدم گزارش آمار استفاده (نام میزبان، نسخه Synapse، زمان آپدیت، کل کاربران و غیره) به توسعه دهندگان از طریق --report-statsآرگومان.

این دستور یک فایل پیکربندی برای شما ایجاد می کند که می توانید آن را سفارشی کنید، اما مجموعه ای از کلیدها را نیز برای شما ایجاد می کند. این کلیدها به سرور خانه شما اجازه می‌دهند تا خود را با سرورهای دیگر شناسایی کند، بنابراین آنها را گم یا حذف نکنید. عاقلانه است که از آنها در جایی امن پشتیبانی کنید. (اگر به هر دلیلی نیاز به تغییر کلیدهای سرور خانگی خود دارید، ممکن است متوجه شوید که سایر سرورها کلید قدیمی را در حافظه پنهان دارند. اگر کلید امضا را به روز کنید، باید نام کلید را در <server name>.signing.keyفایل تغییر دهید (کلمه دوم ) برای اطلاعات بیشتر در مورد مدیریت کلید، مشخصات را ببینید .

برای اجرای واقعی سرور خانگی جدید خود، یک دایرکتوری فعال برای اجرای Synapse انتخاب کنید (به عنوان مثال ~/synapse)، و:

cd ~/synapse
source env/bin/activate
synctl start

پیش نیازهای خاص پلتفرم

Synapse در پایتون نوشته شده است اما برخی از کتابخانه‌هایی که استفاده می‌کند به زبان C نوشته شده‌اند. بنابراین قبل از اینکه بتوانیم خود Synapse را نصب کنیم، به یک کامپایلر C و فایل‌های هدر برای پسوندهای Python C نیاز داریم.

Debian/Ubuntu/Raspbian

نصب پیش نیازها در اوبونتو یا دبیان:

sudo apt install build-essential python3-dev libffi-dev \
                     python3-pip python3-setuptools sqlite3 \
                     libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev

ArchLinux

نصب پیش نیازها در ArchLinux:

sudo pacman -S base-devel python python-pip \
               python-setuptools python-virtualenv sqlite3 icu

CentOS/Fedora

نصب پیش نیازها در CentOS یا Fedora Linux:

sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \
                 libwebp-devel libxml2-devel libxslt-devel libpq-devel \
                 python3-virtualenv libffi-devel openssl-devel python3-devel \
                 libicu-devel
sudo dnf groupinstall "Development Tools"

macOS

نصب پیش نیازها در macOS:

ممکن است لازم باشد جدیدترین ابزارهای توسعه دهنده Xcode را نصب کنید:

xcode-select --install

ممکن است به برخی وابستگی های اضافی نیاز باشد. می توانید از Homebrew (https://brew.sh) برای آنها استفاده کنید.

ممکن است لازم باشد icu را نصب کنید و باینری ها و کتابخانه های icu را در دسترس قرار دهید. لطفاً دستورالعمل های رسمی PyICU را برای این کار دنبال کنید.

در مک‌های مبتنی بر ARM، ممکن است لازم باشد libjpeg و libpq را نیز نصب کنید:

 brew install jpeg libpq

در macOS Catalina (10.15) ممکن است لازم باشد OpenSSL را به صراحت از طریق brew نصب کنید و pipدر مورد آن اطلاع دهید تا psycopg2بیلدها:

brew install openssl@1.1
export LDFLAGS="-L/usr/local/opt/openssl/lib"
export CPPFLAGS="-I/usr/local/opt/openssl/include"

OpenSUSE

نصب پیش نیازها در openSUSE:

sudo zypper in -t pattern devel_basis
sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \
               python-devel libffi-devel libopenssl-devel libjpeg62-devel \
               libicu-devel

OpenBSD

یک پورت Synapse در زیر موجود است net/synapse. سیستم فایلی که در دایرکتوری سرور خانگی قرار دارد (به طور پیش‌فرض به /var/synapse) باید با wxallowed(ر.ک. mount(8)) نصب شود، بنابراین ایجاد یک فایل سیستم جداگانه و نصب آن /var/synapseباید در نظر گرفته شود.

برای اینکه بتوانید وابستگی Synapse را به پایتون بسازید، WRKOBJDIR (ر.ک. bsd.port.mk(5)) برای ساخت پایتون نیز باید روی یک سیستم فایل نصب شده با wxallowed(ر.ک. mount(8)) باشد.

ایجاد یک WRKOBJDIRپایتون برای ساختن در زیر /usr/local(که در نصب پیش فرض OpenBSD با نصب شده است wxallowed):

doas mkdir /usr/local/pobj_wxallowed

با فرض PORTS_PRIVSEP=Yes(ر.ک. bsd.port.mk(5)) و SUDO=doasدر پیکربندی /etc/mk.conf:

doas chown _pbuild:_pbuild /usr/local/pobj_wxallowed

تنظیم WRKOBJDIRبرای ساخت پایتون:

echo WRKOBJDIR_lang/python/3.7=/usr/local/pobj_wxallowed  \\nWRKOBJDIR_lang/python/2.7=/usr/local/pobj_wxallowed >> /etc/mk.conf

ساختمان سیناپس:

cd /usr/ports/net/synapse
make install

ویندوز

اجرای Synapse به صورت بومی در ویندوز به طور رسمی پشتیبانی نمی شود.

اگر می‌خواهید Synapse را روی ویندوز اجرا یا توسعه دهید، زیرسیستم ویندوز برای لینوکس یک محیط لینوکس را ارائه می‌کند که می‌تواند از روش‌های نصب دبیان، فدورا یا منبع استفاده کند. اطلاعات بیشتر در مورد WSL را می توانید در،

https://docs.microsoft.com/en-us/windows/wsl/install برای Windows 10/11

و https://docs.microsoft.com/en-us/windows/wsl بیابید.

/install-on-server برای ویندوز سرور.

راه اندازی سیناپس

هنگامی که سیناپس را مانند بالا نصب کردید، باید آن را پیکربندی کنید.

با استفاده از PostgreSQL

به طور پیش فرض Synapse از یک پایگاه داده SQLite استفاده می کند و در انجام این کار عملکرد را برای راحتی معامله می کند. تقریباً همه نصب‌ها باید از PostgreSQL استفاده کنند . مزایا عبارتند از:

بهبود عملکرد قابل توجه به دلیل مدل برتر رشته و حافظه پنهان، بهینه ساز هوشمندتر پرس و جو
اجازه می دهد DB بر روی سخت افزار جداگانه اجرا شود

برای اطلاعات در مورد نحوه نصب و استفاده از PostgreSQL در Synapse، لطفاً به استفاده از Postgres مراجعه کنید

SQLite فقط برای اهداف آزمایشی قابل قبول است. SQLite نباید در سرور تولید استفاده شود. Synapse هنگام استفاده از SQLite ضعیف عمل می کند، به خصوص هنگام شرکت در اتاق های بزرگ.

گواهی های TLS

پیکربندی پیش‌فرض یک پورت HTTP را در رابط محلی نشان می‌دهد http://localhost:8008: برای آزمایش محلی مناسب است، اما برای هر گونه استفاده عملی، به APIهای Synapse نیاز دارید تا از طریق HTTPS ارائه شوند.

روش توصیه شده برای انجام این کار، راه اندازی یک پروکسی معکوس در پورت است 8448. شما می توانید مستندات مربوط به انجام این کار را در اسناد پروکسی معکوس بیابید .

از طرف دیگر، می‌توانید Synapse را طوری پیکربندی کنید که یک پورت HTTPS را در معرض دید قرار دهد. برای انجام این کار، باید homeserver.yamlبه صورت زیر ویرایش کنید:

ابتدا، در زیر listenersگزینه، تنظیمات مربوط به شنونده فعال TLS را مانند این اضافه کنید:

listeners:
  - port: 8448
    type: http
    tls: true
    resources:
      - names: [client, federation]

همچنین باید گزینه های tls_certificate_pathو را اضافه کنید tls_private_key_path. به فایل پیکربندی شما شما باید خودتان تهیه این گواهی ها را مدیریت کنید.
می‌توانید اطلاعات بیشتری درباره این گزینه‌ها و همچنین نحوه پیکربندی سیناپس را در راهنمای پیکربندی بیابید .اگر از گواهینامه خود استفاده می‌کنید، حتماً از .pemفایلی استفاده کنید که شامل زنجیره کامل گواهی شامل هر گونه گواهی‌های میانی باشد (به عنوان مثال، اگر از certbot استفاده می‌کنید، fullchain.pemبه عنوان گواهی استفاده کنید، نه cert.pem).

برای راهنمای دقیق تر برای پیکربندی سرور خود برای فدراسیون، به فدراسیون مراجعه کنید .

URI شناخته شده مشتری

راه‌اندازی URI شناخته شده مشتری اختیاری است، اما اگر آن را تنظیم کنید، به کاربران اجازه می‌دهد نام کاربری کامل خود (به عنوان مثال @user:<server_name>) را در کلاینت‌هایی وارد کنند که از جستجوی شناخته شده پشتیبانی می‌کنند تا به طور خودکار آدرس‌های وب سرور خانگی و سرور هویت را پیکربندی کنند. این مفید است تا کاربران مجبور نباشند URL سرور اصلی مورد استفاده خود را حفظ کنند یا به آن فکر کنند.

URL https://<server_name>/.well-known/matrix/clientباید JSON را در قالب زیر برگرداند.

{
  "m.homeserver": {
    "base_url": "https://<matrix.example.com>"
  }
}

این می تواند به صورت اختیاری حاوی اطلاعات سرور هویت نیز باشد.

{
  "m.homeserver": {
    "base_url": "https://<matrix.example.com>"
  },
  "m.identity_server": {
    "base_url": "https://<identity.example.com>"
  }
}

برای کار در کلاینت های مبتنی بر مرورگر، فایل باید با سرصفحه های مناسب به اشتراک گذاری منابع متقاطع (CORS) ارائه شود. یک مقدار توصیه شده است Access-Control-Allow-Origin: *که به همه مشتریان مبتنی بر مرورگر اجازه می دهد آن را مشاهده کنند.

در nginx این چیزی شبیه به:

location /.well-known/matrix/client {
    return 200 '{"m.homeserver": {"base_url": "https://<matrix.example.com>"}}';
    default_type application/json;
    add_header Access-Control-Allow-Origin *;
}

همچنین باید مطمئن شوید که public_baseurlگزینه in homeserver.yamlبه درستی تنظیم شده است. public_baseurlباید روی URL که مشتریان برای اتصال به سرور شما استفاده می کنند تنظیم شود. این همان URL است که برای موارد m.homeserver base_urlبالا قرار داده اید.

public_baseurl: "https://<matrix.example.com>"

ایمیل

مطلوب است که سیناپس قابلیت ارسال ایمیل را داشته باشد. این به Synapse امکان می‌دهد ایمیل‌های بازنشانی رمز عبور ارسال کند، تأییدیه‌هایی را هنگامی که آدرس ایمیل به حساب کاربر اضافه می‌شود ارسال کند، و هنگام دریافت پیام‌های جدید، اعلان‌های ایمیل را برای کاربران ارسال کند.

برای پیکربندی یک سرور SMTP برای Synapse، قسمت پیکربندی با عنوان را تغییر دهید emailو مطمئن شوید که حداقل smtp_hostفیلدهای smtp_port و notif_fromپر شده باشد. همچنین ممکن است لازم باشد smtp_user، smtp_passو و را تنظیم کنید require_transport_security.

اگر ایمیل پیکربندی نشده باشد، بازنشانی رمز عبور، ثبت نام و اطلاع رسانی از طریق ایمیل غیرفعال خواهد شد.

ثبت نام کاربر

یک راه برای ایجاد یک کاربر جدید این است که این کار را از کلاینت مانند Element انجام دهید . برای این کار باید ثبت نام از طریق تنظیمات فعال شود enable_registration .

همچنین می توانید از خط فرمان کاربران جدیدی ایجاد کنید. این کار را می توان به صورت زیر انجام داد:

اگر سیناپس از طریق پیپ نصب شده است، virtualenv را به صورت زیر فعال کنید (اگر Synapse از طریق یک بسته از پیش ساخته شده نصب شده باشد، register_new_matrix_userباید قبلاً در مسیر جستجو باشد):cd ~/synapse source env/bin/activate synctl start # if not already running
دستور زیر را اجرا کنید:register_new_matrix_user -c homeserver.yaml

این از شما می خواهد جزئیاتی را برای کاربر جدید اضافه کنید و سپس به Synapse در حال اجرا برای ایجاد کاربر جدید متصل می شود. به عنوان مثال:

New user localpart: erikj
Password:
Confirm password:
Make admin [no]:
Success!

این فرآیند از یک تنظیم استفاده می کند registration_shared_secret که بین خود Synapse و register_new_matrix_user اسکریپت به اشتراک گذاشته شده است. مهم نیست که چه چیزی باشد (یک مقدار تصادفی توسط --generate-config) ایجاد می شود، اما باید مخفی نگه داشته شود، زیرا هر کسی که از آن آگاهی داشته باشد می تواند کاربران، از جمله حساب های مدیریت، را در سرور شما ثبت کند، حتی اگر enable_registrationباشد false.

راه اندازی سرور TURN

برای اینکه تماس های VoIP قابل اعتماد از طریق این سرور خانگی هدایت شوند، باید سرور TURN را پیکربندی کنید. برای جزئیات به تنظیمات TURN مراجعه کنید .

پیش نمایش های URL

Synapse شامل پشتیبانی از پیش نمایش URL ها است که به طور پیش فرض غیرفعال است. برای روشن کردن آن، باید url_preview_enabled: Trueپارامتر پیکربندی را فعال کنید و به صراحت محدوده های IP را مشخص کنید که Synapse مجاز به استفاده از آن برای پیش نمایش در پارامتر پیکربندی نیست url_preview_ip_range_blacklist. این از منظر امنیتی برای جلوگیری از ایجاد URLهای داخلی «داخلی» توسط کاربران خودسرانه ماتریس در شبکه شما ضروری است. حداقل توصیه می کنیم که آدرس های IP Loopback و RFC1918 شما در لیست سیاه قرار گیرند.

lxmlاین همچنین مستلزم نصب وابستگی اختیاری پایتون است. این به نوبه خود مستلزم آن است که libxml2کتابخانه در دسترس باشد – در Debian/Ubuntu این به معنای apt-get install libxml2-devیا معادل آن برای سیستم عامل شما است.

عیب یابی نصب

pipبه نظر می رسد که حافظه زیادی در حین نصب نشت می کند. به عنوان مثال، یک هاست لینوکس با 512 مگابایت رم ممکن است در حین نصب Twisted حافظه اش تمام شود. اگر این اتفاق بیفتد، باید وابستگی هایی را که شکست می خورند به صورت جداگانه نصب کنید، به عنوان مثال:

pip install twisted

اگر مشکل دیگری دارید، در #synapse:matrix.org ببینید.

*******

ین اسناد ممکن است قدیمی باشد!
این سایت مستند برای نسخه‌های Synapse است که توسط
بنیاد Matrix.org (
github.com/matrix-org/synapse ) نگهداری می‌شود، که تحت مجوز Apache 2.0 در دسترس است.
از نسخه 1.99، Synapse اکنون توسط
Element تحت یک مجوز جدید نگهداری می شود (
github.com/element-hq/synapse ).
اگر به اسناد نسخه بعدی Synapse علاقه دارید، لطفاً
اینجا را کلیک کنید تا به همین صفحه در آخرین سایت مستندات Element Synapse بروید ، در صورت موجود بودن.
دستورالعمل نصب
انتخاب نام سرور شما
مهم است که قبل از نصب Synapse نام سرور خود را انتخاب کنید، زیرا بعداً نمی توان آن را تغییر داد.
نام سرور قسمت «دامنه» شناسه‌های کاربر را برای کاربران روی سرور شما تعیین می‌کند: همه اینها فرمت خواهند داشت
@user:my.domain.name. همچنین تعیین می کند که چگونه سرورهای ماتریسی دیگر به سرور شما برای فدراسیون می رسند.
برای پیکربندی آزمایشی، این را روی نام میزبان سرور خود تنظیم کنید. برای راه‌اندازی آماده‌تر برای تولید، احتمالاً می‌خواهید دامنه خود را (
example.com) به جای نام میزبان مخصوص ماتریس در اینجا مشخص کنید (به همان صورتی که آدرس ایمیل شما احتمالاً
user@example.comبه جای
user@email.example.com) است – اما انجام این کار ممکن است به تنظیمات پیشرفته‌تری نیاز داشته باشد:
راه اندازی فدراسیون را ببینید
.
در حال نصب سیناپس
بسته های از پیش ساخته شده
بسته های از پیش ساخته شده برای تعدادی از پلتفرم ها در دسترس هستند. اینها برای اکثر کاربران توصیه می شود.
تصاویر داکر و کتاب های بازی Ansible

یک تصویر رسمی از سیناپس در https://hub.docker.com/r/matrixdotorg/synapse موجود است
یا
ghcr.io/matrix-org/synapse می توان از آن با فایل docker-compose موجود در
contrib/docker استفاده کرد . اطلاعات بیشتر در این مورد از جمله گزینه های پیکربندی در README در hub.docker.com موجود است.
متناوباً، آندریاس پیترز (قبلاً سیلویو فریک) یک Dockerfile برای خودکارسازی سرور سیناپس در یک تصویر Docker در
https://hub.docker.com/r/avhost/docker-matrix/tags/ کمک کرده است.
Slavi Pantaleev یک کتاب بازی Ansible ایجاد کرده است که تصویر رسمی Docker Matrix Synapse را به همراه بسیاری دیگر از خدمات مرتبط با Matrix (پایگاه داده Postgres، Element، coturn، ma1sd، پشتیبانی SSL و غیره) نصب می کند. برای جزئیات بیشتر، به
https://github.com/spantaleev/matrix-docker-ansible-deploy مراجعه کنید
دبیان/اوبونتو
بسته های Matrix.org
Matrix.org بسته‌های Debian/Ubuntu Synapse را برای معماری amd64 از طریق
https://packages.matrix.org/debian/ فراهم می‌کند .
برای نصب آخرین نسخه:

sudo apt install -y lsb-release wget apt-transport-https sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/matrix-org.list sudo apt update sudo apt install matrix-synapse-py3
بسته هایی نیز برای نامزدهای آزادی منتشر می شود. برای فعال کردن کانال پیش از انتشار،
prereleaseبه
sources.listخط اضافه کنید. به عنوان مثال:

sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease" | sudo tee /etc/apt/sources.list.d/matrix-org.list sudo apt update sudo apt install matrix-synapse-py3
اثر انگشت کلید امضای مخزن (همانطور که با نشان داده شده است
gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) است
AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058.
هنگام نصب با بسته‌های دبیان، ممکن است ترجیح دهید فایل‌ها را در آن قرار دهید
/etc/matrix-synapse/conf.d/تا پیکربندی خود را بدون ویرایش فایل پیکربندی اصلی در
/etc/matrix-synapse/homeserver.yaml. با انجام این کار، هنگامی که بسته Debian را به نسخه بعدی ارتقا می دهید، از شما سؤال نمی شود که آیا می خواهید فایل پیکربندی خود را جایگزین کنید.
بسته های پایین دستی دبیان
آندری شادورا
matrix-synapseبسته ای را در مخازن دبیان نگهداری می کند. برای
bookwormو
sid، می توان آن را به سادگی با:

sudo apt install matrix-synapse
Synapse نیز در دسترس است
bullseye-backports. لطفاً
برای اطلاعات در مورد نحوه استفاده از backport ها به
مستندات دبیان مراجعه کنید.
matrix-synapseدیگر برای و قدیمی تر نگهداری نمی شود
buster.
بسته های اوبونتو پایین دست
در حال حاضر استفاده از بسته‌ها در مخزن پیش‌فرض اوبونتو را توصیه نمی‌کنیم، زیرا
قدیمی هستند و از آسیب‌پذیری‌های امنیتی شناخته شده رنج می‌برند . آخرین نسخه Synapse را می توان از
مخزن ما نصب کرد .
فدورا
سیناپس در مخازن فدورا به صورت زیر است
matrix-synapse:

sudo dnf install matrix-synapse
علاوه بر این، اولگ گیرکو RPM های فدورا را در
https://obs.infoserver.lv/project/monitor/matrix-synapse ارائه می دهد.
OpenSUSE
Synapse در مخازن OpenSUSE به صورت زیر است
matrix-synapse:

sudo zypper install matrix-synapse
SUSE Linux Enterprise Server
بسته غیر رسمی برای SLES 15 در مخزن openSUSE:Backports:SLE-15 در
https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/ ساخته شده است.
ArchLinux
سریع‌ترین راه برای راه‌اندازی و راه‌اندازی با ArchLinux احتمالاً با بسته ارائه شده توسط ArchLinux
https://archlinux.org/packages/extra/x86_64/matrix-synapse/ است که باید بیشتر وابستگی‌های ضروری را به همراه داشته باشد.
ممکن است پیپ قدیمی باشد (6.0.7-1 و باید به 6.0.8-1 ارتقا داده شود):

sudo pip install --upgrade pip
اگر با خطای lib bcrypt مواجه شدید که باعث ایجاد کلاس ELF اشتباه می‌شود: ELFCLASS32 (x64 Systems)، ممکن است لازم باشد py-bcrypt را مجدداً نصب کنید تا به درستی آن را تحت معماری مناسب کامپایل کنید. (در صورت نصب تحت virtualenv به این مورد نیاز نیست):

sudo pip uninstall py-bcrypt sudo pip install py-bcrypt
آلپاین لینوکس
6543
بسته های Synapse را برای Alpine Linux در مخزن جامعه نگهداری می کند. نصب با:

sudo apk add synapse
لینوکس خالی
سیناپس را می توان در مخازن خالی به عنوان
“سیناپس” یافت :

xbps-install -Su xbps-install -S synapse
FreeBSD
Synapse را می توان از طریق پورت های FreeBSD یا بسته های ارائه شده توسط Brendan Molloy از:
پورت ها:
cd /usr/ports/net-im/py-matrix-synapse && make install clean
بسته ها:
pkg install py38-matrix-synapse
OpenBSD
از OpenBSD 6.7 Synapse به عنوان یک باینری از پیش کامپایل شده در دسترس است. سیستم فایلی که در دایرکتوری سرور خانگی قرار دارد (به طور پیش‌فرض به
/var/synapse) باید با
wxallowed(ر.ک.
mount(8)) نصب شود، بنابراین ایجاد یک فایل سیستم جداگانه و نصب آن
/var/synapseباید در نظر گرفته شود.
نصب سیناپس:

doas pkg_add synapse
NixOS
رابین لمبرتز Synapse را برای NixOS در آدرس زیر بسته بندی کرده است:
https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/synapse.nix
نصب به عنوان یک ماژول پایتون از PyPI
همچنین امکان نصب Synapse به عنوان یک ماژول پایتون از PyPI وجود دارد.
هنگامی که این مسیر را دنبال می کنید، لطفاً مطمئن شوید که
پیش نیازهای خاص پلت فرم قبلاً نصب شده اند.
سیستم مورد نیاز:
سیستم سازگار با POSIX (تست شده روی Linux و OS X)
پایتون 3.8 یا بالاتر، تا پایتون 3.11.
اگر می‌خواهید به اتاق‌های عمومی بزرگ مانند #matrix:matrix.org بپیوندید، حداقل 1 گیگابایت رم رایگان دارید.
اگر بنا بر معماری غیر معمولی که چرخ های از پیش ساخته شده برای آن در دسترس نیستند، باید یک کامپایلر Rust اخیر نصب کنید. ساده ترین راه برای نصب آخرین نسخه استفاده از
rustup است .
برای نصب سرور خانه Synapse اجرا کنید:

mkdir -p ~/synapse virtualenv -p python3 ~/synapse/env source ~/synapse/env/bin/activate pip install --upgrade pip pip install --upgrade setuptools pip install matrix-synapse
این سیناپس را از
PyPI دانلود کرده و آن را به همراه کتابخانه های پایتونی که استفاده می کند در یک محیط مجازی تحت نصب می کند
~/synapse/env. در صورت تمایل، دایرکتوری دیگری را انتخاب کنید.
این نصب سیناپس را می‌توان بعداً با استفاده از pip دوباره با پرچم به‌روزرسانی ارتقا داد:

source ~/synapse/env/bin/activate pip install -U matrix-synapse
قبل از اینکه بتوانید Synapse را راه اندازی کنید، باید یک فایل پیکربندی ایجاد کنید. برای انجام این کار، (مانند قبل در virtualenv خود):

cd ~/synapse python -m synapse.app.homeserver \ --server-name my.domain.name \ --config-path homeserver.yaml \ --generate-config \ --report-stats=[yes|no]
… جایگزین کردن یک مقدار مناسب برای
--server-nameو انتخاب گزارش یا عدم گزارش آمار استفاده (نام میزبان، نسخه Synapse، زمان آپدیت، کل کاربران و غیره) به توسعه دهندگان از طریق
--report-statsآرگومان.
این دستور یک فایل پیکربندی برای شما ایجاد می کند که می توانید آن را سفارشی کنید، اما مجموعه ای از کلیدها را نیز برای شما ایجاد می کند. این کلیدها به سرور خانه شما اجازه می‌دهند تا خود را با سرورهای دیگر شناسایی کند، بنابراین آنها را گم یا حذف نکنید. عاقلانه است که از آنها در جایی امن پشتیبانی کنید. (اگر به هر دلیلی نیاز به تغییر کلیدهای سرور خانگی خود دارید، ممکن است متوجه شوید که سایر سرورها کلید قدیمی را در حافظه پنهان دارند. اگر کلید امضا را به روز کنید، باید نام کلید را در
<server name>.signing.keyفایل تغییر دهید (کلمه دوم )
برای اطلاعات بیشتر در مورد مدیریت کلید،
مشخصات را ببینید .
برای اجرای واقعی سرور خانگی جدید خود، یک دایرکتوری فعال برای اجرای Synapse انتخاب کنید (به عنوان مثال
~/synapse)، و:

cd ~/synapse source env/bin/activate synctl start
پیش نیازهای خاص پلتفرم
Synapse در پایتون نوشته شده است اما برخی از کتابخانه‌هایی که استفاده می‌کند به زبان C نوشته شده‌اند. بنابراین قبل از اینکه بتوانیم خود Synapse را نصب کنیم، به یک کامپایلر C و فایل‌های هدر برای پسوندهای Python C نیاز داریم.
Debian/Ubuntu/Raspbian
نصب پیش نیازها در اوبونتو یا دبیان:

sudo apt install build-essential python3-dev libffi-dev \ python3-pip python3-setuptools sqlite3 \ libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev
ArchLinux
نصب پیش نیازها در ArchLinux:

sudo pacman -S base-devel python python-pip \ python-setuptools python-virtualenv sqlite3 icu
CentOS/Fedora
نصب پیش نیازها در CentOS یا Fedora Linux:

sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \ libwebp-devel libxml2-devel libxslt-devel libpq-devel \ python3-virtualenv libffi-devel openssl-devel python3-devel \ libicu-devel sudo dnf groupinstall "Development Tools"
macOS
نصب پیش نیازها در macOS:
ممکن است لازم باشد جدیدترین ابزارهای توسعه دهنده Xcode را نصب کنید:

xcode-select --install
ممکن است به برخی وابستگی های اضافی نیاز باشد. می توانید از Homebrew (https://brew.sh) برای آنها استفاده کنید.
ممکن است لازم باشد icu را نصب کنید و باینری ها و کتابخانه های icu را در دسترس قرار دهید. لطفاً
دستورالعمل های رسمی PyICU را برای این کار دنبال کنید.
در مک‌های مبتنی بر ARM، ممکن است لازم باشد libjpeg و libpq را نیز نصب کنید:

brew install jpeg libpq
در macOS Catalina (10.15) ممکن است لازم باشد OpenSSL را به صراحت از طریق brew نصب کنید و
pipدر مورد آن اطلاع دهید تا
psycopg2بیلدها:

brew install openssl@1.1 export LDFLAGS="-L/usr/local/opt/openssl/lib" export CPPFLAGS="-I/usr/local/opt/openssl/include"
OpenSUSE
نصب پیش نیازها در openSUSE:

sudo zypper in -t pattern devel_basis sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \ python-devel libffi-devel libopenssl-devel libjpeg62-devel \ libicu-devel
OpenBSD
یک پورت Synapse در زیر موجود است
net/synapse. سیستم فایلی که در دایرکتوری سرور خانگی قرار دارد (به طور پیش‌فرض به
/var/synapse) باید با
wxallowed(ر.ک.
mount(8)) نصب شود، بنابراین ایجاد یک فایل سیستم جداگانه و نصب آن
/var/synapseباید در نظر گرفته شود.
برای اینکه بتوانید وابستگی Synapse را به پایتون بسازید،
WRKOBJDIR (ر.ک.
bsd.port.mk(5)) برای ساخت پایتون نیز باید روی یک سیستم فایل نصب شده با
wxallowed(ر.ک.
mount(8)) باشد.
ایجاد یک
WRKOBJDIRپایتون برای ساختن در زیر
/usr/local(که در نصب پیش فرض OpenBSD با نصب شده است
wxallowed):

doas mkdir /usr/local/pobj_wxallowed
با فرض
PORTS_PRIVSEP=Yes(ر.ک.
bsd.port.mk(5)) و
SUDO=doasدر پیکربندی
/etc/mk.conf:

doas chown _pbuild:_pbuild /usr/local/pobj_wxallowed
تنظیم
WRKOBJDIRبرای ساخت پایتون:

echo WRKOBJDIR_lang/python/3.7=/usr/local/pobj_wxallowed \\nWRKOBJDIR_lang/python/2.7=/usr/local/pobj_wxallowed >> /etc/mk.conf
ساختمان سیناپس:

cd /usr/ports/net/synapse make install
ویندوز
اجرای Synapse به صورت بومی در ویندوز به طور رسمی پشتیبانی نمی شود.
اگر می‌خواهید Synapse را روی ویندوز اجرا یا توسعه دهید، زیرسیستم ویندوز برای لینوکس یک محیط لینوکس را ارائه می‌کند که می‌تواند از روش‌های نصب دبیان، فدورا یا منبع استفاده کند. اطلاعات بیشتر در مورد WSL را می توانید در
https://docs.microsoft.com/en-us/windows/wsl/install برای Windows 10/11 و
https://docs.microsoft.com/en-us/windows/wsl بیابید.
/install-on-server برای ویندوز سرور.
راه اندازی سیناپس
هنگامی که سیناپس را مانند بالا نصب کردید، باید آن را پیکربندی کنید.
با استفاده از PostgreSQL
به طور پیش فرض Synapse از یک پایگاه داده
SQLite استفاده می کند و در انجام این کار عملکرد را برای راحتی معامله می کند. تقریباً همه نصب‌ها باید از
PostgreSQL استفاده کنند
. مزایا عبارتند از:
بهبود عملکرد قابل توجه به دلیل مدل برتر رشته و حافظه پنهان، بهینه ساز هوشمندتر پرس و جو
اجازه می دهد DB بر روی سخت افزار جداگانه اجرا شود
برای اطلاعات در مورد نحوه نصب و استفاده از PostgreSQL در Synapse، لطفاً
به استفاده از Postgres مراجعه کنید
SQLite فقط برای اهداف آزمایشی قابل قبول است. SQLite نباید در سرور تولید استفاده شود. Synapse هنگام استفاده از SQLite ضعیف عمل می کند، به خصوص هنگام شرکت در اتاق های بزرگ.
گواهی های TLS
پیکربندی پیش‌فرض یک پورت HTTP را در رابط محلی نشان می‌دهد
http://localhost:8008: برای آزمایش محلی مناسب است، اما برای هر گونه استفاده عملی، به APIهای Synapse نیاز دارید تا از طریق HTTPS ارائه شوند.
روش توصیه شده برای انجام این کار، راه اندازی یک پروکسی معکوس در پورت است
8448. شما می توانید مستندات مربوط به انجام این کار را در
اسناد پروکسی معکوس بیابید .
از طرف دیگر، می‌توانید Synapse را طوری پیکربندی کنید که یک پورت HTTPS را در معرض دید قرار دهد. برای انجام این کار، باید
homeserver.yamlبه صورت زیر ویرایش کنید:
ابتدا، در زیر
listenersگزینه، تنظیمات مربوط به شنونده فعال TLS را مانند این اضافه کنید:

listeners: - port: 8448 type: http tls: true resources: - names: [client, federation]
همچنین باید گزینه های
tls_certificate_pathو را اضافه کنید
tls_private_key_path. به فایل پیکربندی شما شما باید خودتان تهیه این گواهی ها را مدیریت کنید.
می‌توانید اطلاعات بیشتری درباره این گزینه‌ها و همچنین نحوه پیکربندی سیناپس را در
راهنمای پیکربندی بیابید .
اگر از گواهینامه خود استفاده می‌کنید، حتماً از
.pemفایلی استفاده کنید که شامل زنجیره کامل گواهی شامل هر گونه گواهی‌های میانی باشد (به عنوان مثال، اگر از certbot استفاده می‌کنید،
fullchain.pemبه عنوان گواهی استفاده کنید، نه
cert.pem).
برای راهنمای دقیق تر برای پیکربندی سرور خود برای فدراسیون، به
فدراسیون مراجعه کنید .
URI شناخته شده مشتری
راه‌اندازی URI شناخته شده مشتری اختیاری است، اما اگر آن را تنظیم کنید، به کاربران اجازه می‌دهد نام کاربری کامل خود (به عنوان مثال
@user:<server_name>) را در کلاینت‌هایی وارد کنند که از جستجوی شناخته شده پشتیبانی می‌کنند تا به طور خودکار آدرس‌های وب سرور خانگی و سرور هویت را پیکربندی کنند. این مفید است تا کاربران مجبور نباشند URL سرور اصلی مورد استفاده خود را حفظ کنند یا به آن فکر کنند.
URL
https://<server_name>/.well-known/matrix/clientباید JSON را در قالب زیر برگرداند.

{ "m.homeserver": { "base_url": "https://<matrix.example.com>" } }
این می تواند به صورت اختیاری حاوی اطلاعات سرور هویت نیز باشد.

{ "m.homeserver": { "base_url": "https://<matrix.example.com>" }, "m.identity_server": { "base_url": "https://<identity.example.com>" } }
برای کار در کلاینت های مبتنی بر مرورگر، فایل باید با سرصفحه های مناسب به اشتراک گذاری منابع متقاطع (CORS) ارائه شود. یک مقدار توصیه شده است
Access-Control-Allow-Origin: *که به همه مشتریان مبتنی بر مرورگر اجازه می دهد آن را مشاهده کنند.
در nginx این چیزی شبیه به:

location /.well-known/matrix/client { return 200 '{"m.homeserver": {"base_url": "https://<matrix.example.com>"}}'; default_type application/json; add_header Access-Control-Allow-Origin *; }
همچنین باید مطمئن شوید که
public_baseurlگزینه in
homeserver.yamlبه درستی تنظیم شده است.
public_baseurlباید روی URL که مشتریان برای اتصال به سرور شما استفاده می کنند تنظیم شود. این همان URL است که برای موارد
m.homeserver base_urlبالا قرار داده اید.

public_baseurl: "https://<matrix.example.com>"
ایمیل
مطلوب است که سیناپس قابلیت ارسال ایمیل را داشته باشد. این به Synapse امکان می‌دهد ایمیل‌های بازنشانی رمز عبور ارسال کند، تأییدیه‌هایی را هنگامی که آدرس ایمیل به حساب کاربر اضافه می‌شود ارسال کند، و هنگام دریافت پیام‌های جدید، اعلان‌های ایمیل را برای کاربران ارسال کند.
برای پیکربندی یک سرور SMTP برای Synapse، قسمت پیکربندی با عنوان را تغییر دهید
emailو مطمئن شوید که حداقل
smtp_hostفیلدهای
smtp_port و
notif_fromپر شده باشد. همچنین ممکن است لازم باشد
smtp_user،
smtp_passو و را تنظیم کنید
require_transport_security.
اگر ایمیل پیکربندی نشده باشد، بازنشانی رمز عبور، ثبت نام و اطلاع رسانی از طریق ایمیل غیرفعال خواهد شد.
ثبت نام کاربر
یک راه برای ایجاد یک کاربر جدید این است که این کار را از کلاینت مانند
Element انجام دهید . برای این کار باید ثبت نام از طریق تنظیمات فعال شود
enable_registration .
همچنین می توانید از خط فرمان کاربران جدیدی ایجاد کنید. این کار را می توان به صورت زیر انجام داد:
اگر سیناپس از طریق پیپ نصب شده است، virtualenv را به صورت زیر فعال کنید (اگر Synapse از طریق یک بسته از پیش ساخته شده نصب شده باشد،
register_new_matrix_userباید قبلاً در مسیر جستجو باشد):

cd ~/synapse source env/bin/activate synctl start # if not already running
دستور زیر را اجرا کنید:

register_new_matrix_user -c homeserver.yaml
این از شما می خواهد جزئیاتی را برای کاربر جدید اضافه کنید و سپس به Synapse در حال اجرا برای ایجاد کاربر جدید متصل می شود. به عنوان مثال:

New user localpart: erikj Password: Confirm password: Make admin [no]: Success!
این فرآیند از یک تنظیم استفاده می کند
registration_shared_secretکه بین خود Synapse و
register_new_matrix_user اسکریپت به اشتراک گذاشته شده است. مهم نیست که چه چیزی باشد (یک مقدار تصادفی توسط
--generate-config) ایجاد می شود، اما باید مخفی نگه داشته شود، زیرا هر کسی که از آن آگاهی داشته باشد می تواند کاربران، از جمله حساب های مدیریت، را در سرور شما ثبت کند، حتی اگر
enable_registrationباشد
false.
راه اندازی سرور TURN
برای اینکه تماس های VoIP قابل اعتماد از طریق این سرور خانگی هدایت شوند، باید سرور TURN را پیکربندی کنید. برای جزئیات به
تنظیمات TURN مراجعه کنید
.
پیش نمایش های URL
Synapse شامل پشتیبانی از پیش نمایش URL ها است که به طور پیش فرض غیرفعال است. برای روشن کردن آن، باید
url_preview_enabled: Trueپارامتر پیکربندی را فعال کنید و به صراحت محدوده های IP را مشخص کنید که Synapse مجاز به استفاده از آن برای پیش نمایش در پارامتر پیکربندی نیست
url_preview_ip_range_blacklist. این از منظر امنیتی برای جلوگیری از ایجاد URLهای داخلی «داخلی» توسط کاربران خودسرانه ماتریس در شبکه شما ضروری است. حداقل توصیه می کنیم که آدرس های IP Loopback و RFC1918 شما در لیست سیاه قرار گیرند.

lxmlاین همچنین مستلزم نصب وابستگی
اختیاری پایتون است.
این به نوبه خود مستلزم آن است که
libxml2کتابخانه در دسترس باشد – در Debian/Ubuntu این به معنای
apt-get install libxml2-devیا معادل آن برای سیستم عامل شما است.
عیب یابی نصب
pipبه نظر می رسد که حافظه
زیادی در حین نصب نشت می کند. به عنوان مثال، یک هاست لینوکس با 512 مگابایت رم ممکن است در حین نصب Twisted حافظه اش تمام شود. اگر این اتفاق بیفتد، باید وابستگی هایی را که شکست می خورند به صورت جداگانه نصب کنید، به عنوان مثال:

pip install twisted

اگر مشکل دیگری دارید، در #synapse:matrix.org بپ This documentation site is for the versions of Synapse maintained by the Matrix.org Foundation (github.com/matrix-org/synapse), available under the Apache 2.0 licence.
Since version 1.99, Synapse is now maintained by Element under a new licence (github.com/element-hq/synapse).
If you are interested in the documentation for a later version of Synapse, please click here to navigate to this same page on the latest Element Synapse documentation site, if it’s available.
Installation Instructions
Choosing your server name
It is important to choose the name for your server before you install Synapse, because it cannot be changed later.
The server name determines the “domain” part of user-ids for users on your server: these will all be of the format @user:my.domain.name. It also determines how other matrix servers will reach yours for federation.
For a test configuration, set this to the hostname of your server. For a more production-ready setup, you will probably want to specify your domain (example.com) rather than a matrix-specific hostname here (in the same way that your email address is probably user@example.com rather than user@email.example.com) – but doing so may require more advanced setup: see Setting up Federation.
Installing Synapse
Prebuilt packages
Prebuilt packages are available for a number of platforms. These are recommended for most users.
Docker images and Ansible playbooks
There is an official synapse image available at https://hub.docker.com/r/matrixdotorg/synapse or at ghcr.io/matrix-org/synapse which can be used with the docker-compose file available at contrib/docker. Further information on this including configuration options is available in the README on hub.docker.com.
Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a Dockerfile to automate a synapse server in a single Docker image, at https://hub.docker.com/r/avhost/docker-matrix/tags/
Slavi Pantaleev has created an Ansible playbook, which installs the official Docker image of Matrix Synapse along with many other Matrix-related services (Postgres database, Element, coturn, ma1sd, SSL support, etc.). For more details, see https://github.com/spantaleev/matrix-docker-ansible-deploy
Debian/Ubuntu
Matrix.org packages
Matrix.org provides Debian/Ubuntu packages of Synapse, for the amd64 architecture via https://packages.matrix.org/debian/.
To install the latest release:

sudo apt install -y lsb-release wget apt-transport-https sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/matrix-org.list sudo apt update sudo apt install matrix-synapse-py3
Packages are also published for release candidates. To enable the prerelease channel, add prerelease to the sources.list line. For example:

sudo wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main prerelease" | sudo tee /etc/apt/sources.list.d/matrix-org.list sudo apt update sudo apt install matrix-synapse-py3
The fingerprint of the repository signing key (as shown by gpg /usr/share/keyrings/matrix-org-archive-keyring.gpg) is AAF9AE843A7584B5A3E4CD2BCF45A512DE2DA058.
When installing with Debian packages, you might prefer to place files in /etc/matrix-synapse/conf.d/ to override your configuration without editing the main configuration file at /etc/matrix-synapse/homeserver.yaml. By doing that, you won’t be asked if you want to replace your configuration file when you upgrade the Debian package to a later version.
Downstream Debian packages
Andrej Shadura maintains a matrix-synapse package in the Debian repositories. For bookworm and sid, it can be installed simply with:

sudo apt install matrix-synapse
Synapse is also available in bullseye-backports. Please see the Debian documentation for information on how to use backports.
matrix-synapse is no longer maintained for buster and older.
Downstream Ubuntu packages
We do not recommend using the packages in the default Ubuntu repository at this time, as they are old and suffer from known security vulnerabilities. The latest version of Synapse can be installed from our repository.
Fedora
Synapse is in the Fedora repositories as matrix-synapse:

sudo dnf install matrix-synapse
Additionally, Oleg Girko provides Fedora RPMs at https://obs.infoserver.lv/project/monitor/matrix-synapse
OpenSUSE
Synapse is in the OpenSUSE repositories as matrix-synapse:

sudo zypper install matrix-synapse
SUSE Linux Enterprise Server
Unofficial package are built for SLES 15 in the openSUSE:Backports:SLE-15 repository at https://download.opensuse.org/repositories/openSUSE:/Backports:/SLE-15/standard/
ArchLinux
The quickest way to get up and running with ArchLinux is probably with the package provided by ArchLinux https://archlinux.org/packages/extra/x86_64/matrix-synapse/, which should pull in most of the necessary dependencies.
pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 ):

sudo pip install --upgrade pip
If you encounter an error with lib bcrypt causing an Wrong ELF Class: ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly compile it under the right architecture. (This should not be needed if installing under virtualenv):

sudo pip uninstall py-bcrypt sudo pip install py-bcrypt
Alpine Linux
6543 maintains Synapse packages for Alpine Linux in the community repository. Install with:

sudo apk add synapse
Void Linux
Synapse can be found in the void repositories as ‘synapse’:

xbps-install -Su xbps-install -S synapse
FreeBSD
Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Molloy from:
Ports: cd /usr/ports/net-im/py-matrix-synapse && make install clean
Packages: pkg install py38-matrix-synapse
OpenBSD
As of OpenBSD 6.7 Synapse is available as a pre-compiled binary. The filesystem underlying the homeserver directory (defaults to /var/synapse) has to be mounted with wxallowed (cf. mount(8)), so creating a separate filesystem and mounting it to /var/synapse should be taken into consideration.
Installing Synapse:

doas pkg_add synapse
NixOS
Robin Lambertz has packaged Synapse for NixOS at: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/synapse.nix
Installing as a Python module from PyPI
It’s also possible to install Synapse as a Python module from PyPI.
When following this route please make sure that the Platform-specific prerequisites are already installed.
System requirements:
POSIX-compliant system (tested on Linux & OS X)
Python 3.8 or later, up to Python 3.11.
At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org
If building on an uncommon architecture for which pre-built wheels are unavailable, you will need to have a recent Rust compiler installed. The easiest way of installing the latest version is to use rustup.
To install the Synapse homeserver run:

mkdir -p ~/synapse virtualenv -p python3 ~/synapse/env source ~/synapse/env/bin/activate pip install --upgrade pip pip install --upgrade setuptools pip install matrix-synapse
This will download Synapse from PyPI and install it, along with the python libraries it uses, into a virtual environment under ~/synapse/env. Feel free to pick a different directory if you prefer.
This Synapse installation can then be later upgraded by using pip again with the update flag:

source ~/synapse/env/bin/activate pip install -U matrix-synapse
Before you can start Synapse, you will need to generate a configuration file. To do this, run (in your virtualenv, as before):

cd ~/synapse python -m synapse.app.homeserver \ --server-name my.domain.name \ --config-path homeserver.yaml \ --generate-config \ --report-stats=[yes|no]
… substituting an appropriate value for --server-name and choosing whether or not to report usage statistics (hostname, Synapse version, uptime, total users, etc.) to the developers via the --report-stats argument.
This command will generate you a config file that you can then customise, but it will also generate a set of keys for you. These keys will allow your homeserver to identify itself to other homeserver, so don’t lose or delete them. It would be wise to back them up somewhere safe. (If, for whatever reason, you do need to change your homeserver’s keys, you may find that other homeserver have the old key cached. If you update the signing key, you should change the name of the key in the <server name>.signing.key file (the second word) to something different. See the spec for more information on key management).
To actually run your new homeserver, pick a working directory for Synapse to run (e.g. ~/synapse), and:

cd ~/synapse source env/bin/activate synctl start
Platform-specific prerequisites
Synapse is written in Python but some of the libraries it uses are written in C. So before we can install Synapse itself we need a working C compiler and the header files for Python C extensions.
Debian/Ubuntu/Raspbian
Installing prerequisites on Ubuntu or Debian:

sudo apt install build-essential python3-dev libffi-dev \ python3-pip python3-setuptools sqlite3 \ libssl-dev virtualenv libjpeg-dev libxslt1-dev libicu-dev
ArchLinux
Installing prerequisites on ArchLinux:

sudo pacman -S base-devel python python-pip \ python-setuptools python-virtualenv sqlite3 icu
CentOS/Fedora
Installing prerequisites on CentOS or Fedora Linux:

sudo dnf install libtiff-devel libjpeg-devel libzip-devel freetype-devel \ libwebp-devel libxml2-devel libxslt-devel libpq-devel \ python3-virtualenv libffi-devel openssl-devel python3-devel \ libicu-devel sudo dnf groupinstall "Development Tools"
macOS
Installing prerequisites on macOS:
You may need to install the latest Xcode developer tools:

xcode-select --install
Some extra dependencies may be needed. You can use Homebrew (https://brew.sh) for them.
You may need to install icu, and make the icu binaries and libraries accessible. Please follow the official instructions of PyICU to do so.
On ARM-based Macs you may also need to install libjpeg and libpq:

brew install jpeg libpq
On macOS Catalina (10.15) you may need to explicitly install OpenSSL via brew and inform pip about it so that psycopg2 builds:

brew install openssl@1.1 export LDFLAGS="-L/usr/local/opt/openssl/lib" export CPPFLAGS="-I/usr/local/opt/openssl/include"
OpenSUSE
Installing prerequisites on openSUSE:

sudo zypper in -t pattern devel_basis sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \ python-devel libffi-devel libopenssl-devel libjpeg62-devel \ libicu-devel
OpenBSD
A port of Synapse is available under net/synapse. The filesystem underlying the homeserver directory (defaults to /var/synapse) has to be mounted with wxallowed (cf. mount(8)), so creating a separate filesystem and mounting it to /var/synapse should be taken into consideration.
To be able to build Synapse’s dependency on python the WRKOBJDIR (cf. bsd.port.mk(5)) for building python, too, needs to be on a filesystem mounted with wxallowed (cf. mount(8)).
Creating a WRKOBJDIR for building python under /usr/local (which on a default OpenBSD installation is mounted with wxallowed):

doas mkdir /usr/local/pobj_wxallowed
Assuming PORTS_PRIVSEP=Yes (cf. bsd.port.mk(5)) and SUDO=doas are configured in /etc/mk.conf:

doas chown _pbuild:_pbuild /usr/local/pobj_wxallowed
Setting the WRKOBJDIR for building python:

echo WRKOBJDIR_lang/python/3.7=/usr/local/pobj_wxallowed \\nWRKOBJDIR_lang/python/2.7=/usr/local/pobj_wxallowed >> /etc/mk.conf
Building Synapse:

cd /usr/ports/net/synapse make install
Windows
Running Synapse natively on Windows is not officially supported.
If you wish to run or develop Synapse on Windows, the Windows Subsystem for Linux provides a Linux environment which is capable of using the Debian, Fedora, or source installation methods. More information about WSL can be found at https://docs.microsoft.com/en-us/windows/wsl/install for Windows 10/11 and https://docs.microsoft.com/en-us/windows/wsl/install-on-server for Windows Server.
Setting up Synapse
Once you have installed synapse as above, you will need to configure it.
Using PostgreSQL
By default Synapse uses an SQLite database and in doing so trades performance for convenience. Almost all installations should opt to use PostgreSQL instead. Advantages include:
significant performance improvements due to the superior threading and caching model, smarter query optimiser
allowing the DB to be run on separate hardware
For information on how to install and use PostgreSQL in Synapse, please see Using Postgres
SQLite is only acceptable for testing purposes. SQLite should not be used in a production server. Synapse will perform poorly when using SQLite, especially when participating in large rooms.
TLS certificates
The default configuration exposes a single HTTP port on the local interface: http://localhost:8008. It is suitable for local testing, but for any practical use, you will need Synapse’s APIs to be served over HTTPS.
The recommended way to do so is to set up a reverse proxy on port 8448. You can find documentation on doing so in the reverse proxy documentation.
Alternatively, you can configure Synapse to expose an HTTPS port. To do so, you will need to edit homeserver.yaml, as follows:
First, under the listeners option, add the configuration for the TLS-enabled listener like so:

listeners: - port: 8448 type: http tls: true resources: - names: [client, federation]
You will also need to add the options tls_certificate_path and tls_private_key_path. to your configuration file. You will need to manage provisioning of these certificates yourself.
You can find more information about these options as well as how to configure synapse in the configuration manual.
If you are using your own certificate, be sure to use a .pem file that includes the full certificate chain including any intermediate certificates (for instance, if using certbot, use fullchain.pem as your certificate, not cert.pem).
For a more detailed guide to configuring your server for federation, see Federation.
Client Well-Known URI
Setting up the client Well-Known URI is optional but if you set it up, it will allow users to enter their full username (e.g. @user:<server_name>) into clients which support well-known lookup to automatically configure the homeserver and identity server URLs. This is useful so that users don’t have to memorize or think about the actual homeserver URL you are using.
The URL https://<server_name>/.well-known/matrix/client should return JSON in the following format.

{ "m.homeserver": { "base_url": "https://<matrix.example.com>" } }
It can optionally contain identity server information as well.

{ "m.homeserver": { "base_url": "https://<matrix.example.com>" }, "m.identity_server": { "base_url": "https://<identity.example.com>" } }
To work in browser based clients, the file must be served with the appropriate Cross-Origin Resource Sharing (CORS) headers. A recommended value would be Access-Control-Allow-Origin: * which would allow all browser based clients to view it.
In nginx this would be something like:

location /.well-known/matrix/client { return 200 '{"m.homeserver": {"base_url": "https://<matrix.example.com>"}}'; default_type application/json; add_header Access-Control-Allow-Origin *; }
You should also ensure the public_baseurl option in homeserver.yaml is set correctly. public_baseurl should be set to the URL that clients will use to connect to your server. This is the same URL you put for the m.homeserver base_url above.

public_baseurl: "https://<matrix.example.com>"
Email
It is desirable for Synapse to have the capability to send email. This allows Synapse to send password reset emails, send verifications when an email address is added to a user’s account, and send email notifications to users when they receive new messages.
To configure an SMTP server for Synapse, modify the configuration section headed email, and be sure to have at least the smtp_host, smtp_port and notif_from fields filled out. You may also need to set smtp_user, smtp_pass, and require_transport_security.
If email is not configured, password reset, registration and notifications via email will be disabled.
Registering a user
One way to create a new user is to do so from a client like Element. This requires registration to be enabled via the enable_registration setting.
Alternatively, you can create new users from the command line. This can be done as follows:
If synapse was installed via pip, activate the virtualenv as follows (if Synapse was installed via a prebuilt package, register_new_matrix_user should already be on the search path):
cd ~/synapse source env/bin/activate synctl start # if not already running
Run the following command:
register_new_matrix_user -c homeserver.yaml
This will prompt you to add details for the new user, and will then connect to the running Synapse to create the new user. For example:

New user localpart: erikj Password: Confirm password: Make admin [no]: Success!
This process uses a setting registration_shared_secret, which is shared between Synapse itself and the register_new_matrix_user script. It doesn’t matter what it is (a random value is generated by --generate-config), but it should be kept secret, as anyone with knowledge of it can register users, including admin accounts, on your server even if enable_registration is false.
Setting up a TURN server
For reliable VoIP calls to be routed via this homeserver, you MUST configure a TURN server. See TURN setup for details.
URL previews
Synapse includes support for previewing URLs, which is disabled by default. To turn it on you must enable the url_preview_enabled: True config parameter and explicitly specify the IP ranges that Synapse is not allowed to spider for previewing in the url_preview_ip_range_blacklist configuration parameter. This is critical from a security perspective to stop arbitrary Matrix users spidering ‘internal’ URLs on your network. At the very least we recommend that your loopback and RFC1918 IP addresses are blacklisted.
This also requires the optional lxml python dependency to be installed. This in turn requires the libxml2 library to be available – on Debian/Ubuntu this means apt-get install libxml2-dev, or equivalent for your OS.
Troubleshooting Installation
pip seems to leak lots of memory during installation. For instance, a Linux host with 512MB of RAM may run out of memory whilst installing Twisted. If this happens, you will have to individually install the dependencies which are failing, e.g.:

pip install twisted
If you have any other problems, feel free to ask in #synapse:matrix.org.

منبع:

https://matrix-org.github.io/synapse/latest/setup/installation.html#