Merge branch 'jimisola-feature/update_docs' into develop
This commit is contained in:
commit
655b343e03
|
@ -105,4 +105,6 @@ venv.bak/
|
|||
# mypy
|
||||
.mypy_cache/
|
||||
|
||||
.idea
|
||||
.idea
|
||||
/docs/examples/attachment*
|
||||
/*.tar.gz
|
19
README.md
19
README.md
|
@ -1,15 +1,14 @@
|
|||
# Ansible KeePass Lookup Plugin
|
||||
|
||||
This collection provides a plugin that allows to read data from KeePass file (modifying is not supported)
|
||||
This collection provides plugins that allows to read data from KeePass file (modifying is not supported)
|
||||
|
||||
## How it works
|
||||
|
||||
The plugin opens a UNIX socket with decrypted KeePass file.
|
||||
The lookup plugin opens a UNIX socket with decrypted KeePass file.
|
||||
For performance reasons, decryption occurs only once at socket startup,
|
||||
and the KeePass file remains decrypted as long as the socket is open.
|
||||
The UNIX socket file is stored in a temporary folder according to OS.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Requirements: `python 3`, `pykeepass==4.0.3`
|
||||
|
@ -47,5 +46,17 @@ Use `ansible-vault encrypt_string` to encrypt it and use it like below
|
|||
ansible_become_pass : "{{ lookup('viczem.keepass.keepass', 'path/to/entry', 'password') }}"
|
||||
custom_field : "{{ lookup('viczem.keepass.keepass', 'path/to/entry', 'custom_properties', 'a_custom_property_name') }}"
|
||||
attachment : "{{ lookup('viczem.keepass.keepass', 'path/to/entry', 'attachments', 'a_file_name') }}"
|
||||
|
||||
- name: "Export file: attachment.txt"
|
||||
viczem.keepass.attachment:
|
||||
database: "{{ keepass_dbx }}"
|
||||
password: "{{ keepass_psw }}"
|
||||
entrypath: example/attachments
|
||||
attachment: "attachment.txt"
|
||||
dest: "{{ keepass_attachment_1_name }}"
|
||||
|
||||
More examples see in [/doc/examples](/doc/examples).
|
||||
More examples see in [/docs/examples](/docs/examples).
|
||||
|
||||
## Contributing
|
||||
|
||||
See docs/contributing.
|
|
@ -0,0 +1,29 @@
|
|||
# Contributing
|
||||
|
||||
1. Create ansible.cfg in cloned directory:
|
||||
|
||||
```
|
||||
[defaults]
|
||||
COLLECTIONS_PATHS = ./collections
|
||||
```
|
||||
|
||||
2. Create requirements.yml in cloned directory:
|
||||
|
||||
```
|
||||
---
|
||||
collections:
|
||||
- name: namespace.collection_name
|
||||
source: /where/is/your/clone
|
||||
type: dir
|
||||
```
|
||||
|
||||
|
||||
3. To install the collection _locally_ in your cloned directory, just install it through ansible-galaxy
|
||||
```shell
|
||||
rm -rf ./collections && ansible-galaxy install -r requirements.yml
|
||||
```
|
||||
|
||||
Note: Any change on your clone imply to reinstall the collection.
|
||||
|
||||
|
||||
Tip: You can place a ansible.cfg with `COLLECTIONS_PATHS = ../../collections` in the examples dictory if you want to run the example on local collection in your cloned directory.
|
|
@ -21,11 +21,11 @@ authors:
|
|||
|
||||
### OPTIONAL but strongly recommended
|
||||
# A short summary description of the collection
|
||||
description: The collection provides a lookup plugin that allow to read data from KeePass file.
|
||||
description: The collection provides plugins that allow to read data from KeePass file.
|
||||
|
||||
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
|
||||
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
|
||||
license: []
|
||||
license: [MIT]
|
||||
|
||||
# The path to the license file for the collection. This path is relative to the root of the collection. This key is
|
||||
# mutually exclusive with 'license'
|
||||
|
@ -36,6 +36,7 @@ license_file: 'LICENSE'
|
|||
tags:
|
||||
- keepass
|
||||
- lookup
|
||||
- module
|
||||
- plugin
|
||||
|
||||
# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
|
||||
|
|
Loading…
Reference in New Issue