README

Bienvenue sur l'outil de gestion de mot de passe du Cr@ns.

Ce dépôt git contient à la fois le programme client (à utiliser sur votre
ordinateur) et le serveur.

== Nom de la commande ==
Si vous voulez appeler votre commande autrement que "cranspasswords",
c'est possible. Il faut pour cela changer la variable cmd_name dans le Makefile
avant de lancer make install ou make install-server.

== Installation et configuration du client ==
 * Copiez le dépôt git sur votre machine :
    $ git clone git@gitlab.crans.org:nounous/cranspasswords.git
 * Si ce n'est déjà fait, indiquer votre clé publique sur gest_crans
   (évidemment, c'est si vous l'installez pour un usage Cr@ns)
 * Si vous ne comptez pas utiliser cranspasswords mais une version custom,
   il y a d'autres détails à modifier :
   * Dans le Makefile, changer cmd_name (attention, par cmd_original_name !)
   * Dans clientconfig.example.py, spécifiez le/les serveurs pertinents
 * Lancez make install
 * Assurez-vous d'avoir ~/bin dans votre $PATH
 * Exécutez cranspasswords test pour voir si vous arrivez à récupérer le mot de passe de test

 * Si vous voulez pouvoir importer client.py pour faire des choses dans ipython par exemple,
   comme votre sys.argv[0] ne sera pas "cranspasswords", il aura du mal à savoir où il doit
   aller cherche sa config.
   Aidez-le avec :
   export CRANSPASSWORDS_CLIENT_CONFIG_DIR=/path/to/config/dir/
   
   NB : le nom de cette variable n'est pas modifié
   même si vous renommez la commande cranspasswords.

== Installation et configuration du serveur ==
 * Copiez le dépôt git sur le serveur :
    $ git clone git://git.crans.org/git/cranspasswords.git
 * Lancez sudo make install-server
  * Il va installer un suoder-file, si vous voulez paramétrer
    le groupe qui aura les accès en lecture aux fichiers de mot de passe,
    changez la variable sudoer_group au début de Makefile.
    La possibilité de lire les fichiers est indépendante de la capacité
    à les déchiffrer.
 * Éditez /etc/cranspasswords/serverconfig.py pour qu'il soit conforme
   à vos désirs.

== Troubleshoutings ==
"""sudo: sorry, a password is required to run sudo"""
    Côté client: Vérifier le ``server_path`` et les variables en dépendant,
    dans le serverconfig.py. S'assurer qu'il n'existe pas de
    clientconfig.py[c] résiduel dans le dossier de cranspasswords.
    Côté serveur, s'assurer que le serveur est intallé au bon endroit
    (/usr/local/bin/$NAME-server) et que le fichier sudoers est bien
    installé (/etc/sudoers.d/$NAME) pour lancer le sudo sans mot de passe.
    Penser aussi à vérifier dans le fichier créé dans (/etc/sudoers.d/) que le groupe existe
    sur la machine et que les utilisateurs sont dedans.


== Complétion ==
 * Pour avoir la bash-complétion, dans votre .bashrc :
  * Sourcez le fichier bash_completion présent dans le dépôt
  * exécutez "complete -F _cranspasswords_completion <nom de votre commande>"