sbin/sync/README.md
changeset 1 3b0a8a6e685e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sbin/sync/README.md	Wed Jun 27 16:00:29 2018 +0200
@@ -0,0 +1,42 @@
+# Deployement scripts for ICONOLAB-MCC 
+
+Theses scripts uses `fabric` 2.X.
+
+  * create a virtualenv
+  * `$ pip install -r resquirements.txt`
+
+## Configuration
+
+The scripts are configured in the `fabric.py` file
+  * ` cp fabric.py.tmpl fabric.py`
+  * edit the file to match the expected configuration
+
+## Tasks
+the following task has been defined:
+
+  - create-virtualenv
+  - publish-version
+  - relaunch-server
+
+### relaunch-server
+
+Usage: `$ fab relaunch-server`
+Description: relaunch the webservices after calling the following commands on the server:
+  * `django-admin migrate`
+  * `django-admin collectstatic`
+
+### create-virtualenv
+
+Usage: `$ fab create-virtualenv <hg_tags>`
+Description: Create a virtualenv on the server with the new application version and the matching requirements. This deletes the previous virtualenv first.
+Please note that this command only creates the virtualenv. It does not create the full setup for the application :
+  * the settings file,
+  * the applications orchestration scripts,
+  * the application folders
+
+### publish-version
+
+Usage: `$ fab publish-version <hg_tags>`
+Description: publish the given version of the website. It calls the following commands:
+  * `create-virtualenv <hg_tags>`
+  * `relaunch-server`