Index: lams_tool_doku/readme.txt =================================================================== RCS file: /usr/local/cvsroot/lams_tool_doku/readme.txt,v diff -u -r1.2 -r1.3 --- lams_tool_doku/readme.txt 27 Jan 2017 18:44:13 -0000 1.2 +++ lams_tool_doku/readme.txt 2 Feb 2017 14:31:43 -0000 1.3 @@ -1,3 +1,17 @@ Modifications required to be done for Etherpad server (version #1.6.1): -Copy the folder /lams_tool_doku/conf/etherpad-lite/src/ over to /${etherpad-lite-server-folder}/src/ -(it will copy three files /src/node/utils/Settings.js, /src/static/js/pad.js and /src/static/js/pad_userlist.js). \ No newline at end of file +* Copy the folder /lams_tool_doku/conf/etherpad-lite/src/ over to /${etherpad-lite-server-folder}/src/ +(it will copy three files /src/node/utils/Settings.js, /src/static/js/pad.js and /src/static/js/pad_userlist.js). + +* In order to hide Etherpad index page make the following file empty: /${etherpad-lite-server-folder}/src/templates/index.html. +Besides, one can turn on "editOnly" option in /${etherpad-lite-server-folder}/settings.json. This option's description: "Users may edit pads but not create new ones. Pad creation is only via the API. This applies both to group pads and regular pads." + + +----------Same domain policy--------- +Etherpad server should be installed on the same domain as LAMS server. +Although it's possible to install it on another subdomain, it has a few limitations in terms of format of supported domain names. +Let's say domain name is domain.tld, then: +* tld part of the domain name should consist of only one part (e.g. lams.com, lams.au) +* if we need to support more complex tld parts (e.g. lams.com.ru) it needs to be added to the hardcoded regex in Java code - https://code.lamsfoundation.org/fisheye/browse/lams/lams_tool_doku/src/java/org/lamsfoundation/lams/tool/dokumaran/service/DokumaranService.java?hb=true#to892 +Currently only complex tlds of Singapore, Australia and UK are added to this regex. +** If we will decide to start supporting all possible domain tlds in the future - we will need to download full tld list (https://publicsuffix.org/list/effective_tld_names.dat) +and make use of it using 3rd party Java library https://github.com/whois-server-list/public-suffix-list