Ansible WeeChat Role

This is an Ansible role designed to install and configure WeeChat, an extensible chat client.

What This Role Can Do:

• Install WeeChat on Debian, Ubuntu, Arch Linux, or Fedora.
• Include configuration from a private Git repository.
• Set up autostart using tmux and systemd.

Settings

1. Installation

   weechat__install: true
   

   • true: Installs WeeChat and adds the official WeeChat APT source, along with some plugin support and documentation.
   • false: Does not install WeeChat.

2. Autostart

   weechat__autostart: false
   

   • false: No autostart mechanism is installed.
   • true: Installs tmux and creates a systemd service to launch WeeChat in a tmux session as the user specified.

3. Plugins Installation

   weechat__install_plugins: false
   

   • false: No WeeChat plugins are installed.
   • true: Installs all official plugins listed in the {{ weechat.plugins }} dictionary.

4. Custom Configuration

   weechat__use_custom_config: false
   

   • false: No custom configuration from your Git repository is provided.
   • true: Uses your WeeChat configuration from your own Git repository.

5. User Configuration

   weechat__user: "{{ ansible_user_id }}"
   

   • The user under which WeeChat will run.

6. Home Directory

   weechat__home_directory: "{{ ansible_env.HOME | default('/home/{{ weechat__user }}') }}"
   

   • Path to the WeeChat home directory.

7. GPG ID

   weechat__gpg_id: '11E9DE8848F2B65222AA75B8D1820DB22A11534E'
   

   • GPG fingerprint from the official WeeChat Debian repository.

8. Custom Git Repository

   weechat__custom_private_repo: false
   

   • Specifies whether to clone your personal Git repository containing your WeeChat configuration.

9. SSH Key Pair

   weechat__custom_gen_ssh_key_pair: true
   

   • true: Generates an SSH key pair if it doesn’t exist and prints the public key. This is necessary for accessing your private Git repository without a username/password.
   • false: Does not manage access to your Git repository.

10. Custom Version

    weechat__custom_version: main
    

    • Specifies the Git branch, tag, or version to use if you are using a custom Git repository for your configuration.

References and Inspirations

• Installation instructions for Debian/Ubuntu: weechat.org/download/debian
• Configuration inspiration from github.com/irth/ansible-role-weechat.
• Information on autostart and systemd: Ubuntu Wiki and Ansible Documentation.

Requirements

To use this role, you need the community.general and community.crypto collections. Install them using:

ansible-galaxy collection install -r requirements.yml --upgrade

Contributing

If you notice a missing feature, find a bug, or have questions about this role, please open a Git issue or create a pull request.

License

Copyright (c) 2019 L3D l3d@c3woc.de

You can find a complete list of contributors here.