Skip to content

Commit

Permalink
feat(doc): add copy button on code block + minor changes on the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jacquesfize committed Jan 7, 2025
1 parent 9762fb2 commit 3931c30
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 42 deletions.
40 changes: 20 additions & 20 deletions docs/installation-all.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Configuration
* Renseignez à minima :

* ``my_url`` : l'URL (ou IP) de votre serveur (avec un ``/`` à la fin)
* ``user_pg`` : l'utilisateur PostgreSQL que vous souhaitez voir créé
* ``user_pg_pass`` : mot de passe de l'utilisateur PostgreSQL

Le script se chargera d'installer PostgreSQL, de crééer la base de donnée et de créer l'utilisateur que vous avez renseigné.
* ``my_url`` : l'URL (ou IP) de votre serveur (avec un ``/`` à la fin)
* ``user_pg`` : l'utilisateur PostgreSQL que vous souhaitez voir créé
* ``user_pg_pass`` : mot de passe de l'utilisateur PostgreSQL
Le script se chargera d'installer PostgreSQL, de crééer la base de donnée et de créer l'utilisateur que vous avez renseigné.

* Variable ``mode``

Expand All @@ -57,17 +57,17 @@ Installation

* Lancer l'installation :

.. code:: console
.. code:: shell
$ touch install_all.log
$ chmod +x install_all.sh
$ ./install_all.sh 2>&1 | tee install_all.log
touch install_all.log
chmod +x install_all.sh
./install_all.sh 2>&1 | tee install_all.log
Une fois l'installation terminée, lancez la commande suivante:

.. code:: console
.. code:: shell
$ exec bash
exec bash
Les applications sont disponibles aux adresses suivantes :
Expand All @@ -77,36 +77,36 @@ Les applications sont disponibles aux adresses suivantes :

Vous pouvez vous connecter avec l'utilisateur intégré par défaut (admin/admin).

:Note:
.. note::

Pour en savoir plus TaxHub, sa configuration et son utilisation, reportez-vous à sa documentation : https://taxhub.readthedocs.io. Idem pour UsersHub et sa documentation : https://usershub.readthedocs.io

:Note:
.. note::

* GeoNature-atlas compatible avec GeoNature V2 est disponible sur https://github.com/PnX-SI/GeoNature-atlas
* Vous pouvez utiliser le schéma ``ref_geo`` de GeoNature pour votre territoire, les communes et les mailles.

Si vous rencontrez une erreur, se reporter aux fichiers de logs ``/home/`whoami`/install_all.log``.

:Note:
.. note::

Si vous souhaitez que GeoNature soit à la racine du serveur, ou à une autre adresse, editez le fichier de configuration Apache (``/etc/apache2/sites-available/geonature.conf``) en modifiant l'alias :

- Pour ``/``: ``Alias / /home/test/geonature/frontend/dist``
- Pour ``/saisie`` : ``Alias /saisie /home/test/geonature/frontend/dist``

:Note:
.. note::

