Matrix - Revision history

Fjr9 at 05:22, 9 August 2025

2025-08-09T05:22:43Z

← Older revision		Revision as of 05:22, 9 August 2025
Line 30:		Line 30:
	== Configuration and Setup ==		== Configuration and Setup ==

	~~During installation,~~ the ~~Alpine Linux~~ synapse ~~package~~ will create a default synapse configuration file which will be located at {{path\|/etc/synapse/homeserver.conf}}.		When starting the synapse service for the first time, it will create a default synapse configuration file which will be located at {{path\|/etc/synapse/homeserver.conf}}.

	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

Romangeber: /* Configuration and Setup */

2025-01-25T08:56:44Z

Configuration and Setup

← Older revision		Revision as of 08:56, 25 January 2025
Line 34:		Line 34:
	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.
	Make sure the synapse user can read/edit the configuration directory:		Make sure the synapse user can read/edit the configuration directory:
	{{Cmd\| chown -R synapse:synapse/etc/synapse}}		{{Cmd\| chown -R synapse:synapse /etc/synapse}}

	Add synapse to the default runlevel to have it started at boot:		Add synapse to the default runlevel to have it started at boot:

Jhjacobs81: /* Configuration and Setup */

2024-10-03T18:09:49Z

Configuration and Setup

← Older revision		Revision as of 18:09, 3 October 2024
Line 33:		Line 33:

	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.
			Make sure the synapse user can read/edit the configuration directory:
			{{Cmd\| chown -R synapse:synapse/etc/synapse}}

			Add synapse to the default runlevel to have it started at boot:
			{{Cmd\| rc-update add synapse}}

	=== Reverse Proxy ===		=== Reverse Proxy ===
Line 45:		Line 50:

	The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql\|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.		The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql\|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.


	== See also ==		== See also ==

Jahway603: minor grammar

2024-09-18T15:48:02Z

minor grammar

← Older revision		Revision as of 15:48, 18 September 2024
Line 38:		Line 38:
	If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].		If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

	The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[~~nginx~~]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], or [[HAProxy]] to have in front of Synapse.		The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[Nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], or [[HAProxy]] to have in front of Synapse.

	=== Database ===		=== Database ===

Jahway603: removed relayd as reverse proxy as package does not exist on Alpine

2024-09-18T02:43:51Z

removed relayd as reverse proxy as package does not exist on Alpine

← Older revision		Revision as of 02:43, 18 September 2024
Line 38:		Line 38:
	If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].		If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

	The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], [[HAProxy~~]] or [[relayd~~]] to have in front of Synapse.		The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], or [[HAProxy]] to have in front of Synapse.

	=== Database ===		=== Database ===

Jahway603: Provided more reverse proxy info from upstream

2024-09-18T02:28:54Z

Provided more reverse proxy info from upstream

← Older revision		Revision as of 02:28, 18 September 2024
Line 34:		Line 34:
	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

	If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. ~~You are free~~ to ~~choose your~~ reverse proxy ~~of choice, as~~ [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples ~~the Matrix Synapse~~ documentation ~~has~~ examples] ~~for each one~~. I prefer [[nginx]], as I am familiar with it~~. Please make the best reverse proxy choice of one that~~ you ~~are familiar with~~, or ~~that you want~~ to ~~learn more about~~.		=== Reverse Proxy ===

			If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. One advantage of doing this is that you can expose the default HTTPS port (443) to Matrix clients [https://github.com/element-hq/synapse?tab=readme-ov-file#using-a-reverse-proxy-with-synapse without needing to run Synapse with root privileges].

			The Matrix developers have provided [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples very good documentation with reverse proxy examples]. I prefer [[nginx]], as I am most familiar with it, but you can also choose [[Apache]], [[Caddy]], [[HAProxy]] or [[relayd]] to have in front of Synapse.

	=== Database ===		=== Database ===

	Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.		Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used in a production environment.

	The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql\|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.		The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql\|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

Jahway603: Added upstream link to reverse proxy configuration examples

2024-09-18T02:19:41Z

Added upstream link to reverse proxy configuration examples

← Older revision		Revision as of 02:19, 18 September 2024
Line 34:		Line 34:
	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

	If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I ~~recommend~~ [[nginx]].		If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as [https://element-hq.github.io/synapse/latest/reverse_proxy.html#reverse-proxy-configuration-examples the Matrix Synapse documentation has examples] for each one. I prefer [[nginx]], as I am familiar with it. Please make the best reverse proxy choice of one that you are familiar with, or that you want to learn more about.

	=== Database ===		=== Database ===

Zcrayfish: Convert weblinks to wikilinks. Remove fluff.

2024-07-26T17:24:40Z

Convert weblinks to wikilinks. Remove fluff.

← Older revision		Revision as of 17:24, 26 July 2024
Line 34:		Line 34:
	You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.		You will want to refer to the [https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html Matrix Synapse Configuration Manual] to configure the various options.

	If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend nginx~~, which you can read more about on the [https://wiki.alpinelinux.org/wiki/Nginx Nginx Alpine Wiki page~~].		If you want your Matrix Synapse server to be accessed over the internet, then it is highly recommended to configure a [https://element-hq.github.io/synapse/latest/reverse_proxy.html reverse proxy] to do that. You are free to choose your reverse proxy of choice, as the Matrix Synapse documentation has examples for each one. I recommend [[nginx]].

	=== Database ===		=== Database ===
Line 40:		Line 40:
	Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.		Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

	The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [~~https://wiki.alpinelinux.org/wiki/~~Postgresql PostgreSQL ~~Alpine wiki page~~]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.		The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [[Postgresql\|PostgreSQL article]]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

Jahway603: fixed incorrectly formatted weblink

2024-07-23T02:48:17Z

fixed incorrectly formatted weblink

← Older revision		Revision as of 02:48, 23 July 2024
Line 40:		Line 40:
	Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.		Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

	The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [~~PostgreSQL Alpine wiki page~~ https://wiki.alpinelinux.org/wiki/Postgresql]. It is recommended that you install the latest release available ~~of PostgreSQL~~, which at this time is PostgreSQL 16.		The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [https://wiki.alpinelinux.org/wiki/Postgresql PostgreSQL Alpine wiki page]. It is recommended that you install the latest PostgreSQL release available, which at this time is PostgreSQL 16.

Jahway603: minor edit to fix page link

2024-07-22T02:16:08Z

minor edit to fix page link

← Older revision		Revision as of 02:16, 22 July 2024
Line 40:		Line 40:
	Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.		Once synapse is installed, you will need to select which database to use with it. By default, Synapse uses a SQLite database, which is only acceptable for testing purposes & should not be used a production environment.

	The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [PostgreSQL Alpine wiki ~~pagehttps~~://wiki.alpinelinux.org/wiki/Postgresql]. It is recommended that you install the latest release available of PostgreSQL, which at this time is PostgreSQL 16.		The Matrix Synapse developers recommend using PostgresSQL as your database backend. For more details on installing PostgresSQL, refer to the [PostgreSQL Alpine wiki page https://wiki.alpinelinux.org/wiki/Postgresql]. It is recommended that you install the latest release available of PostgreSQL, which at this time is PostgreSQL 16.