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.
Leo Maroni 55cc64ced2
Removed unneded role variables in README
2 years ago
defaults Install wekan (working version) 2 years ago
handlers Install wekan (working version) 2 years ago
meta Install wekan (working version) 2 years ago
tasks Install wekan (working version) 2 years ago
templates Install wekan (working version) 2 years ago
tests Install wekan (working version) 2 years ago
.travis.yml Initial commit 2 years ago
LICENCE Initial commit 2 years ago
README.md Removed unneded role variables in README 2 years ago

README.md

Ansible role for Wekan

Ansible role for a wekan installation without docker

Requirements

  • A server with mongodb installed
  • (optional) An e-mail server

Role Variables

Variable Name Function Default value Comment
wekan_user User created for running the wekan service wekan
wekan_group Group for the user created for the wekan service {{ wekan_user }}
wekan_version Version of wekan that is going to be installed (required when using standard source) If you use the standard source, please only use the latest version or one available at https://releases.wekan.team.
wekan_source Source of the wekan Installtion package https://releases.wekan.team/wekan-{{ wekan_version }}.zip
wekan_nodejs_path Path of nodejs to be used in service file /usr/bin/env node
wekan_systemd_service_name The name of the systemd service file wekan
wekan_base_path Installation base path /opt/wekan without trailing slash
wekan_mongodb_url URL of MongoDB (required) Docs
wekan_root_url Root URL (required) Example: https://kanban.example.org
wekan_port Port Wekan listens on (required)

Extra Options

E-Mail / SMTP

Default sender is Wekan <wekan@{{ ansible_fqdn }}> when wekan_mail is not specified.

wekan_mail:
  protocol: smtps
  user: youremail@example.org
  password: yourpassword
  server: smtp.example.org
  port: 587
  sender: Wekan <youremail@example.org>

Other

You can define any other environment variables in the ansible variable wekan_extra_variables. A list of possible other options can you get here.

Dependencies

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: servers
  roles:
     - { role: em0lar.wekan, wekan_version: "3.93", wekan_mongodb_url: "mongodb://wekan:password@localhost:27017/wekan", wekan_root_url: "https://kanban.example.org" , wekan_port: 8080, nodejs_version: "12.x" }

License

GPL-3.0