Updated README files.

Author: dashohoxha

README.org

@@ -3,62 +3,40 @@ Drupal installation profile for B-Translator Client.
 
 * Installation
 
-  Assuming that we have a minimal ubuntu server 14.04 (trusty),
-  B-Translator Client can be installed in it like this:
+  Installation is done inside a Docker container.
+
+  + Modify and customize the settings:
+    #+BEGIN_EXAMPLE
+    cp btr_client/install/settings.sh cfg.sh
+    vim cfg.sh
+    #+END_EXAMPLE
+
+  + Build a Docker image:
+    #+BEGIN_EXAMPLE
+    btr_client/docker-build.sh cfg.sh --git_branch=master
+    less -r nohup-btr_client-master.out
+    #+END_EXAMPLE
+    This will create a docker image, named =btr_client:master= with a
+    minimal ubuntu system and everything that is needed for the normal
+    work of the system.
+
+  + Create a Docker container like this:
+    #+BEGIN_EXAMPLE
+    docker images
+    docker run -d --name=btr_client --hostname=example.org \
+	       -p 80:80 -p 443:443 btr_client:master
+    #+END_EXAMPLE
+    Then you can stop and start the container with =docker stop btr_client=
+    and =docker start btr_client=.
+
+  If it is installed on a local machine (for testing or development),
+  add the domain name =example.org= on ~/etc/hosts~:
   #+BEGIN_EXAMPLE
-  mkdir /var/chroot
-  cd /var/chroot/
-  git clone https://github.com/B-Translator/btr_client.git
-  cp btr_client/install/settings.sh btr_client/bcl.sh
-  vim btr_client/bcl.sh
-  nohup time nice btr_client/install/chroot.sh btr_client/bcl.sh &
-  tail -f nohup.out
-  less -r nohup.out
-  #+END_EXAMPLE
-
-  This will install in ~/var/chroot/~ a minimal ubuntu system,
-  B-Translator Client, and everything that is needed for the normal
-  work of the system. It will also make the neccessary common
-  configurations of the system.
-
-  The installation script will also create the init script
-  ~/etc/init.d/chroot-bcl~, which can be used to start and stop the
-  services inside the chroot:
-  #+BEGIN_EXAMPLE
-  /etc/init.d/chroot-bcl start
-  /etc/init.d/chroot-bcl stop
-  #+END_EXAMPLE
-
-
-* Installation in a docker container
-
-  This is almost the same as the installation above, except that
-  instead of ~install/chroot.sh~ you call ~install/docker.sh~:
-  #+BEGIN_EXAMPLE
-  nohup time nice btr_client/install/docker.sh btr_client/bcl.sh &
-  #+END_EXAMPLE
-
-  Then to start and stop B-Translator Client you do:
-  #+BEGIN_EXAMPLE
-  docker.io start bcl
-  docker.io stop bcl
-  #+END_EXAMPLE
-
-  Compared to the installation with chroot, docker has the advantage
-  that it is platform independent (the host system does not have to be
-  Ubuntu or Debian).
-
-
-* Building with docker
-
-  Another way is to use the command =docker build= to build an image
-  and then =docker run= to create a container from this image:
-  #+BEGIN_EXAMPLE
-  vim btr_client/install/settings.sh
-  docker.io build --tag=btr_client btr_client/
-  docker.io run -d --name=bcl --hostname=example.org \
-                -p 80:80 -p 443:443 btr_client
+  127.0.0.1 example.org
   #+END_EXAMPLE
