diff --git a/README.md b/README.md index 0840546..97ae14e 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,13 @@ Synapse Registration Bash This custom synapse registration page relies on capthouli captcha and fcgiwrap to run the shell scripts. TODO: write more shit + +Instalation +--- + +* Install captchouli and set `captchouliurl` in config file +* Install fcgiwrap and configure your nginx to serve the `registerform.sh` and `do-register.sh`. +* Configure nginx to send GET request to captchouli server, and POST to the `registerform.sh`. `do-register.sh` can be accessed directly. +* Configure `elementurl` in config file to point at element so it can redirect to login page on success, and `registrationurl` to point at domain where the registration scripts are served. `synapse_admin_api` in the config should point at domain where your synapse exposes admin api for registrationi +* get `registration_shared_secret:` from your synapse homeserver.yaml and configure it in `~/.secret` file of the user that is running your fcgiwrap service (http or www-data most likely) +* The registration scripts will display banner.png and background.jpg from the root of your webpage, so you might want to set those up. diff --git a/config b/config new file mode 100644 index 0000000..04516ef --- /dev/null +++ b/config @@ -0,0 +1,4 @@ +captchouliurl=http://mugi.midov.pl +elementurl=https://matrix.midov.pl +registrationurl=https://midov.pl +synapse_admin_api=http://yoshika.midov.pl:8008