# Loxya | Documentation

# Assistant d'installation de Loxya

> <i class="fas fa-info-circle"></i> **Attention**  
> Cette page s'adresse aux administrateurs qui ont **accès en ligne de commande au serveur** où Loxya est installé. Pour installer Loxya, veuillez d'abord suivre les instructions de la [page "installation" de la documentation](/wiki/install) (étape préalable à ce qui suit).

Une fois que le code source de Loxya est présent sur votre serveur, ouvrez **un terminal** connecté à ce serveur, placé à la **racine du dossier** contenant les fichies du logiciel, et **lancez la commande** suivante&nbsp;:

<a href="/wiki/wizard#wizard-home" id="wizard-home" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

```
./bin/console install
```

<img src="/img/screens/wiki/wizard-start.webp" alt="Le point de départ de l'assistant d'installation" />

Cet assistant est disponible **en Français** et **en Anglais**. La langue utilisée par défaut est celle définie par les variables d'environnement `LANG` ou `LC_ALL`, mais il sera toujours possible de la changer, si besoin, dès la 3ème question posée par l'assistant (voir ci-dessous).

> <i class="fas fa-exclamation-triangle"></i> **Important**  
> Veuillez vous assurer que les dossiers `/data`, `/src/var/*` et `/src/App/Config` sont **accessibles en écriture** par l'utilisateur système du serveur web ET par l'utilisateur qui exécute la commande. Sinon, une erreur se produira.

> <i class="fas fa-info-circle"></i> **Bon à savoir**  
> Quand vous effectuez une [**mise à jour**](/wiki/update) de Loxya, les informations sont **pré-remplies** avec les valeurs du fichier `settings.json` existant.

L'assistant d'installation comporte **8 étapes**, que voici en détail.


<a href="/wiki/wizard#wizard-step1" id="wizard-step1" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Paramètres de base du logiciel

<img src="/img/screens/wiki/wizard-step1.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Première étape de l'assistant d'installation CLI de Loxya" />

- **URL de l'application**  
Il s'agit de l'adresse web racine de votre instance de Loxya.
- **Pays d'utilisation principal**  
Cela permettra à Loxya de s'adapter à votre pays.
- **Langue par défaut**  
La langue que Loxya utilisera par défaut, quand l'utilisateur n'a pas encore fait son choix.  
Si vous changez la langue à ce moment-là, l'assistant changera de langue également.
- **Mode d'utilisation**
  - _Location de matériel_  
  Facturation systématique, tous les événements pourront être facturés.
  - _Location + prêt de matériel_  
  Facturation au cas par cas, le choix pourra être fait pour chaque événement individuellement, grâce à un bouton _"facturable"_ permettant d'activer ou désactiver la facturation.
  - _Prêt de matériel_  
  Pas de facturation du tout ; aucune facture ne pourra être créée, le matériel n'a pas de tarif de location, et les tarifs dégressifs ne sont pas utilisés.
- **Devise**  
La monnaie à utiliser pour afficher les montants, prix et tarifs dans le logiciel.


<a href="/wiki/wizard#wizard-step2" id="wizard-step2" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Votre organisation

<img src="/img/screens/wiki/wizard-step2.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Seconde étape de l'assistant d'installation CLI de Loxya" />

Toutes ces informations sont indispensables pour que Loxya puisse générer des documents (bons de sortie, devis, factures...) au nom de votre entreprise, association ou institution.

> <i class="fas fa-info-circle"></i> **Note**  
> Les informations demandées à cette étape peuvent varier en fonction du mode d'utilisation que vous avez choisi à l'étape précédente, et du pays choisi ci-dessous.

- **Raison sociale de l'organisation**  
Le nom de votre structure (entreprise, association, institution...)
- **Pays de l'organisation**  
Le pays dans lequel se trouve votre activité principale.
- **Numéro de SIRET / d'identification**  
Le numéro qui permet d'identifier votre entreprise dans le pays sélectionné ci-dessus.
- **Forme juridique**  
Le type de votre organisation. Les choix proposés dépendent du pays choisi ci-dessus.
- **Capital social**  
Si le type de votre structure implique d'avoir un capital social, vous pouvez indiquer son montant ici.
- **Ville du registre du commerce de l'organisation**  
Pour faire apparaître la ville du R.C.S. qui a enregistré votre structure.
- **Code APE**  
le code APE (NAF) de votre organisation, si vous souhaitez le faire apparaître dans les documents.
- **Êtes-vous assujetti à la TVA&nbsp;?**  
Si oui, le numéro est demandé ci-dessous.
- **Numéro de TVA**  
Le numéro de T.V.A. intracommunautaire de votre organisation (demandé ou non, selon les choix précédents).
- **Option pour le paiement de la TVA d'après les débits&nbsp;?**  
Si vous avez opté pour le paiement de la T.V.A. d'après les débits plutôt qu'à l'encaissement, vous pouvez mettre "oui".
- **Numéro et rue**  
Adresse de votre structure.
- **Complément d'adresse**
- **Code postal**
- **Ville**
- **Numéro de téléphone de l'organisation**
- **Adresse e-mail de l'organisation**