+  This way it can be accessed by typing =https://example.org=
+  on the browser location (not =https://127.0.0.1= or
+  =https://localhost=).
 
 
 * What is B-Translator

dev/README.org

@@ -4,59 +4,18 @@
 
 Development Tools, Tips and Tricks
 
-* Installation
-
-  If you need to install frequently (for example for testing), a
-  script like this can be useful:
-  #+BEGIN_EXAMPLE
-  #!/bin/bash -x
-
-  source=dbox
-  installer=chroot
-  git_branch=master
-  nohup_out="nohup-$source-$git_branch-$installer.out"
-
-  rm -f $nohup_out
-  nohup time nice $source/install/{$installer.sh,settings.sh} cfg.sh \
-      --git_branch=$git_branch --reboot=true > $nohup_out &
-  sleep 1
-  tail -f $nohup_out
-  #+END_EXAMPLE
-
-  The file ~cfg.sh~ overrides the default config settings (for example
-  passwords):
-  #+BEGIN_EXAMPLE
-  apt_mirror='http://us-east-1.ec2.archive.ubuntu.com/ubuntu/'
-  gmail_account='[email protected]'
-  gmail_passwd=3omRoxtho
-  development='true'
-  #+END_EXAMPLE
-
-  You can also override configuration settings from the command line.
-
-  *Note:* The order of giving the settings is important. The last one
-  overrides the previous settings.
-
-
 * How to access the shell
 
   When things are still in development and testing we need to access
   the shell of the installed system in order to check log files,
   debug, play with changing configurations, etc.
 
-  When the installation is done on a chroot directory, then you simply
-  switch to it with the command =chroot=:
-  #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
-  #+END_EXAMPLE
-
-  When the installation is done in a docker container, you have to install
-  first the commands =nsenter= and =docker-enter= like this:
+  For this we can install the command =docker-enter=:
   #+BEGIN_EXAMPLE
   docker run -v /usr/local/bin:/target jpetazzo/nsenter
   #+END_EXAMPLE
 
-  Then you can access the shell of a running container like this:
+  Then access the shell of a running container like this:
   #+BEGIN_EXAMPLE
   docker-enter bcl
   #+END_EXAMPLE
@@ -67,19 +26,27 @@ Development Tools, Tips and Tricks
 
 * Install sshd
 
-  In order to access the server remotely through drush, ssh-client,
-  etc. you can install *sshd* with the script ~dev/install-sshd.sh~,
-  like this:
+  We want to start a sshd server on port 2201 inside the container,
+  but when we created the container with =docker run= we did not think
+  about forwarding this port. We have to destroy this container and
+  create a new one, with an addition =-p= option for the
+  port 2201. But first we should use the command =docker commit= to
+  save to a new image any configurations and data that we already have
+  in this container.
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
-  cd /usr/local/src/btr_client/
-  dev/install-sshd.sh
+  docker stop bcl
+  docker commit bcl btr_client:1
+  docker images
+  docker rm bcl
+  docker run -d --name=bcl --hostname=example.org \
+	     -p 80:80 -p 443:443 -p 2201:2201 btr_client:1
   #+END_EXAMPLE
 
-  By default it will install and run a sshd that listens on the port *2201*,
-  but you can also give it the port number as an argument:
+  Now we can enter the container and start the sshd server:
   #+BEGIN_EXAMPLE
-  dev/install-sshd.sh 2211
+  docker-enter bcl
+  cd /usr/local/src/btr_client/
+  dev/install-sshd.sh 2201
   #+END_EXAMPLE
 
 
@@ -88,12 +55,10 @@ Development Tools, Tips and Tricks
   There are two webservers installed, apache2 and nginx (with php5-fpm
   and memcached). For development Apache2 can be more suitable, while
   for production NGINX is supposed to be more responsive in high load.
-  It also has built-in cache and its configuration is tweaked for DoS
-  protection, short timeout, etc.
 
   We can choose one of them like this:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   dev/webserver.sh apache2
   dev/webserver.sh nginx
@@ -104,9 +69,9 @@ Development Tools, Tips and Tricks
 
   Clones of the main site can be used for development and testing. 
 
-  Inside the chroot you can make a clone for development like this:
+  Inside the container you can make a clone for development like this:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   dev/clone.sh bcl bcl_dev1
   dev/clone.sh bcl_dev1 bcl_test1
@@ -123,7 +88,7 @@ Development Tools, Tips and Tricks
   Other clones like this can be created for testing etc. To cleanup
   (remove/erase) a clone, you can use *clone_rm.sh* like this:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   dev/clone_rm.sh bcl_dev1
   dev/clone_rm.sh bcl_test1
@@ -134,7 +99,7 @@ Development Tools, Tips and Tricks
   a development copy with a live or testing one), with the script
   =dev/config.php=:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   drush @bcl_dev php-script dev/config.php dev2
   #+END_EXAMPLE
@@ -149,7 +114,7 @@ Development Tools, Tips and Tricks
 
   It can be done with the script =dev/reinstall.sh=:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   nohup nice dev/reinstall.sh settings.sh &
   tail -f nohup.out
