summary refs log tree commit diff
path: root/webclient/README
diff options
context:
space:
mode:
Diffstat (limited to 'webclient/README')
-rw-r--r--webclient/README18
1 files changed, 15 insertions, 3 deletions
diff --git a/webclient/README b/webclient/README
index 0f893b1712..9750d2706a 100644
--- a/webclient/README
+++ b/webclient/README
@@ -1,12 +1,24 @@
 Basic Usage
 -----------
 
-The Synapse web client needs to be hosted by a basic HTTP server.
-
-You can use the Python simple HTTP server::
+The web client should automatically run when running the home server. Alternatively, you can run
+it stand-alone:
 
     $ python -m SimpleHTTPServer
 
 Then, open this URL in a WEB browser::
 
     http://127.0.0.1:8000/
+
+
+ReCaptcha Keys
+--------------
+The web client will look for the global variable webClientConfig for config options. You should
+put your ReCaptcha public key there like so:
+
+webClientConfig = {
+        recaptcha_public_key: "YOUR_PUBLIC_KEY"
+}
+
+This should be put in webclient/config.js which is already .gitignored, rather than in the web
+client source files.