<a href="/wiki/wizard#wizard-step3" id="wizard-step3" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Configuration de la base de données

Ici, il s'agit de renseigner les **informations de connexion au serveur MySQL** et à la base de données.

<img src="/img/screens/wiki/wizard-step3.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Troisième étape de l'assistant d'installation CLI de Loxya" />

- **Hôte de la base de données**  
Le nom du serveur hôte MySQL. Si vous installez Loxya sur un serveur local, ça sera sûrement _"localhost"_.
- **Nom d'utilisateur**  
Le nom de l'utilisateur MySQL qui a accès à la base de données. Nous vous déconseillons d'utiliser l'utilisateur _"root"_ pour des raisons de sécurité, sauf sur un serveur local où ça reste acceptable.
- **Mot de passe**  
Le mot de passe de l'utilisateur MySQL qui a été renseigné ci-dessus.
- **Nom de la base de données**  
Le nom de la base de données dédiée à Loxya, où seront stockées toutes ses données.
- **Préfixe des tables**  
Un éventuel préfixe à ajouter aux noms des tables de la BDD _(optionnel, à laisser vide en général)._  
N'oubliez pas d'ajouter un caractère séparateur (par exemple `_` ou `-`) à la fin du préfixe si vous en utilisez un.

> <i class="fas fa-info-circle"></i> **Note**  
> Si vous n'avez pas entré les bonnes informations de connexion (ou que la base de données n'existe pas), un message d'erreur apparaître et vous ne pourrez pas aller plus loin. L'assistant revient alors à la première question de cette étape, et il vous suffit alors de corriger les informations fournies.


<a href="/wiki/wizard#wizard-step4" id="wizard-step4" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Paramètres des devis

<img src="/img/screens/wiki/wizard-step4.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Quatrième étape de l'assistant d'installation CLI de Loxya" />

- **Durée de validité par défaut des devis**  
Il s'agit du nombre de jours à utiliser par défaut pour calculer la date d'expiration des devis générés par Loxya. Cette valeur peut bien sûr être **modifiée pour chaque devis séparément**, au moment de leur création.


<a href="/wiki/wizard#wizard-step5" id="wizard-step5" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Paramètres de facturation

Si la facture est prise en charge par Loxya pour le pays de votre organisation (choisi à l'étape ["Votre organisation"](#wizard-step2) ci-dessus), alors vous pouvez renseigner les informations suivantes&nbsp;:

<img src="/img/screens/wiki/wizard-step5.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Cinquième étape de l'assistant d'installation CLI de Loxya" />

- **Adresse électronique d'envoi des e-factures**  
Il s'agit de l'adresse de routage de la facturation électronique. Cette information dépend bien sûr du pays de votre organisation, et ne doit être modifiée que si vous savez ce que vous faites. Pour plus d'informations, n'hésitez pas à [nous contacter](/contact).
- **Délai de paiement par défaut**  
Le délai en jours à utiliser pour calculer la date d'échéance par défaut des factures (avant qu'une facture soit considérée comme étant _"en retard"_). Bien sûr, cette valeur peut être choisie au cas par cas, pour chaque facture au moment de sa création.
- **Moyens de paiement acceptés**  
Choisissez les moyens de paiements que vous acceptez, parmi _"Espèces"_, _"Carte bancaire"_, _"Chèque"_, ou _"Virement bancaire"_. Pour choisir, utilisez la barre d'espace de votre clavier.
- **IBAN du compte bancaire**  
Renseignez le numéro de compte bancaire à afficher sur les devis et factures pour que vos clients puissent vous payer par virement.
- **BIC / SWIFT**  
Le numéro BIC ou SWIFT du compte bancaire à afficher sur les documents.
- **Nom du titulaire du compte**  
Le nom qui apparaît sur le Relevé d'Identité Bancaire (RIB) du compte bancaire de votre organisation.


<a href="/wiki/wizard#wizard-step6" id="wizard-step6" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Paramètres de l'application

Ici, vous paramétrez le comportement général de Loxya. Vous pouvez activer ou désactiver certaines fonctionnalités pour l'adapter précisément à votre utilisation.

<img src="/img/screens/wiki/wizard-step6.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Cinquième étape de l'assistant d'installation CLI de Loxya" />

