summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2016-12-02 11:18:31 +0000
committerRichard van der Hoff <richard@matrix.org>2016-12-02 11:54:59 +0000
commitbb3d0c270d11c1cbae6754f2cddb2e7120c78637 (patch)
treeea5158253455bda4fc30fee4977cd4c205e2e27f /README.rst
parentREADME: code quotes (diff)
downloadsynapse-bb3d0c270d11c1cbae6754f2cddb2e7120c78637.tar.xz
README: remove refs to demo client
The demo client isn't really fit for purpose, so stop encouraging people to use
it.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst58
1 files changed, 22 insertions, 36 deletions
diff --git a/README.rst b/README.rst
index a748d6cacc..405f307eb7 100644
--- a/README.rst
+++ b/README.rst
@@ -67,17 +67,6 @@ hosted by someone else (e.g. matrix.org) - there is no single point of control
 or mandatory service provider in Matrix, unlike WhatsApp, Facebook, Hangouts,
 etc.
 
-Synapse ships with two basic demo Matrix clients: webclient (a basic group chat
-web client demo implemented in AngularJS) and cmdclient (a basic Python
-command line utility which lets you easily see what the JSON APIs are up to).
-
-Meanwhile, iOS and Android SDKs and clients are available from:
-
-- https://github.com/matrix-org/matrix-ios-sdk
-- https://github.com/matrix-org/matrix-ios-kit
-- https://github.com/matrix-org/matrix-ios-console
-- https://github.com/matrix-org/matrix-android-sdk
-
 We'd like to invite you to join #matrix:matrix.org (via
 https://matrix.org/docs/projects/try-matrix-now), run a homeserver, take a look
 at the Matrix spec at https://matrix.org/docs/spec and API docs at
@@ -209,39 +198,36 @@ run (e.g. ``~/.synapse``), and::
     synctl start
 
 
-Running The Demo Web Client
-===========================
-
-The homeserver runs a web client by default at https://localhost:8448/.
+Connecting to Synapse from a client
+===================================
 
-If this is the first time you have used the client from that browser (it uses
-HTML5 local storage to remember its config), you will need to log in to your
-account. If you don't yet have an account, because you've just started the
-homeserver for the first time, then you'll need to register one.
+The easiest way to try out your new Synapse installation is by connecting to it
+from a web client. We recommend the one at http://riot.im/app. You will need to
+specify a "Custom server" when you log on or register: set this to
+``https://localhost:8448`` - remember to specify the port (``:8448``) unless
+you changed the configuration. (Leave the identity server as the default - see
+`Identity servers`_.)
 
-Registering A New Account
--------------------------
+If all goes well you should at least be able to log in, create a room, and
+start sending messages.
 
-Your new user name will be formed partly from the hostname your server is
-running as, and partly from a localpart you specify when you create the
-account. Your name will take the form of::
+(The homeserver runs a web client by default at https://localhost:8448/, though
+as of the time of writing it is somewhat outdated and not really recommended -
+https://github.com/matrix-org/synapse/issues/1527).
 
-    @localpart:my.domain.here
-         (pronounced "at localpart on my dot domain dot here")
+Registering a new user from a client
+------------------------------------
 
-Specify your desired localpart in the topmost box of the "Register for an
-account" form, and click the "Register" button. Hostnames can contain ports if
-required due to lack of SRV records (e.g. @matthew:localhost:8448 on an
-internal synapse sandbox running on localhost).
+Your new user name will be formed partly from the ``server_name`` (see
+`Configuring synapse`_), and partly from a localpart you specify when you
+create the account. Your name will take the form of::
 
-If registration fails, you may need to enable it in the homeserver (see
-`Synapse Installation`_ above)
+    @localpart:my.domain.here
 
-Logging In To An Existing Account
----------------------------------
+(pronounced "at localpart on my dot domain dot here").
 
-Just enter the ``@localpart:my.domain.here`` Matrix user ID and password into
-the form and click the Login button.
+As when logging in, you will need to specify a "Custom server".  Specify your
+desired ``localpart`` in the 'User name' box.
 
 
 Security Note