Commit d6b51ed4 authored by Denis Laxalde's avatar Denis Laxalde
Browse files

[doc] Mention Docker install, reorganize sections

parent ecba4e86f184
......@@ -14,8 +14,24 @@ exemple ``96`` selon la distribution utilisée.
Il faudra ensuite créer un utilisateur dédiée au référentiel, par exemple nommée "saemref" et
permettre l'accès depuis le client.
Installation du référentiel
===========================
Installation via Docker
=======================
Le projet `saemref-docker`_ fournit un environnement `docker-compose`_ permettant de déployer le
référentiel. C'est la façon recommandée et la plus simple de l'installer. Voir la documentation du
projet pour plus de détails :
https://framagit.org/saemproject/saemref-docker/blob/master/README.md
.. _`saemref-docker`: https://framagit.org/saemproject/saemref-docker
.. _`docker-compose`: https://docs.docker.com/compose/
Installation manuelle
=====================
La procédure décrite dans cette section concerne l'installation manuelle du référentiel. Elle se
base sur une combinaison de paquets système (disponibles via une distribution Linux) et un
environnement virtuel Python.
Les paquets systèmes suivants sont nécessaires (``yum install`` sur une distribution Redhat/CentOS) :
......@@ -56,7 +72,7 @@ Installer le référentiel :
Création de l'instance
======================
----------------------
Une fois le cube saem_ref et ses dépendances installées, il reste à créer une
instance de celui-ci :
......@@ -107,7 +123,7 @@ Pour une instance de production, il est recommandé d'utilisé un serveur d'appl
Configuration de supervisor
===========================
---------------------------
supervisor_ permet de gérer les différents services de l'application, à savoir
: le serveur web principal (programme "saemref"), le point d'accès OAI-PMH
......@@ -120,30 +136,8 @@ Un exemple de configuration supervisor, à mettre dans
.. include:: supervisor.conf
:code: ini
Configuration du frontal web
============================
Il faut configurer le frontal web pour diriger les différentes requêtes sur
chacun des services configurés (le serveur web principal et le serveur
OAI-PMH). Ci-dessous un exemple de configuration pour nginx :
::
server {
listen 80;
server_name saemref.example.com;
location / {
proxy_pass http://srv:8080;
}
location /oai {
proxy_pass http://srv:8081;
}
}
Mise à jour de l'instance
=========================
-------------------------
.. warning::
......@@ -179,15 +173,8 @@ Relancer enfin ``supervisor``:
[root@srv] % supervisorctl start all
.. _pip: https://pip.pypa.io/
.. _virtualenv: https://docs.python.org/3/library/venv.html
.. _gunicorn: http://gunicorn.org/
.. _supervisor: http://supervisord.org/
Lancement de l'instance en mode debug
=====================================
-------------------------------------
Pour comprendre certains problèmes, il peut-être utile de lancer l'instance en mode "debug" afin
d'augmenter le niveau de détails des *logs*. Pour cela, il faut mettre : ::
......@@ -199,3 +186,30 @@ dans le fichier ``~saemref/etc/cubicweb.d/saemref/all-in-one.conf`` puis relance
::
[root@srv] % supervisorctl restart all
Configuration du frontal web
============================
Il faut configurer le frontal web pour diriger les différentes requêtes sur
chacun des services configurés (le serveur web principal et le serveur
OAI-PMH). Ci-dessous un exemple de configuration pour nginx :
::
server {
listen 80;
server_name saemref.example.com;
location / {
proxy_pass http://srv:8080;
}
location /oai {
proxy_pass http://srv:8081;
}
}
.. _pip: https://pip.pypa.io/
.. _virtualenv: https://docs.python.org/3/library/venv.html
.. _gunicorn: http://gunicorn.org/
.. _supervisor: http://supervisord.org/
Markdown is supported
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