- **Choix de la politique de retour du matériel**  
Ici, vous pouvez définir le comportement du calcul des disponibilités en temps réel de Loxya.  
Vous pouvez consulter [cet article de blog](/blog/gestion-des-retours-de-materiel-mode-manuel-pour-un-controle-renforce) pour en savoir plus.
  - **Clôture automatique**&nbsp;: L'événement ou la réservation se termine à la date prévue, même sans inventaire de retour. Quand la date de fin de mobilisation d'un événement ou d'une réservation est passée, Loxya considère que le matériel est retourné en stock, même si vous ne faites pas d'inventaire de retour.
  - **Clôture manuelle**&nbsp;: L'événement ou la réservation reste actif jusqu'à ce qu'inventaire soit créé manuellement. Quand la date de fin de mobilisation d'un événement ou d'une réservation est passée, Loxya considère que le matériel est toujours indisponible, jusqu'à ce qu'un inventaire de retour soit validé. Cela permet également d'afficher les retards.
- **Paramètres avancés**  
Si vous savez ce que vous faites, vous pouvez choisir _"oui"_ à cette question, et voir le détail ci-dessous.

### Paramètres avancés  

<img src="/img/screens/wiki/wizard-step6-advanced.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Sixième étape de l'assistant d'installation CLI de Loxya" />

- **Jeton de sécurité**  
Si vous souhaitez changer le token de sécurité, ou en spécifier un personnalisé, vous pouvez le faire ici. À noter que cela aura pour conséquence de déconnecter tous les utilisateurs qui sont actuellement connectés au logiciel.
- **Activer CORS (Cross Origin Resource Sharing)**  
Par défaut, il est recommandé de laisse ce paramètre sur _"Non"_, à moins de savoir ce que vous faites. En général, cela est utile uniquement en environnement de développement.
- **Durée des sessions**  
Durée maximale de la session (en heures) avant que les utilisateurs ne doive se reconnecter.
- **Nombre d'éléments par page**  
 Le nombre maximum d'éléments qui peuvent être affichés dans les pages de listings.
- **Mode de génération des codes-barres**  
  - _Automatique_&nbsp;: Loxya génère le contenu des codes-barres de chaque matériel.
  - _Manuel_&nbsp;: vous pourrez spécifier le contenu des codes-barres, mais l'utilisation d'un scanner de code-barres qui est capable d'insérer un préfixe et un suffixe sera requise.
- **Format des codes-barres générés par Loxya**  
Choisissez le type de code-barres que Loxya devra prendre en charge&nbsp;: _QR-code_, _PDF 417_, _Code 39_ ou _Code 128_.

> <i class="fas fa-info-circle"></i> **Note**  
> À partir de ce moment-là, toutes les informations renseignées seront stockées dans le fichier `src/App/Config/settings.json` (voir [annexes](/wiki/appendices#appendices-settings-table)). Vous pouvez éventuellement modifier ce fichier "à la main", mais il est fortement conseillé de plutôt utiliser la la commande `./bin/console install` pour cela.

<a href="/wiki/wizard#wizard-step7" id="wizard-step7" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Mise à jour de la base de données

<img src="/img/screens/wiki/wizard-step7.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Septième étape de l'assistant d'installation CLI de Loxya" />

Ici, vous n'avez rien de spécial à faire. Quand vous appuyez sur la touche Entrée du clavier, l'assistant lance les migrations de la base de données, pour installer toute la structure de la base de données (ou pour la modifier selon la dernière version, s'il s'agit d'une mise à jour).


<a href="/wiki/wizard#wizard-step8" id="wizard-step8" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Premier utilisateur

<img src="/img/screens/wiki/wizard-step8.webp" style="float: right; margin-left: 15px; max-width: 50%;" alt="Huitième étape de l'assistant d'installation CLI de Loxya" />

Dans cette étape, il vous faut définir les informations du **tout premier utilisateur de Loxya**, qui aura les droits _"administration"_, c'est à dire tous les droits.

- **Prénom**  
Indiquez le prénom du premier utilisateur administrateur.
- **Nom**  
Indiquez le nom de famille du premier utilisateur administrateur.
- **Identifiant**  
Le pseudo qui permettra au premier utilisateur administrateur de se connecter à Loxya.
- **Mot de passe**  
Le mot de passe qui va avec. Ne le perdez pas, car les administrateurs ne peuvent pas réinitialiser leur mot de passe.
- **Adresse e-mail**  
L'adresse e-mail de l'utilisateur admin, qui pourra aussi être utilisée pour se connecter.

<a href="/wiki/wizard#wizard-done" id="wizard-done" class="wiki__page__link">
    <i class="fas fa-link"></i>
</a>

## Terminé&nbsp;!

Et voilà, l'installation de Loxya est terminée. En cliquant sur le bouton _"Démarrer"_, vous pourrez entrer vos identifiants (ceux que vous avez donné à l'étape 6) pour vous connecter et commencer à utiliser l'application&nbsp;!!

<img src="/img/screens/wiki/wizard-done.webp" alt="Dernière étape de l'assistant d'installation CLI de Loxya" />


