updated documentation & added changelog

Author: sylvainbx

.gitignore

@@ -22,3 +22,4 @@
 
 config/database.yml
 .DS_Store
+.idea

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog OpenLab-Projects
+
+## v1.0.1 2018 July 25
+
+- Updated loofah (2.0.3 -> 2.2.2) to fix [CVE-2018-8048](https://github.com/flavorjones/loofah/issues/144)
+- Updated nokogiri (1.6.7.2 -> 1.8.4) to fix [CVE-2017-18258](https://nvd.nist.gov/vuln/detail/CVE-2017-18258)
+- Updated rails-html-sanitizer (1.0.3 -> 1.0.4) to fix [CVE-2017-18258](https://nvd.nist.gov/vuln/detail/CVE-2017-18258)
+- Updated rails (5.0.0.beta3 -> 5.0.0.rc2) to fix nokogiri dependency update
+- Fixed Dockerfile (ruby image was updated by the owner)
+- Added deployment instructions to the README

README.md

@@ -2,6 +2,12 @@
 
 ### dev env
 
+Prerequisites :
+- RVM
+- ElasticSearch
+- PostgreSQL
+- Redis
+
 ```bash
 gem install bundler
 bundle
@@ -12,6 +18,29 @@ foreman s
 
 ### prod env
 
+Get up-to-date docker image and remove the current running container
+```bash
+docker pull sleede/openlab-projects
+docker rm -f openlab
+```
+
+If any asset has changed, recompile them
+```bash 
+rm -rf public/assets/
+docker run --rm \
+  --link=openlab-postgres:postgres \
+  --link=openlab-redis:redis \
+  --link=openlab-elastic:elasticsearch \
+  -e RAILS_ENV=production \
+  --env-file /home/core/openlab/config/env \
+  -v /home/core/openlab/public/assets:/usr/src/app/public/assets \
+  sleede/openlab-projects \
+  bundle exec rake assets:precompile
+```
+
+If the database has changed (migration) or any other change occurred, run the specific commands like the "asset precompile" one (eg. bundle exec rake db:migrate).
+
+Finally restart the container
 ```bash
 docker run --restart=always -d --name=openlab \
   -p 80:80 \