Commit af82d1a5 authored by Nathalie Rousse's avatar Nathalie Rousse
Browse files

Updating deployment documentation

parent 89fc742b
* sudo :
apt-get install sudo
* pip :
sudo apt-get install python-pip
* python 2.7 :
sudo apt-get install python2.7
sudo apt-get install python-dev
* virtualenv tool installation :
sudo pip install virtualenv
* Static files creation (css, js, images) :
cd /opt/erecord/erecord/projects/ws
python manage.py collectstatic
* copy/overwrite erecord/erecord to /opt/erecord/erecord
* copy/overwrite erecord/docs to /opt/erecord/docs
......@@ -27,17 +27,6 @@ erecord_path is 'erecord' under :ref:`deploy_root_path`.
In the deployment example, erecord_path is '/opt/erecord'.
.. _deploy_erecordenv_path:
erecordenv_path
===============
Let's name **erecordenv_path** the directory where the erecordenv virtualenv is
installed.
In the deployment example, erecordenv_path is 'install' under 'factory' under
:ref:`deploy_erecord_path`, ie '/opt/erecord/factory/install'.
.. _deploy_erecord_docs_path:
erecord_docs_path
......@@ -59,56 +48,3 @@ the erecord project software. erecord_repositories_path is 'repositories' under
In the deployment example, erecord_repositories_path is
'/opt/erecord/repositories'.
.. _deploy_requirement.txt_file:
requirement.txt file
====================
The requirement.txt file is part of the erecord package. It is used to install
some python modules. Its location is 'erecord/install' under
:ref:`deploy_erecord_path`.
In the deployment example its full path is
'/opt/erecord/erecord/install/requirement.txt'.
.. _deploy_wsgi.py_file:
wsgi.py file
============
The wsgi.py file is part of the ws project. Its location is
'erecord/projects/ws/ws' under :ref:`deploy_erecord_path`.
In the deployment example its full path is
'/opt/erecord/erecord/projects/ws/ws/wsgi.py'.
.. _deploy_config.py_file:
config.py file
==============
The config.py file is part of the erecord_cmn application. Its location is
'erecord/erecord/apps/erecord_com/config' under :ref:`deploy_erecord_path`.
In the deployment example its full path is
'/opt/erecord/erecord/apps/erecord_cmn/configs/config.py'.
.. _deploy_settings.py_file:
settings.py file
================
The settings.py file is part of the ws project. Its location is
'erecord/erecord/projects/ws/ws' under :ref:`deploy_erecord_path`.
In the deployment example its full path is
'/opt/erecord/erecord/projects/ws/ws/settings.py'.
.. _deploy_erecord_ws_file:
erecord_ws file
===============
The erecord_ws file is part of the ws project. Its location is
'erecord/erecord/projects/ws/ws' under :ref:`deploy_erecord_path`.
In the deployment example its full path is
'/opt/erecord/erecord/projects/ws/ws/erecord_ws'.
......@@ -66,15 +66,3 @@ More
:ref:`Installation of erecord in case of development situation <devel_deployment_install_erecord_devcase>`
Ce qui suit OLDASUPPRIMER
=========================
See :ref:`devel_deployment_updating_case`.
See :ref:`devel_deployment_fromscratch_case`.
Running instructions
====================
See :ref:`deploy_run_server`.
......@@ -6,8 +6,8 @@ Installation of erecord
.. literalinclude:: ../../../../erecord/install/prod/install.txt
Installation remaining to be done
=================================
Other installations to be done
==============================
Vle environment
---------------
......@@ -19,4 +19,5 @@ Vle environment
Simulators HTML home pages
--------------------------
.. literalinclude:: ../../../../erecord/install/prod/install_vpz_html_home_pages.txt
- :ref:`devel_deployment_install_simulators_html_home_pages`
.. _devel_deployment_install_simulators_html_home_pages:
==========================================
Installation of simulators HTML home pages
==========================================
.. literalinclude:: ../../../../erecord/install/prod/install_vpz_html_home_pages.txt
......@@ -4,6 +4,8 @@
Installation guide of models repositories
=========================================
*a supprimer !!!*
Introduction
============
......
.. _deploy_run_server:
===========================
Running server instructions
===========================
The apache2 user (user www-data and group www-data) must be the owner of
the :ref:`deploy_root_path` and of /var/www (online documentation) :
sudo chown www-data:www-data -R /opt
sudo chown www-data:www-data -R /var/www
Activate erecordenv virtualenv (if not yet done) :
.. literalinclude:: include/cmd_activate_erecordenv_virtualenv.rst
Install and activate the erecord_ws site (if not yet done) :
.. literalinclude:: include/cmd_install_and_activate_erecord_ws.rst
Apache server commands :
.. literalinclude:: include/cmd_run_apache.rst
The erecord web site *(online documentation)* and the erecord web services are
now both online at their erecord virtual machine *(whose IP address is ... )* :
- erecord web site online at http://erecord.toulouse.inra.fr .
- erecord web services online at http://erecord.toulouse.inra.fr:8000 .
.. _devel_deployment_updating_case:
=======================================
Installation procedure in updating case
=======================================
1. Development environment updating
===================================
See the concerned part in :ref:`Development environment installation <deploy_development_environment_install>`.
2. erecord project software updating
====================================
If the **source code** or **documentation** code of the erecord project
software has changed, then the corresponding directories are to be updated
under :ref:`deploy_root_path`.
The concerned directories are 'erecord/erecord' and 'erecord/docs'.
.. literalinclude:: include/cmd_update_erecord.rst
.. note::
Be careful not to lose some **models repositories** by overwriting
'erecord/repositories' under :ref:`deploy_root_path`.
Be careful not to inadvertently overwrite the **databases** in
'erecord/databases' under :ref:`deploy_root_path`.
Then apply on the erecord project software the appropriate modifications and
generations :
See :ref:`deploy_erecord_modify_and_generate`.
3. Models software updating
===========================
Updating an existing model, adding a model...
See :ref:`deploy_repositories`.
.. _cmd_create_erecordenv_virtualenv:
==============================
erecordenv virtualenv creation
==============================
.. literalinclude:: ../devel/deployment/include/cmd_create_erecordenv_virtualenv.rst
.. _cmd_install_and_activate_erecord_ws:
====================================
install and activate erecord_ws site
====================================
.. literalinclude:: ../devel/deployment/include/cmd_install_and_activate_erecord_ws.rst
.. _cmd_install_libyaml:
=============================
Install LibYAML version 0.1.5
=============================
.. literalinclude:: ../devel/deployment/include/cmd_install_libyaml.rst
......@@ -5,5 +5,7 @@
vle-1.1 and pyvle-1.1 installation
==================================
*a supprimer !!!*
.. literalinclude:: ../devel/deployment/include/cmd_install_vle_pyvle.rst
.. _cmd_run_apache:
==================
run apache2 server
==================
.. literalinclude:: ../devel/deployment/include/cmd_run_apache.rst
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment