updated readme file

README.txt

@@ -1,67 +1,70 @@
-To compile:
+Compilation on Ubuntu/Debian
+============================
+
+1 - install package dependencies:
 
-- install the package dependencies. On ubuntu:
    # sudo apt-get install libglib2.0-dev libupnp-dev qt4-dev-tools \
-      libqt4-dev libssl-dev libxss-dev libgnome-keyring-dev libbz2-dev \
+      qt4-dev-tools libqt4-dev libssl-dev libxss-dev libgnome-keyring-dev libbz2-dev \
       libqt4-opengl-dev libqtmultimediakit1 qtmobility-dev \
-      libspeex-dev libspeexdsp-dev libxslt1-dev libprotobuf-dev \
-      protobuf-compiler cmake libcurl4-openssl-dev
+      libspeex-dev libspeexdsp-dev libxslt1-dev libcurl4-openssl-dev
+
+2 - checkout the source code
 
-- create project directory (e.g. ~/retroshare) and check out the source code
    # mkdir ~/retroshare
-   # cd ~/retroshare && svn co svn://svn.code.sf.net/p/retroshare/code/trunk trunk
+   # cd ~/retroshare 
+   # git clone https://github.com/RetroShare/RetroShare.git trunk
 
-- create a new directory named lib
-   # mkdir lib
+3 - compile
 
-- get source code for libssh-0.5.4, unzip it, and create build directory (if needed) 
-
-   # cd lib
-   # wget http://git.libssh.org/projects/libssh.git/snapshot/libssh-libssh-0.6.4.zip
-   # tar zxvf libssh-0.6.4.tar.gz
-   # cd libssh-0.6.4
-   # mkdir build
-   # cd build
-   # cmake -DWITH_STATIC_LIB=ON -DWITH_GSSAPI=OFF ..
-   # make
-   # cd ../../..
-
-- get source code for sqlcipher, and build it (only needed for GXS) 
-
-   # cd lib
-   # git clone git://github.com/sqlcipher/sqlcipher.git
-   # cd sqlcipher
-   # ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
-     LDFLAGS="-lcrypto"
-   # make
-   # cd ..
-
-- go to your svn base directory
    # cd trunk
-   # qmake CONFIG=release
-   # make -j 4
+   # qmake CONFIG=debug
+   # make
+
+   => the executables produced will be 
 
-   => the executable produced will be 
          trunk/retroshare-gui/src/Retroshare
          trunk/retroshare-nogui/src/retroshare-nogui
 
-- to use the SSH RS server (nogui):
+If libsqlcipher is not available as a package:
+=============================================
 
-   # ssh-keygen -t rsa -f rs_ssh_host_rsa_key   # this makes a RSA
-   # ./retroshare-nogui -G            # generates a login+passwd hash for the RSA key used.
-   # ./retroshare-nogui -S 7022 -U[SSLid] -P [Passwd hash]
+   You need to place sqlcipher so that the hierarchy is:
 
-- to connect from a remote place to the server by SSH:
+      retroshare
+          |
+          +--- trunk
+          |
+          +--- lib
+                |
+                +---- sqlcipher
 
-   # ssh -T -p 7022 [user]@[host]
+   # mkdir lib
+   # cd lib
+   # git clone git://github.com/sqlcipher/sqlcipher.git
+   # cd sqlcipher
+   # ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" LDFLAGS="-lcrypto"
+   # make
+   # cd ..
 
-   and use the command line interface to control your RS instance.
+Using retroshare-nogui & webUI
+==============================
 
-List of non backward compatible changes for V0.6:
-================================================
+   The webUI needs to be enabled as a parameter option in retroshare-nogui:
+
+      ./retroshare-nogui --webinterface 9090 --docroot /usr/share/RetroShare06/webui/
+
+   The webUI is only accessible on localhost:9090 (unless you canged that
+   option in the GUI). It is advised to keep it that way so that your RS
+   cannot be controlled using an untrusted connection.
+
+   To access your web UI from a distance, just open a SSH tunnel on it:
+
+      distant_machine:~/ >  ssh rs_host -L 9090:localhost:9090 -N
+
+   "rs_host" is the machine running retroshare-nogui. Then on the distant machine, access your webUI on 
+
+      http://localhost:9090
+
+   That also works with a retroshare GUI of course.
 
-- in rscertificate.cc, enable V_06_USE_CHECKSUM
-- in p3charservice, remove all usage of _deprecated items
-- turn file transfer into a service. Will break item IDs, but cleanup and
-  simplify lots of code.