From 938939fd89518ba6db833c9463973f18d752fefc Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 13:48:06 +0100 Subject: Move CAPTCHA_SETUP to docs/ --- docs/CAPTCHA_SETUP | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/CAPTCHA_SETUP (limited to 'docs') diff --git a/docs/CAPTCHA_SETUP b/docs/CAPTCHA_SETUP new file mode 100644 index 0000000000..75ff80981b --- /dev/null +++ b/docs/CAPTCHA_SETUP @@ -0,0 +1,31 @@ +Captcha can be enabled for this home server. This file explains how to do that. +The captcha mechanism used is Google's ReCaptcha. This requires API keys from Google. + +Getting keys +------------ +Requires a public/private key pair from: + +https://developers.google.com/recaptcha/ + + +Setting ReCaptcha Keys +---------------------- +The keys are a config option on the home server config. If they are not +visible, you can generate them via --generate-config. Set the following value: + + recaptcha_public_key: YOUR_PUBLIC_KEY + recaptcha_private_key: YOUR_PRIVATE_KEY + +In addition, you MUST enable captchas via: + + enable_registration_captcha: true + +Configuring IP used for auth +---------------------------- +The ReCaptcha API requires that the IP address of the user who solved the +captcha is sent. If the client is connecting through a proxy or load balancer, +it may be required to use the X-Forwarded-For (XFF) header instead of the origin +IP address. This can be configured as an option on the home server like so: + + captcha_ip_origin_is_x_forwarded: true + -- cgit 1.4.1 From 35698484a51081126d3f8b37a599d7d37a91f5fb Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:51:09 +0100 Subject: Add some information on registering AS's --- CHANGES.rst | 2 ++ docs/application_services.rst | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/application_services.rst (limited to 'docs') diff --git a/CHANGES.rst b/CHANGES.rst index dc9fcf98dd..f0bb973dcf 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -40,8 +40,10 @@ Application services: instead their configuration should be saved to a file and listed in the synapse ``app_service_config_files`` config option. The AS configuration file has the same format as the old ``/register`` request. + See `docs/application_services.rst`_ for more information. .. _`docs/postgres.rst`: docs/postgres.rst +.. _`docs/application_services.rst`: docs/application_services.rst .. _`Registration`: https://github.com/matrix-org/matrix-doc/blob/master/specification/10_client_server_api.rst#registration .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys .. _`Application Services`: https://github.com/matrix-org/matrix-doc/blob/0c6bd9/specification/25_application_service_api.rst#home-server---application-service-api diff --git a/docs/application_services.rst b/docs/application_services.rst new file mode 100644 index 0000000000..07236e62ae --- /dev/null +++ b/docs/application_services.rst @@ -0,0 +1,26 @@ +Registering an Application Service +================================== + +The registration of new application services is implementation dependent. In +synapse you need to create a new configuration file for you AS and add it to +the list of AS's specified under ``app_service_config_files`` synapse +config option. + +The format of the AS configuration file is as follows:: + + url: + as_token: + hs_token: + sender_localpart: + namespaces: + users: # List of users we're interested in + - exclusive: + regex: + - ... + aliases: [] # List of aliases we're interested in + rooms: [] # List of room ids we're interested in + +See the spec_ for further details on how application services work. + +.. _spec: https://github.com/matrix-org/matrix-doc/blob/master/specification/25_application_service_api.rst#application-service-api + -- cgit 1.4.1 From 5fe26a9b5ccabf68d833afe0021638bbb8deaa4d Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:54:53 +0100 Subject: Reword docs/application_services.rst --- docs/application_services.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/application_services.rst b/docs/application_services.rst index 07236e62ae..69f7e41b8a 100644 --- a/docs/application_services.rst +++ b/docs/application_services.rst @@ -1,12 +1,14 @@ Registering an Application Service ================================== -The registration of new application services is implementation dependent. In -synapse you need to create a new configuration file for you AS and add it to -the list of AS's specified under ``app_service_config_files`` synapse -config option. +The registration of new application services depends on the homeserver used. +In synapse you need to create a new configuration file for your AS and add it +to the list of AS's specified under the ``app_service_config_files`` config +option in your synapse config. -The format of the AS configuration file is as follows:: +The format of the AS configuration file is as follows: + +.. code-block:: yaml url: as_token: -- cgit 1.4.1 From 6101ce427a3e903449a1be6dbac4419714990298 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:58:28 +0100 Subject: Slight rewording --- docs/application_services.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/application_services.rst b/docs/application_services.rst index 69f7e41b8a..a57bae6194 100644 --- a/docs/application_services.rst +++ b/docs/application_services.rst @@ -2,10 +2,18 @@ Registering an Application Service ================================== The registration of new application services depends on the homeserver used. -In synapse you need to create a new configuration file for your AS and add it -to the list of AS's specified under the ``app_service_config_files`` config +In synapse, you need to create a new configuration file for your AS and add it +to the list specified under the ``app_service_config_files`` config option in your synapse config. +For example: + +.. code-block:: yaml + + app_service_config_files: + - /home/matrix/.synapse/.yaml + + The format of the AS configuration file is as follows: .. code-block:: yaml -- cgit 1.4.1