.. _web:

Use the web interface
=====================

The ClorSensoud software is installed and running. There is no need to do more if you are just interested in gathering data or deploying some automation. But for a more amazing experience, we advise you to install a web server and enjoy the shiny ClorSensoud web interface!


Install pre-requisite dependencies
----------------------------------

We propose to install an Apache web server with a bit more dependencies:

.. code:: bash

   sudo apt install apache2 php libapache2-mod-php php-sqlite3 gettext php-gettext


Compile translations for localization
-------------------------------------

To get a human-readable web interface, it's preferable to compile the translations:

.. code:: bash

    msgfmt -o /home/USER/clorsensoud/web/locale/fr_FR/LC_MESSAGES/messages.mo /home/USER/clorsensoud/web/locale/fr_FR/LC_MESSAGES/messages.po
    msgfmt -o /home/USER/clorsensoud/web/locale/en_US/LC_MESSAGES/messages.mo /home/USER/clorsensoud/web/locale/en_US/LC_MESSAGES/messages.po


Link to the web interface
-------------------------

To easily access to the ClorSensoud web interface, we propose to just create a symbolic link to its ``web`` directory:

.. code:: bash

   sudo ln -s /home/USER/clorsensoud/web /var/www/html/clorsensoud

Where ``USER`` is your actual non-superuser user, as seen before.

Theorically, the web interface can now be reached at the following URL, where ``CLORSENSOUD_SERVER`` is the IP address or the domain name of the server: ``http://CLORSENSOUD_SERVER/clorsensoud``

.. note:: The described procedure is really too minimalist. It's simple, it's easy, and it works. But it would be a best idea to set up a real life configuration with a virtualhost and some security tricks.