Skip to content
Snippets Groups Projects
Verified Commit 6cbf85be authored by me5na7qbjqbrp's avatar me5na7qbjqbrp
Browse files

More documentation

parent 76017e8c
No related branches found
No related tags found
1 merge request!7Create pip package
...@@ -7,15 +7,13 @@ cPasswords is a group password manager develop by the ...@@ -7,15 +7,13 @@ cPasswords is a group password manager develop by the
Client installation Client installation
------------------- -------------------
- Clone the code,
``git clone git@gitlab.crans.org:nounous/cranspasswords.git``,
- Add you GPG fingerprint and your SSH key to the cpassword server. For - Add you GPG fingerprint and your SSH key to the cpassword server. For
the CRANS, you can do this on the intranet. the CRANS, you can do this on the intranet.
- Customize ``docs/clientconfig.example.py`` if you need to. - Clone the code,
``git clone git@gitlab.crans.org:nounous/cranspasswords.git``,
- Launch ``pip install --user -e .``, - Launch ``pip install --user .``,
- Make sure the install path (``~/.local/bin``) is in your ``$PATH``, - Make sure the install path (``~/.local/bin``) is in your ``$PATH``,
...@@ -27,12 +25,17 @@ Server installation ...@@ -27,12 +25,17 @@ Server installation
- Clone the code, - Clone the code,
``git clone git@gitlab.crans.org:nounous/cranspasswords.git``, ``git clone git@gitlab.crans.org:nounous/cranspasswords.git``,
- Edit ``sudoers_group`` in Makefile to choose which group will be able - Launch ``pip install --user .``,
to read password files (but no neccessary able to decrypt!),
- Add a sudoers rule to enable users from ``sudoers_group`` to launch
cpasswords,
``%sudoers_group ALL=(root) NOPASSWD: /usr/local/bin/cranspasswords-server``
- Launch ``sudo make install-server``, - Copy and adapt ``docs/serverconfig.example.py`` to
``/etc/cranspasswords/serverconfig.py``.
- Edit ``/etc/cranspasswords/serverconfig.py`` if you need to. - Create ``/var/lib/cranspasswords/db/`` with owner root and mod 700
(root only).
How to How to
------ ------
...@@ -56,7 +59,7 @@ Change command name ...@@ -56,7 +59,7 @@ Change command name
If you wish to rename the command from ``cranspasswords`` to something If you wish to rename the command from ``cranspasswords`` to something
else, define ``COMMAND_NAME`` environment variable before executing else, define ``COMMAND_NAME`` environment variable before executing
``pip install`` during the installation. ``pip install`` during the installation of the client or server.
Import cPasswords Import cPasswords
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
......
...@@ -43,8 +43,9 @@ if not config.read(config_path + "/clientconfig.ini"): ...@@ -43,8 +43,9 @@ if not config.read(config_path + "/clientconfig.ini"):
__name__ == '__main__' __name__ == '__main__'
if ducktape_display_error: if ducktape_display_error:
# Do not use logger as it has not been initialized yet # Do not use logger as it has not been initialized yet
print("%s/clientconfig.ini could not be read. Please read README." % print("%s/clientconfig.ini could not be found or read.\n"
config_path) "Please copy `docs/clientconfig.example.ini` from the source "
"repository and customize." % config_path)
exit(1) exit(1)
# Logger local # Logger local
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment