Linux packages

At the moment, only NixOS provides a Canaille package. For other distros, you must use a different way to install Canaille.

$ nix run "nixpkgs#canaille" run

Warning

The current version of Canaille shipped by NixOS is 0.0.74, everything might not work as expected with this version.

Install

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.

$ nix run "nixpkgs#canaille" install

Check

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.

$ nix run "nixpkgs#canaille" config check

Create the first user

Once canaille is installed, soon enough you will need to add users. To create your first user you can use the canaille create CLI.

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