@@ -165,7 +130,7 @@ Development Tools, Tips and Tricks
   Drupal and nothing else, can be done with the script
   =dev/reinstall-db.sh=:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   nohup nice dev/reinstall-db.sh @bcl_dev &
   tail -f nohup.out
@@ -190,7 +155,7 @@ Development Tools, Tips and Tricks
   the code (the whole Drupal directory) and the database. It can be
   done like this:
   #+BEGIN_EXAMPLE
-  chroot /var/chroot/bcl/
+  docker-enter bcl
   cd /usr/local/src/btr_client/
   dev/snapshot.sh make @bcl
   dev/snapshot.sh make @bcl_dev
@@ -221,20 +186,56 @@ Development Tools, Tips and Tricks
   #+END_EXAMPLE
 
 
-* Accessing the code of the application from outside chroot
-
-  In order to access easily the code of the application from outside
-  chroot, you can create a symbolic link like this:
-  #+BEGIN_EXAMPLE
-  cd /var/chroot/
-  ln -s bcl/var/www/bcl_dev/profiles/btr_client/ \
-        bcl_dev
-  #+END_EXAMPLE
-
-  Now you can go to */var/chroot/dev/* and start /emacs/ or any other
-  tools. This way you don't have to install /emacs/ or any other
-  development tools inside the /chroot/ and can use the best of
-  development tools that your host system can offer.
+* Accessing the code of the application from outside container
+
+  In general it is not possible to directly access the directories and
+  files of of a container from the host system.  However we can use
+  the docker /volumes/ to share directories between the container and
+  the host. It can be done like this:
+
+  + First we make a backup of the directory inside the container that
+    we want to share:
+    #+BEGIN_EXAMPLE
+    docker-enter bcl
+    cd /var/www/bcl_dev/profiles/
+    cp -a btr_client/ btr_client-bak
+    exit
+    #+END_EXAMPLE
+
+  + Then we save the image of the container as =btr_client:dev=, in order
+    to start a new container based on it:
+    #+BEGIN_EXAMPLE
+    docker stop bcl
+    docker commit bcl btr_client:dev
+    docker images
+    #+END_EXAMPLE
+
+  + Next we create a new container that shares a directory with the
+    host system (using the option =-v=):
+    #+BEGIN_EXAMPLE
+    docker run -d --name=bcl_dev --hostname=dev.example.org \
+	       -v $(pwd)/bcl_dev:/var/www/bcl_dev/profiles/btr_client/
+	       -p 80:80 -p 443:443 btr_client:dev
+    #+END_EXAMPLE
+    *Note:* The container *bcl* must be stoped before we create and
+    start the new container *bcl_dev*, otherwise the ports 80 and 443
+    will conflict.
+
+  + Finally we enter the container and move the content of the backup
+    directory to the shared directory:
+    #+BEGIN_EXAMPLE
+    docker-enter bcl_dev
+    cd /var/www/bcl_dev/profiles/btr_client/
+    cp -a ../btr_client-bak/* .
+    cp -a ../btr_client-bak/.* .
+    rm -rf ../btr_client-bak/
+    exit
+    #+END_EXAMPLE
+
+  Now we can go to the directory *bcl_dev/* and start /emacs/ or any
+  other tools. This way we don't have to install /emacs/ or any other
+  development tools inside the container and we can use the best of
+  development tools that the host system can offer.
 
 
 * Pushing commits
@@ -289,7 +290,7 @@ Development Tools, Tips and Tricks
   At some point, all the modifications on the local copy of the
   application (sandbox) have to be transferred to a public server,
   where the application is in "production", performing "live". On that
-  public server there is the same /chroot/ environment as in the
+  public server there is the same docker container as in the
   development server. The synchronization of the application can be
   done via git push and pull.
 
@@ -371,8 +372,8 @@ Development Tools, Tips and Tricks
   option on the config file will make sure that it fails.
 
   For drush commands to work remotely, *ssh* daemon has to be running
-  on the remote server, inside the chroot environment. By default it
-  is not installed, but it can be installed with the script
+  on the remote server, inside the docker container. By default it is
+  not installed, but it can be installed with the script
   *dev/install-sshd.sh*. This script will also take care to change the
   ssh port to *2201*, in order to avoid any conflicts with any
   existing daemon on the host environment, and also for increased