sophon/thesis/source/docs/installazione/4_configuring_compose.rst

:github_url: https://github.com/Steffo99/sophon/blob/main/thesis/source/6_installazione/4_configuring_compose.rst

Configurazione ``docker-compose.yml``
=====================================

Si configuri con l'editor di testo preferito il file ``docker-compose.yml`` con le impostazioni desiderate.

.. code-block:: console

   root:/dock/sophon# open docker-compose.yml

In particolare, tutte le impostazioni precedute da ``# INSTALL`` vanno obbligatoriamente modificate.


.. envvar:: DJANGO_SECRET_KEY

   Specifica la chiave segreta da usare per i cookie di sessione.

   .. code-block:: yaml

      - DJANGO_SECRET_KEY=do-not-use-this-key-in-production-or-you-will-get-hacked

   .. warning::

      Cambiare la chiave segreta una volta installato Sophon invaliderà tutti gli accessi effettuati dagli utenti.

   .. danger::

      La chiave segreta è un dato estremamente riservato: chiunque sia a conoscenza della chiave segreta potrà effettuare l'accesso come qualsiasi utente!

   .. seealso::

      `SECRET_KEY <https://docs.djangoproject.com/en/3.2/ref/settings/#std:setting-SECRET_KEY>`_ nella documentazione di Django.


.. envvar:: DJANGO_PROXY_BASE_DOMAIN

   Specifica il dominio che dovrà essere usato come radice per il proxy, ovvero il dominio per il quale si è configurato il DNS in precedenza.

   Se non è specificato, Sophon verrà eseguito in `modalità sviluppo <Modalità sviluppo>`.

   .. code-block:: yaml

      - DJANGO_PROXY_BASE_DOMAIN=ilmiosophon.it


.. envvar:: DJANGO_PROXY_PROTOCOL

   Specifica il protocollo che dovrà essere usato nei mapping del proxy.

   Si consiglia di utilizzare ``https``, ma è un valore valido anche ``http``.

   .. code-block:: yaml

      - DJANGO_PROXY_PROTOCOL=https


.. envvar:: DJANGO_ALLOWED_HOSTS

   Specifica i domini da cui possono provenire le richieste alla pagina di amministrazione.

   Per specificare più domini, è necessario separarli con dei pipe ``|`` .

   Eccetto in configurazioni speciali, deve essere uguale al dominio prefisso da ``api.``.

   .. code-block:: yaml

      - DJANGO_ALLOWED_HOSTS=api.ilmiosophon.it

   .. seealso::

      `ALLOWED_HOSTS <https://docs.djangoproject.com/en/3.2/ref/settings/#allowed-hosts>`_ nella documentazione di Django.


.. envvar:: DJANGO_ALLOWED_ORIGINS

   Specifica i domini da cui possono provenire le richieste all'API.

   Per specificare più domini, è necessario separarli con dei pipe ``|`` .

   Eccetto in configurazioni speciali, deve contenere il proprio dominio prefisso dal protocollo, e in aggiunta il dominio speciale ``https://sophon.steffo.eu``, necessario per permettere l'accesso dall'interfaccia web "universale" di Sophon.

   .. code-block:: yaml

      - DJANGO_ALLOWED_ORIGINS=https://ilmiosophon.it|https://sophon.steffo.eu

   .. seealso::

      L'header `Access-Control-Allow-Origin <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin>`_ su MDN.


.. envvar:: DJANGO_STATIC_URL

   Specifica l'URL a cui saranno accessibili i file statici di Sophon.

   Eccetto in configurazioni speciali, deve essere uguale alla seguente stringa, con le parole in maiuscolo sostituite rispettivamente dal protocollo e dal dominio selezionato: ``PROTOCOLLO://static.DOMINIO/django-static/``.

   .. code-block:: yaml

      - DJANGO_ALLOWED_ORIGINS=http://static.ilmiosophon.it/django-static/

   .. warning::

      Ci si assicuri che sia presente uno slash al termine della stringa, oppure il pannello di amministrazione non sarà visualizzato correttamente!

   .. seealso::

      `STATIC_URL <https://docs.djangoproject.com/en/3.2/ref/settings/#std:setting-STATIC_URL>`_ nella documentazione di Django


.. envvar:: DJANGO_LANGUAGE_CODE

   Specifica la lingua che deve usare Sophon nei messaggi di errore.

   Usa il formato `language code`_ di Django.

   .. code-block:: yaml

      - DJANGO_LANGUAGE_CODE=en-us

   .. seealso::

      `LANGUAGE_CODE <https://docs.djangoproject.com/en/3.2/ref/settings/#language-code>`_ nella documentazione di Django

   .. _language code: https://docs.djangoproject.com/en/3.2/topics/i18n/#term-language-code


.. envvar:: DJANGO_TIME_ZONE

   Specifica il fuso orario che deve usare Sophon nell'interfaccia di amministrazione.

   Usa il formato `tzdata`_.

   .. code-block:: yaml

      - DJANGO_TIME_ZONE=Europe/Paris

   .. hint::

      Il fuso orario italiano è ``Europe/Rome``.

   .. _tzdata: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones


.. envvar:: DJANGO_SU_USERNAME

   Specifica il nome del :ref:`superutente <Livelli di accesso>` che verrà automaticamente creato qualora il database non contenga altri utenti.

   .. code-block:: yaml

      - DJANGO_SU_USERNAME=root


.. envvar:: DJANGO_SU_EMAIL

   Specifica l'email del :ref:`superutente <Livelli di accesso>` che verrà automaticamente creato qualora il database non contenga altri utenti.

   .. code-block:: yaml

      - DJANGO_SU_USERNAME=django@example.org

   .. note::

      Attualmente, l'email non è utilizzata, ma è richiesta da Django per la creazione di un nuovo utente.


.. envvar:: DJANGO_SU_PASSWORD

   Specifica la password del :ref:`superutente <Livelli di accesso>` che verrà automaticamente creato qualora il database non contenga altri utenti.

   .. code-block:: yaml

      - DJANGO_SU_PASSWORD=square

   .. warning::

      La password è un dato estremamente riservato, in quanto chiunque ne venga a conoscenza potrà accedere a Sophon con pieni privilegi!


.. envvar:: REACT_APP_DEFAULT_INSTANCE

   Specifica il valore con cui precompilare il campo "selezione istanza" dell'interfaccia web di Sophon.

   Eccetto in configurazioni speciali, deve essere uguale al dominio prefisso dal protocollo e da ``api.``.

   .. code-block:: yaml

      - REACT_APP_DEFAULT_INSTANCE=https://api.ilmiosophon.it


.. envvar:: APACHE_PROXY_BASE_DOMAIN

   Specifica il dominio che dovrà essere usato come radice per il proxy, ovvero il ``DOMINIO`` per il quale si è configurato il DNS in precedenza.

   Deve essere uguale a :envvar:`DJANGO_PROXY_BASE_DOMAIN`.

   .. code-block:: yaml

      - APACHE_PROXY_BASE_DOMAIN=ilmiosophon.it