Skip to content

Latest commit

 

History

History
187 lines (132 loc) · 3 KB

README.md

File metadata and controls

187 lines (132 loc) · 3 KB
Raw

Role dbv.nnn

Ansible role to install and configure a the nnn file manager.

Requirements

  • The NNN package must be available in the local file repository.
  • Rsync
  • The role requires gathered_facts: true to be set.

Role Variables

Available variables are listed below, along with default values (see defaults/main.yml):

nnn_path_environment_file: str

  • Path for the file to define the export for the plugin inclusion in.

    # Example:
nnn_path_environment_file: "{{ lookup('ansible.builtin.env', 'HOME') }}/.bashrc"
nnn_plugins_install: bool

  • If set to true plugins will be fetched from nnn_url_master and installed into the plugin directory.

    # Example:
nnn_plugins_install: true
nnn_plugins_update: bool

  • If set to true, existing plugins will be overwritten from the github source and updated on the local disk.

    # Example:
nnn_plugins_update: true

Configuration variables

nnn_archmnt: str

  • Achive mounter for NNN.

    # Example:
nnn_archmnt: "fuse-archive"
nnn_order: list

  • Set directory specific ordering.

    # Example:
NNN_ORDER:
  - key: t
    path: /var/log
nnn_plug: list

  • List of plugins to install/enable.

    # Example:
nnn_plugins:
  - key: i
    plugin: imgview
  - key: j
    plugin: imgresize

Other variables

nnn_group: str

  • Default group for NNN.

    # Example:
nnn_group: jdoe
nnn_owner: str

  • Default user for NNN.

    # Example:
nnn_owner: jdoe
nnn_packages: list

  • defaults file for nnn Default packages to install for NNN

    # Example:
nnn_packages:
  - nnn
nnn_packages_state: str

  • Default state for the installed packages.

    # Example:
nnn_packages_state: "present"
nnn_path_config_dir: str

  • Default path to the configuration directory.

    # Example:
nnn_path_config_dir: "/home/user/.config/nnn"
nnn_url_master: str

  • URL for downloading a compressed version of the source code for nnn. This is used to fetch the plugins and install them when required.

    # Example:
nnn_url_master: "https://github.com/jarun/nnn/archive/master.tar.gz"

Dependencies

  • None

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

---
- hosts: all
  roles:
     - role: dbv.nnn

Limitations

The role lacks support for most of the environment variables of nnn at this point. This is due to the role growing as I need it and which parameters I need to set. But I put some effort into making it easy to extend when needed. If you miss a particular parameter, just pop me a message.

License

MIT

Author Information

  • This role is written an maintained by DBV.