Paquet Python

Canaille fournit un paquet Python que vous pouvez installer avec des gestionnaires de paquets comme uv ou pip. C’est la méthode d’installation recommandée si vous souhaitez de bonnes performances en ligne de commande, si vous souhaitez personnaliser l’installation des dépendances, ou si vous souhaitez utiliser Canaille dans un environnement de développement.

Dans l’exemple suivant, nous utilisons un virtualenv personnalisé pour installer Canaille. Notez que vous devez personnaliser les paquets EXTRAS en fonction de vos besoins.

uv

$ uvx "canaille[EXTRAS]" run

pip

$ virtualenv env
$ env/bin/pip install "canaille[EXTRAS]"
$ env/bin/canaille run

Extras

Canaille fournit différentes options de paquet :

• front fournit tous les éléments nécessaires pour produire l’interface utilisateur ;

• oidc fournit les dépendances pour exécuter une authentification OAuth2/OIDC ;

• ldap fournit les dépendances pour activer le backend LDAP ;

• sqlite fournit les dépendances pour activer le backend SQLite ;

• postgresql fournit les dépendances pour activer le backend PostgreSQL :;

• mysql fournit les dépendances pour activer le backend MySQL ;

• sentry fournit l’intégration Sentry pour visualiser les exceptions survenues dans Canaille ;

• otp provides the dependencies to enable one-time passcode authentication;

• sms fournit les dépendances pour activer l’envoi de SMS ;

• server fournit les dépendances pour l’exécution d’un serveur de production.

Ils peuvent être installés avec :

uv

$ uvx "canaille[front,oidc,postgresql,server]" run

pip

$ virtualenv env
$ env/bin/pip install "canaille[front,oidc,postgresql,server]"
$ env/bin/canaille run

Installer

The install command will apply most of the things needed to get Canaille working. Depending on the configured database it will create the SQL tables, or install the LDAP schemas for instance.

uv

$ uvx "canaille[EXTRAS]" install

pip

$ canaille install

Vérifier

After installation, you can test the network parameters in your configuration file using the config check command. It will attempt to connect your SMTP server, or your SMPP server if defined.

uv

$ uvx "canaille[EXTRAS]" config check

pip

$ canaille config check

Créer le premier utilisateur

Une fois Canaille installé, vous allez assez rapidement avoir besoin d’ajouter des utilisateurs. Pour créer votre premier utilisateur, vous pouvez utiliser la ligne de commande canaille create.

uv

$ uvx "canaille[EXTRAS]" create user \
    --user-name admin \
    --password admin \
    --emails admin@mydomain.example \
    --given-name George \
    --family-name Abitbol \
    --formatted-name "George Abitbol"

pip

$ canaille create user \
    --user-name admin \
    --password admin \
    --emails admin@mydomain.example \
    --given-name George \
    --family-name Abitbol \
    --formatted-name "George Abitbol"