Par défaut et par mesure de sécurité, la base de données est accessible uniquement localement par la machine où elle est installée. Pour accéder à la BDD depuis une autre machine (pour s'y connecter avec QGIS, pgAdmin ou autre), vous pouvez consulter cette documentation https://github.com/PnX-SI/Ressources-techniques/blob/master/PostgreSQL/acces-bdd.rst.
Attention, exposer la base de données sur internet n'est pas recommandé. Il est préférable de se connecter via un tunnel SSH. QGIS et la plupart des outils d'administration de base de données permettent d'établir une connexion à la base de cette manière.
Attention si vous redémarrez PostgreSQL (``sudo service postgresql restart``), il faut ensuite redémarrer les API de GeoNature et UsersHub :

.. code:: console
.. code:: shell
$ sudo systemctl restart geonature
$ sudo systemctl restart geonature-worker
$ sudo systemctl restart usershub
sudo systemctl restart geonature
sudo systemctl restart geonature-worker
sudo systemctl restart usershub
:Note:
.. note::

Il est aussi important de configurer l'accès au serveur en HTTPS plutôt qu'en HTTP pour chiffrer le contenu des échanges entre le navigateur et le serveur (https://docs.ovh.com/fr/hosting/les-certificats-ssl-sur-les-hebergements-web/).
26 changes: 13 additions & 13 deletions docs/installation-standalone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Installation des dépendances

Installer les paquets suivants :

::
.. code:: shell
$ sudo apt install unzip git postgresql-postgis postgis python3-pip python3-venv python3-dev libpq-dev libgdal-dev libffi-dev libpangocairo-1.0-0 apache2 redis
sudo apt install unzip git postgresql-postgis postgis python3-pip python3-venv python3-dev libpq-dev libgdal-dev libffi-dev libpangocairo-1.0-0 apache2 redis
Récupération de l'application
Expand All @@ -21,30 +21,30 @@ Récupération de l'application

* Récupérer l'application (``X.Y.Z`` à remplacer par le numéro de la `dernière version stable de GeoNature <https://github.com/PnEcrins/GeoNature/releases>`_).

::
.. code:: shell
$ wget https://github.com/PnX-SI/GeoNature/archive/X.Y.Z.zip
wget https://github.com/PnX-SI/GeoNature/archive/X.Y.Z.zip
* Dézipper l'archive de l'application

::
.. code:: shell
$ unzip X.Y.Z.zip
$ rm X.Y.Z.zip
unzip X.Y.Z.zip
rm X.Y.Z.zip
* Renommer le répertoire de l'application puis placez-vous dedans :

::
.. code:: shell
$ mv GeoNature-X.Y.Z /home/`whoami`/geonature/
$ cd geonature
mv GeoNature-X.Y.Z /home/`whoami`/geonature/
cd geonature
* Copier puis mettre à jour le fichier de configuration (``config/settings.ini``) comportant les informations relatives à votre environnement serveur :

::
.. code:: shell
$ cp config/settings.ini.sample config/settings.ini
$ nano config/settings.ini
cp config/settings.ini.sample config/settings.ini
nano config/settings.ini
Installation de l'application
Expand Down
16 changes: 8 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,27 +95,27 @@ Commencer la procédure en se connectant au serveur en SSH avec l'utilisateur li
* Lui donner ensuite les droits administrateur en l’ajoutant au groupe ``sudo`` :

.. code:: console
.. code:: shell
# adduser geonatureadmin sudo
adduser geonatureadmin sudo
.. note::
Vérifier les droits du répertoire HOME de l'utilisateur

Il doit être en ``7XX`` soit ``drwxr-xr-x``. Si ce n'est pas le cas, exécuter la commande suivante :

.. code:: console
Il doit être en ``7XX`` soit ``drwxr-xr-x``. Si ce n'est pas le cas, exécuter la commande suivante :

# chmod 755 /home/geonatureadmin
.. code:: console
# chmod 755 /home/geonatureadmin
* Pour la suite du processus d’installation, on utilisera l'utilisateur non privilégié nouvellement créé. Si besoin d'éxecuter des commandes avec les droits d'administrateur, on les précèdera de ``sudo``.

Il est d'ailleurs possible renforcer la sécurité du serveur en bloquant la connexion SSH au serveur avec ``root``. Voir https://docs.ovh.com/fr/vps/conseils-securisation-vps/ pour plus d'informations sur le sécurisation du serveur.

Pour passer de l’utilisateur ``root`` à ``geonatureadmin``, vous pouvez aussi utiliser la commande :

.. code:: console
.. code:: shell
# su - geonatureadmin
su - geonatureadmin
.. _installation-all:
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sphinx
sphinx-book-theme
myst-parser
sphinx-autoapi
sphinx-autoapi
sphinx-copybutton
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,13 @@ sphinx==7.4.7
# pydata-sphinx-theme
# sphinx-autoapi
# sphinx-book-theme
# sphinx-copybutton
sphinx-autoapi==3.3.3
# via -r requirements.in
sphinx-book-theme==1.1.3
# via -r requirements.in
sphinx-copybutton==0.5.2
# via -r requirements.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"sphinx-book-theme",
"myst-parser",
"sphinx-autoapi",
"sphinx-copybutton",
],
},
classifiers=[
Expand Down

0 comments on commit 3931c30

Please sign in to comment.