Skip to content

Changes

Page history
Update Using the server authored by Charles-Alexandre Delestage's avatar Charles-Alexandre Delestage
Hide whitespace changes
Inline Side-by-side
Using-the-server.md
View page @ 32d4b120
[Français](#français)
# English
Here are a few tips on using the server in production mode.
Be aware the project is still in development and some functions are not yet implemented.
## Launching the server
Once the project have been cloned and the virtual environment set, you can launch the server with the following command :
```
python3 app.py
```
If you need to check the logs, they are located in the `logs` folder, the file names correspond to the date and time to when the server was launched.
As standard, the server is accessible to any machine connected on the same local network (wired or wireless). You need the server IP address to access it on other devices. Check in your network settings or use the following commands to get it :
```
# On Linux / MacOS
ifconfig
# On Windows
ipconfig
```
Please note that the server only uses the http protocol on the port 5000. To access it on the host machine, your can use the link [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## The control room
Upon launching the server, you will be able to access the control room on any machine. On the host machine, it can be reached at [http://127.0.0.1:5000/control_room](http://127.0.0.1:5000/control_room)
An id and password will be asked when accessing the page (as basic security). The id is not used, fill whatever you want. The password is displayed in the console when launching the server, and is random each time the server is launched. Locate a line resembling this:
```
Security password for control room: 8qhx8K5-C-KU3rqwyeMXDlz0EC9KqsJhkSmU75q0j3w
```
## Client side
Simply connect to the server using the IP of the server as such: `http://<server_ip_address>:5000/`.
When the user accepts to access to the experience, a cookie is generated in the browser to track the data generated client-side. The cookie is erased when the scenario is finished on the terminal used.
## Getting your data
The control room allows you to follow the spotting on the valence-arousal space of SYM and perform data save when needed. To do so, click on `Data Management > Generate excel`. This will generate an Excel file of the users answers to Questionaires and SYM spotting located in the `export` folder and SYM diagrams in the `exports/sym` folder.
[English](#english)
# Français
Vous trouverez ici quelques indications sur l'utilisation du serveur en production.
Le projet étant toujours en développement, certaines fonctionnalités ne sont pas encore implémentées.
## Lancement du serveur
Une fois le project cloné et l'environnement virtuel configuré, vous pouvez lancer le serveur avec la commande suivante :
```
python3 app.py
```
Si vous avez besoin de vérifier les logs, ils sont situés dans le dossier `logs` ; les noms de fichiers correspondent à l'horodatage du moment où le serveur a été lancé.
Par défaut, le serveur est accessible à toute machine connectée au même réseau local filaire ou sans fil. Vous avez besoin de connaitre l'adresse IP du serveur pour pouvoir y accéder depuis un autre appareil. Consultez vos paramètres réseau pour la déterminer ou utilisez les commandes suivantes :
```
# Sur Linux / MacOS
ifconfig
# Sur Windows
ipconfig
```
Notez bien que le serveur n'utilise que le protocole http sur le port 5000. Pour y accéder depuis la machine hôte, vous pouvez utiliser le lien suivant : [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## Page de contrôle (control room)
Au lancement du serveur, vous pouvez accéder à la page de contrôle du serveur sur toutes les machines du réseau. Sur la machine hôte, vous pouvez y accéder ici : [http://127.0.0.1:5000/control_room](http://127.0.0.1:5000/control_room)
Un identifiant et mot de passe sont demandés pour y accéder (comme sécurité de base). L'identifiant n'est pas utilisé. Le mot de passe est affiché dans la console au lancement du serveur, et change à chaque nouveau lancement. Localisez le message suivant dans la console :
```
Security password for control room: 8qhx8K5-C-KU3rqwyeMXDlz0EC9KqsJhkSmU75q0j3w
```
## Côté client
Connectez vous simplement au serveur en utilisant son adresse IP comme suivant : `http://<server_ip_address>:5000/`.
Quand l'utilisateur accepte de participer à l'expérience, un cookie est généré sur son navigateur pour suivre sa progression. Ce cookie est détruit quand il atteint la dernière page.
## Récupérer vos données
La page de contrôle vous permet de suivre les pointages réalisés par les utilisateurs sur SYM, ainsi que de sauvegarder vos données quand vous en avez besoin. Pour cela, cliquez sur `Data Management > Generate excel`. Cela va générer un fichier Excel contenant les réponses des utilisateurs aux questionnaires ainsi que les pointages réalisés sur SYM dans un fichier situé dans le dossier `export` ainsi que généré des diagrammes de SYM pour chaque utilisateur dans le dossier `exports/sym`.
\ No newline at end of file
# English
[Français](#français) | [Español](#español)
Here are a few tips on using the server in production mode.
Be aware the project is still in development and some functions are not yet implemented.
## Launching the server
Once the project have been cloned and the virtual environment set, you can launch the server with the following command :
```
python3 app.py
```
If you need to check the logs, they are located in the `logs` folder, the file names correspond to the date and time to when the server was launched.
As standard, the server is accessible to any machine connected on the same local network (wired or wireless). You need the server IP address to access it on other devices. Check in your network settings or use the following commands to get it :
```
# On Linux / MacOS
ifconfig
# On Windows
ipconfig
```
Please note that the server only uses the http protocol on the port 5000. To access it on the host machine, your can use the link [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## The control room
Upon launching the server, you will be able to access the control room on any machine. On the host machine, it can be reached at [http://127.0.0.1:5000/control_room](http://127.0.0.1:5000/control_room)
An id and password will be asked when accessing the page (as basic security). The id is not used, fill whatever you want. The password is displayed in the console when launching the server, and is random each time the server is launched. Locate a line resembling this:
```
Security password for control room: 8qhx8K5-C-KU3rqwyeMXDlz0EC9KqsJhkSmU75q0j3w
```
## Client side
Simply connect to the server using the IP of the server as such: `http://<server_ip_address>:5000/`.
When the user accepts to access to the experience, a cookie is generated in the browser to track the data generated client-side. The cookie is erased when the scenario is finished on the terminal used.
## Getting your data
The control room allows you to follow the spotting on the valence-arousal space of SYM and perform data save when needed. To do so, click on `Data Management > Generate excel`. This will generate an Excel file of the users answers to Questionaires and SYM spotting located in the `export` folder and SYM diagrams in the `exports/sym` folder.
# Français
[Español](#español) | [English](#english)
Vous trouverez ici quelques indications sur l'utilisation du serveur en production.
Le projet étant toujours en développement, certaines fonctionnalités ne sont pas encore implémentées.
## Lancement du serveur
Une fois le project cloné et l'environnement virtuel configuré, vous pouvez lancer le serveur avec la commande suivante :
```
python3 app.py
```
Si vous avez besoin de vérifier les logs, ils sont situés dans le dossier `logs` ; les noms de fichiers correspondent à l'horodatage du moment où le serveur a été lancé.
Par défaut, le serveur est accessible à toute machine connectée au même réseau local filaire ou sans fil. Vous avez besoin de connaitre l'adresse IP du serveur pour pouvoir y accéder depuis un autre appareil. Consultez vos paramètres réseau pour la déterminer ou utilisez les commandes suivantes :
```
# Sur Linux / MacOS
ifconfig
# Sur Windows
ipconfig
```
Notez bien que le serveur n'utilise que le protocole http sur le port 5000. Pour y accéder depuis la machine hôte, vous pouvez utiliser le lien suivant : [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## Page de contrôle (control room)
Au lancement du serveur, vous pouvez accéder à la page de contrôle du serveur sur toutes les machines du réseau. Sur la machine hôte, vous pouvez y accéder ici : [http://127.0.0.1:5000/control_room](http://127.0.0.1:5000/control_room)
Un identifiant et mot de passe sont demandés pour y accéder (comme sécurité de base). L'identifiant n'est pas utilisé. Le mot de passe est affiché dans la console au lancement du serveur, et change à chaque nouveau lancement. Localisez le message suivant dans la console :
```
Security password for control room: 8qhx8K5-C-KU3rqwyeMXDlz0EC9KqsJhkSmU75q0j3w
```
## Côté client
Connectez vous simplement au serveur en utilisant son adresse IP comme suivant : `http://<server_ip_address>:5000/`.
Quand l'utilisateur accepte de participer à l'expérience, un cookie est généré sur son navigateur pour suivre sa progression. Ce cookie est détruit quand il atteint la dernière page.
## Récupérer vos données
La page de contrôle vous permet de suivre les pointages réalisés par les utilisateurs sur SYM, ainsi que de sauvegarder vos données quand vous en avez besoin. Pour cela, cliquez sur `Data Management > Generate excel`. Cela va générer un fichier Excel contenant les réponses des utilisateurs aux questionnaires ainsi que les pointages réalisés sur SYM dans un fichier situé dans le dossier `export` ainsi que généré des diagrammes de SYM pour chaque utilisateur dans le dossier `exports/sym`.
# Español
[Français](#français) | [English](#english)
Aquí encontrará información sobre cómo utilizar el servidor en producción.
Como el proyecto aún está en desarrollo, algunas características aún no se han implementado.
## Arrancar el servidor
Una vez clonado el proyecto y configurado el entorno virtual, puede iniciar el servidor con el siguiente comando:
```
python3 app.py
```
Si necesitas comprobar los logs, se encuentran en la carpeta `logs`; los nombres de los archivos corresponden a la marca de tiempo en la que se inició el servidor.
Por defecto, el servidor es accesible a cualquier máquina conectada a la misma red local por cable o inalámbrica. Es necesario conocer la dirección IP del servidor para poder acceder a él desde otro dispositivo. Compruebe la configuración de su red para averiguarlo, o utilice los siguientes comandos:
```
# En Linux / MacOS
ifconfig
# En Windows
ipconfig
```
Tenga en cuenta que el servidor sólo utiliza el protocolo http en el puerto 5000. Para acceder a él desde la máquina anfitriona, puede utilizar el siguiente enlace: [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## Sala de control
Cuando se lanza el servidor, puedes acceder a la página de control del servidor desde cualquier máquina de la red. En la máquina anfitriona, puedes acceder desde aquí: [http://127.0.0.1:5000/control_room](http://127.0.0.1:5000/control_room)
Se requiere un nombre de usuario y una contraseña para acceder a ella (como seguridad básica). El nombre de usuario no se utiliza. La contraseña se muestra en la consola cuando se lanza el servidor, y cambia cada vez que se vuelve a lanzar el servidor. Localice el siguiente mensaje en la consola:
```
Security password for control room: 8qhx8K5-C-KU3rqwyeMXDlz0EC9KqsJhkSmU75q0j3w
```
## Lado cliente
Simplemente conéctese al servidor utilizando su dirección IP de la siguiente manera: `http://<dirección_ip_del_servidor>:5000/`.
Cuando el usuario acepta participar en el experimento, se genera una cookie en su navegador para seguir su progreso. Esta cookie se borra cuando el usuario llega a la última página.
## Recuperar los datos
La página de control le permite realizar un seguimiento de las puntuaciones obtenidas por los usuarios en SYM, así como guardar sus datos cuando los necesite. Para ello, haga clic en `Gestión de datos > Generar excel`. Esto generará un archivo Excel con las respuestas de los usuarios a los cuestionarios y las puntuaciones SYM en un archivo en la carpeta `export`, así como la generación de diagramas SYM para cada usuario en la carpeta `exports/sym`.
\ No newline at end of file