You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
L3D 30c0110ed0
Merge pull request #8 from roles-ansible/lint
4 weeks ago
.github Add gpg as debian requirement 4 weeks ago
defaults update linting and use FQCN 12 months ago
handlers improve linting and update meta info 4 weeks ago
meta improve linting and update meta info 4 weeks ago
tasks Add gpg as debian requirement 4 weeks ago
templates change config 2 years ago
vars improve linting and update meta info 4 weeks ago
.yamllint huge commit, updating role to ansible 2.11 2 years ago
LICENSE Update LICENSE and FOUNDING informations 4 years ago improve linting and update meta info 4 weeks ago

Ansible Galaxy MIT License

ansible weechat role

Ansible role to install and configure weechat.

WeeChat, the extensible chat client.

What can this role:

  • install weechat on Debian, Ubuntu, Archlinux or Fedora
  • configure weechat
  • autostart via tmux and systemd


 weechat__install: true
  • weechat__install: true: This role should install weechat. On debian based OS we add the official weechat apt source and install some plugin support and weechat-doc.
  • weechat__install: false: We do not install weechat
weechat__autostart: false
  • weechat__autostart: false: We do not install any autostart mechanism
  • weechat__autostart: true: This role install tmux and creates a systemd service to launch weechat inside a tmux session as user {{ weechat__user }}
weechat__install_plugins: false
  • weechat__install_plugins: false: we do not install any weechat plugins
  • weechat__install_plugins: true: We do install all official plugins specified in {{ weecat.plugins }} dict.
weechat__use_custom_config: false
  • weechat__use_custom_config: false: You do not provide a custom config from your own git repository
  • weechat__use_custom_config: true: You have your weechat configuration in a own git repository and want to use it
weechat__install_plugins: false
  • weechat__install_plugins: false we do not install any official weechat plugins
  • weechat__install_plugins: true we install the official weechat plugins defined in the {{ weechat__plugins: [] }} directory.
  • Example weechat__plugins: [] list
weechat__user: "{{ ansible_user_id }}"
  • the user to use weechat with. This value is used in the autostart task, the custom_config task and the {{ weechat__home_directory }} variable
weechat__home_directory: "{{ ansible_env.HOME | default('/home/{{ weechat__user }}') }}"
  • the path where the weechat home is located. If the variable {{ ansible_env.HOME }} is not set it will use "/home/{{ weechat__user }}" as fallback.
weechat__gpg_id: '11E9DE8848F2B65222AA75B8D1820DB22A11534E'
weechat__custom_private_repo: false
  • The path to your git repo with your personal weechat config.
  • This role clones the repo to the "{{ weechat__home_directory }}/.weechat" directory. (Also known al your local .weechat directory.) It will fail if you already have files and/or folders in your local .weechat dorectory.
  • You have to add, commit and push the local changes in your local .weechat folder manually. Please be aware that it is a good idea to disable your log or at least add the weechatlog folder to your .gitignore file in your personal weechat config.
weechat__custom_gen_ssh_key_pair: true
  • weechat__custom_gen_ssh_key_pair: true: We will generate a eleptic curve ssh key (if it not already exist at "{{ weechat__home_directory }}/.ssh/id_ed25519") and print the public key to the prompt. This will give you the time to add this public key to your private git repo for your own weechat config as deploy key. This is required to download your private repo withour username/password. This requires that you set {{ weechat__custom_private_repo }} to the ssh accessable version of your git repo.
  • weechat__custom_gen_ssh_key_pair: false: We do not manage access to the git repo with your weechat config.
weechat__custom_version: main
  • weechat__custom_version: main: set the git branch, tag, hash or version this role should use if you use a custom git repo for your weechat config.

References and Inspiration:


If you missing a feature, found a bug or have questions about this role please feel free to open a git issue. Or - even better - create a pull request.


MIT License

  • Copyright (c) 2019 L3D
  • The complete list of awesome contributros can be found here.


This role is tested with some of these github-action tests for different versions of differen linux systems. Linting is tested via the ansible-lint action. If you want to find out more about our tests, please have a look at the github marketplace.