SQWareManager:FAQ Environment File

Le fichier d'environnement doit être configuré correctement pour faire fonctionner l'application. Pour ce faire, suivre toute la procédure jusqu'au bout.

Création

Copier le fichier d'environnement par défaut à l'emplacement suivant :

cp ~/dbSQWare/SQWareManager/SQWareManager_Web/.env.example ~/dbSQWare/SQWareManager/SQWareManager_Web_cust/SQWareManager_Web.env

Configuration

Défaut

Modifier à minima les enregistrements du fichier d'environnement suivants :

vi ~/dbSQWare/SQWareManager/SQWareManager_Web_cust/SQWareManager_Web.env

APP_NAME="SQWareManager"
APP_KEY=                                               # A générer (cf plus bas)
APP_TIMEZONE=Europe/Paris
APP_URL=https://sqwaremanager.dbsqware.local/          # A modifier

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=dbsqware_db
DB_USERNAME=dbsqware_user
DB_PASSWORD=pwd                                        # A modifier

MAIL_MAILER=smtp
MAIL_HOST=mail.host.com                                # A modifier
MAIL_PORT=587
MAIL_USERNAME=user                                     # A modifier
MAIL_PASSWORD=pwd                                      # A modifier
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=no-reply@mydomain.com                # A modifier
MAIL_FROM_NAME="${APP_NAME}"
MAIL_REPLY_ADDRESS=contact@mydomain.com                # A modifier

SQW_CONNECTOR_HOST=localhost
SQW_CONNECTOR_PORT=8080
SQW_CONNECTOR_TOKEN=                                   # A générer (cf plus bas)
SQW_SQWAREWEB_HOST=https://sqwareweb.dbsqware.local/   # A modifier

Générer la clé de chiffrement "APP_KEY" de l'application :

/!\/!\/!\ Ne jamais regénérer la clé de chiffrement de l'application une fois l'installation terminée. Il ne sera plus possible de déchiffrer les données chiffrées à l'aide de cette clé de chiffrement.

cd ~/dbSQWare/SQWareManager/SQWareManager_Web
php artisan key:generate
# La clé "APP_KEY=" c'est mise à jour dans le fichier de config SQWareManager_Web.env !

Déclarer SQWareWeb en tant qu'application tierce de SQWareManager

Pour continuer à utiliser le module SQWareWeb comme il se doit, il est nécessaire de le déclarer en tant qu'application tierce du module SQWareManager.

En effet, l'authentification étant portée exclusivement par SQWareManager, SQWareWeb devient de ce fait un client de ce dernier.

Côté SQWareManager

Générer les clés publique et privée :

cd ~/dbSQWare/SQWareManager/SQWareManager_Web/storage
rm -f oauth-private.key oauth-public.key
cd ~/dbSQWare/SQWareManager/SQWareManager_Web
php artisan passport:keys

Déplacer les clés créées dans le dossier storage :

cd ~/dbSQWare/SQWareManager/SQWareManager_Web/storage
mv oauth-private.key ~/dbSQWare/SQWareManager/SQWareManager_Web_cust/keys/.
mv oauth-public.key ~/dbSQWare/SQWareManager/SQWareManager_Web_cust/keys/.
ln -s ../../SQWareManager_Web_cust/keys/oauth-private.key oauth-private.key
ln -s ../../SQWareManager_Web_cust/keys/oauth-public.key oauth-public.key

Copier leur contenu respectif dans le fichier d'environnement SQWareManager_Web.env :

cd ~/dbSQWare/SQWareManager/SQWareManager_Web_cust
cat keys/oauth-private.key
cat keys/oauth-public.key
vi SQWareManager_Web.env 

PASSPORT_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
yourPrivateKey
-----END PRIVATE KEY-----"

PASSPORT_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
yourPublicKey
-----END PUBLIC KEY-----"

Générer le client ID et client secret de SQWareWeb :

cd ~/dbSQWare/SQWareManager/SQWareManager_Web
php artisan passport:client

What should we name the client? > SQWareWeb
Where should we redirect the request after authorization? > https://sqwareweb/lib/oauth/callback.php   # Ne pas modifier /lib/oauth/callback.php
Would you like to enable the device authorization flow for this client? (yes/no) > no

  INFO  New client created successfully.

  Client ID ................................................................................................... yourClientID
  Client Secret ........................................................................................... yourClientSecret

Côté SQWareWeb

Copier le résultat de la commande précédente dans le fichier d'environnement sqwareweb.ini :

vi ~/dbSQWare/SQWareWeb/custom/sqwareweb.ini

[sqwaremanager]
client_id='yourClientID'
client_secret='yourClientSecret'

Options

Certaines options sont disponibles afin de modifier le comportement par défaut de certaines fonctionnalités.

Traçage de l'Explorer

5 niveaux de verbosité existent pour tracer toute l'activité de l'Explorer dans la console et dans la base de données :

• debug
• info
• warn
• error
• fatal

Modifier le fichier d'environnement et ajouter les enregistrements optionnels (ne pas mettre si la valeur par défaut reste inchangée) :

vi ~/dbSQWare/SQWareManager/SQWareManager_Web_cust/SQWareManager_Web.env

SQW_LOG_CONSOLE="debug,info,warn,error,fatal"   # Valeur par défaut
SQW_LOG_DB="error,fatal"                        # Valeur par défaut