globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: CLI documentation improvements

Browse source
This commit is contained in:
Éloi Rivard 2024-05-12 11:33:22 +02:00
parent b16630063b
commit 4791d27569
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
canaille/app/commands.py
View file

@ -27,7 +27,11 @@ def with_backendcontext(func):
@with_appcontext
@with_backendcontext
def check():
"""Check the configuration file."""
"""Test the configuration file.
Attempt to reach the database and the SMTP server with the provided
credentials.
"""
from canaille.app.configuration import ConfigurationException
from canaille.app.configuration import validate
@ -41,7 +45,11 @@ def check():
@click.command()
@with_appcontext
def install():
"""Installs canaille elements from the configuration."""
"""Installs canaille elements from the configuration.
For instance, depending on the configuration, this can generate OIDC
keys or install LDAP schemas.
"""
from canaille.app.configuration import ConfigurationException
from canaille.app.installation import install

2
canaille/commands.py
View file

@ -14,7 +14,7 @@ from canaille import create_app
add_default_commands=False,
)
def cli():
"""Canaille management."""
"""Canaille management utilities."""
canaille.app.commands.register(cli)