[Libreoffice-commits] online.git: loleaflet/README loolwsd/README

[Pranav Kant]

 loleaflet/README |   28 ++++++++++++++++++++++------
 loolwsd/README   |   25 +++++++++++++++++++++++++
 2 files changed, 47 insertions(+), 6 deletions(-)

New commits:
commit 06bc5cf33e484372fba530e420ca8fde601a2f61
Author: Pranav Kant <pranavk at collabora.com>
Date:   Tue Mar 22 16:09:22 2016 +0530

    Update READMEs for SSL and Admin panel
    
    Change-Id: I7b511071ab286474b35f40f40839aa2c44fa53f1

diff --git a/loleaflet/README b/loleaflet/README
index f4ac2b7..cfb0a1e 100644
--- a/loleaflet/README
+++ b/loleaflet/README
@@ -41,16 +41,32 @@ To see an example:
 
     ./loolwsd --systemplate=${SYSTEMPLATE} --lotemplate=${MASTER}/instdir --childroot=${ROOTFORJAILS}
 
-* open debug/document/document_simple_example.html in the browser, like:
+Note that this will, by default, set the loolwsd's file server's root to the parent directory of loolwsd,
+which means you can access all the files in loleaflet using /loleaflet/ path. It is advised to set
+fileserverroot manually for more control. See loolwsd/README for more information.
 
-    firefox debug/document/document_simple_example.html
+* open debug/document/document_simple_example.html or dist/loleaflet.html through loolwsd's fileserver
 
-* modify the URL to allow loleaflet to connect to a server and open a document
-
-    http://web-page/document_simple_example.html?file_path=file:///PATH/TO/DOC&host=ws://localhost:9980
+    https://localhost:9980/loleaflet/dist/loleaflet.html?file_path=file:///PATH/TO_DOC&host=wss://localhost:9980
 
 and you should see the document in the browser.  In case anything goes wrong,
-check the loolwsd console for the debugging output.
+check the loolwsd console for the debugging output. You might be asked to confirm the certificate if you
+are using self-signed certificate for loolwsd.
+
+Admin Panel
+-----------
+
+You can do live monitoring of all the user sessions running on loolwsd instance. To access the admin
+console you need to ask for admin.html file from loolwsd which resides in dist/admin/admin.html.
+
+For example:
+
+    https://localhost:9980/loleaflet/dist/admin/admin.html
+
+It will ask for username and password which, by default, are 'admin', 'admin' respectively. After entering
+the correct password you should be able to monitor the live documents opened, total users, memory consumption,
+document URLs with number of users viewing that document etc. You can also kill the documents directly from
+the panel which would result in closing the socket connection to the respective document.
 
 Testing
 -------
diff --git a/loolwsd/README b/loolwsd/README
index 28d1bdc..adac8bc 100644
--- a/loolwsd/README
+++ b/loolwsd/README
@@ -102,6 +102,25 @@ ${SYSTEMPLATE} and the ${MASTER}/instdir directories into each chroot
 jail, ${SYSTEMPLATE} and ${MASTER}/instdir need to be on the same file
 system as ${ROOTFORJAILS}.
 
+Leaflet files are served itself by loolwsd internal file server. You can specify the
+root of this fileserver using the --fileserverroot flag in loolwsd commandline.
+By default, if you do not specify this flag, the parent directory of loolwsd/
+is assumed to be the fileserverroot. So, for development purposes, you can access
+the leaflet files (using /loleaflet/), but it is advised to explicitly set the
+fileserverroot to prevent any unwanted files from reading, especially when lool
+is deployed for normal public usage on servers.
+
+Please note that it is necessary that all the leaflet files that are meant to be
+served is under a directory named 'loleaflet'. Since, the loleaflet files, in
+lool git repo, are itself in a directory named 'loleaflet', this would work out of
+the box for development purposes.
+
+loolwsd only runs on HTTPS which means you would have to set up your own private
+key and certificate (in PEM format only). Currently, loolwsd assumes files with
+name cert.pem, and key.pem to be certificate and private key respectively.
+Dummy self-signed cert.pem and key.pem are already included, but it is better
+to replace those with your own files.
+
 If you plan to hack on loolwsd, you probably want to familiarize
 yourself with loolwsd's --test and --numprespawns switches, and the
 'connect' test program.
@@ -115,6 +134,12 @@ scripting, etc. For instance:
     (echo load /some/where/foo.odt; echo tile part=0 width=500 height=500 tileposx=0 tileposy=0 tilewidth=10000 tileheight=10000; sleep 10) |
     ./loolwsd --test --systemplate=/home/tml/lo/master/lool-sys-template --lotemplate=/home/tml/lo/master/instdir --childroot=/home/tml/lo/master/lool-child-root
 
+Admin Panel
+-----------
+
+You can access the admin panel by directly acessing the admin.html file from loleaflet directory.
+See loleaflet/README for more details.
+
 Debugging
 ---------