REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• taiga: Install both Taiga front, back and setup an apache Virtual Host
• taiga::back: Install Taiga back
• taiga::front: Install taiga front
• taiga::vhost: Configure an apache Virtual Host for taiga

Private Classes

• taiga::back::config: Configure Taiga back
• taiga::back::cron: Setup crontab
• taiga::back::database: Configure Taiga back database
• taiga::back::dependencies: Configure Taiga back dependencies
• taiga::back::install: Install Taiga back
• taiga::back::ldap: Manage Taiga back LDAP configuration
• taiga::back::migrate: Perform Taiga back migrations
• taiga::back::repo: Manage the Taiga back repository
• taiga::back::seed: Seed Taiga back
• taiga::back::user: Manage the Taiga back user
• taiga::front::config: Manage Taiga front config
• taiga::front::repo: Manage the Taiga front repository

Defined types

Private Defined types

• taiga::back::manage: Allow running actions in Taiga back environment

Data types

• Taiga::Admin: A Taiga::Admin is composed of a full name and an e-mail address

Tasks

• project_change_slug: Change a project slug
• user_change_fullname: Change the full name for specified user
• user_disable: Disable the specified user
• user_list: List users
• version: Retrieve Taiga back and front versions

Classes

taiga

Install both Taiga front, back and setup an apache Virtual Host

Parameters

The following parameters are available in the taiga class:

• hostname
• back_secret_key
• back_db_password
• protocol
• default_language
• repo_ensure
• repo_revision
• back_directory
• venv_directory
• front_directory
• back_user
• back_admins
• public_register_enabled
• gravatar
• ldap_server
• ldap_port
• ldap_bind_dn
• ldap_bind_password
• ldap_search_base
• ldap_search_property
• ldap_search_suffix
• ldap_email_property
• ldap_full_name_property
• ssl_cert
• ssl_key
• ssl_chain
• change_notification_min_interval
• default_project_slug_prefix

hostname

Data type: String[1]

Hostname that will be used to reach the Taiga instance.

back_secret_key

Data type: String[1]

A secret key passed to the SECRET_KEY setting in taiga-back configuration. (A 60 characters random string should be a good start).

back_db_password

Data type: String[1]

Sets the database password. It is currently not used but still has to be provided.

protocol

Data type: Enum['http', 'https']

Protocol to be used.

Default value: 'https'

default_language

Data type: String[2, 2]

Default language.

Default value: 'en'

repo_ensure

Data type: Enum['present', 'latest']

Ensure value for Taiga's vcs repository.

Default value: 'present'

repo_revision

Data type: String[1]

Revision for Taiga's vcs repository.

Default value: 'stable'

back_directory

Data type: Stdlib::Absolutepath

Directory where is installed the backend of Taiga.

Default value: '/srv/www/taiga-back'

venv_directory

Data type: Stdlib::Absolutepath

Default where is installed python dependencies.

Default value: '/srv/www/taiga-venv'

front_directory

Data type: Stdlib::Absolutepath

Directory where is installed the frontend of Taiga.

Default value: '/srv/www/taiga-front'

back_user

Data type: String[1]

Name of the user running the backend daemon.

Default value: 'taiga'

back_admins

Data type: Array[Taiga::Admin]

Administrators to notify of Taiga exceptions.

Default value: []

public_register_enabled

Data type: Boolean

Enable anyone to register on this instance.

Default value: true

gravatar

Data type: Boolean

Use gravatar.

Default value: true

ldap_server

Data type: Optional[String[1]]

LDAP server.

Default value: undef

ldap_port

Data type: Integer

LDAP port.

Default value: 389

ldap_bind_dn

Data type: Optional[String[1]]

DN to use for LDAP authentication.

Default value: undef

ldap_bind_password

Data type: Optional[String[1]]

Password to use for LDAP authentication.

Default value: undef

ldap_search_base

Data type: String[1]

Search base for users.

Default value: 'ou=people,dc=example,dc=com'

ldap_search_property

Data type: String[1]

Property holding users login.

Default value: 'uid'

ldap_search_suffix

Data type: Optional[String[1]]

Default value: undef

ldap_email_property

Data type: String[1]

Property holding users e-mail.

Default value: 'mail'

ldap_full_name_property

Data type: String[1]

Property holding users full name.

Default value: 'cn'

ssl_cert

Data type: Optional[Stdlib::Absolutepath]

Certificate to use for apache VirtualHost.

Default value: undef

ssl_key

Data type: Optional[Stdlib::Absolutepath]

Key to use for apache VirtualHost.

Default value: undef

ssl_chain

Data type: Optional[Stdlib::Absolutepath]

Certificate chain to use for apache VirtualHost.

Default value: undef

change_notification_min_interval

Data type: Optional[Integer]

Interval for sending change notifications.

Default value: undef

default_project_slug_prefix

Data type: Optional[Boolean]

Add username to project slug

Default value: undef

taiga::back

Install Taiga back

Parameters

The following parameters are available in the taiga::back class:

• front_hostname
• front_protocol
• back_hostname
• back_protocol
• secret_key
• db_password
• dependencies
• db_name
• db_user
• user
• repo_ensure
• repo_revision
• install_dir
• venv_dir
• admins
• public_register_enabled
• ldap_enable
• ldap_server
• ldap_port
• ldap_bind_dn
• ldap_bind_password
• ldap_search_base
• ldap_search_property
• ldap_search_suffix
• ldap_email_property
• ldap_full_name_property
• email_use_tls
• email_host
• email_port
• email_user
• email_password
• change_notification_min_interval
• default_project_slug_prefix

front_hostname

Data type: String[1]

Hostname used to reach the frontend.

front_protocol

Data type: Enum['http', 'https']

Protocol used to reach the frontend.

back_hostname

Data type: String[1]

Hostname used to reach the backend.

back_protocol

Data type: Enum['http', 'https']

Protocol used to reach the backend.

secret_key

Data type: String[1]

A secret key passed to the SECRET_KEY setting in taiga-back configuration. (A 60 characters random string should be a good start).

db_password

Data type: String[1]

Sets the database password. It is currently not used but still has to be provided.

dependencies

Data type: Array[String[1]]

Extra depepdencies.

db_name

Data type: String[1]

Name of the database.

Default value: 'taiga'

db_user

Data type: String[1]

User of the database.

Default value: 'taiga'

user

Data type: String[1]

Name of the user running the backend daemon.

Default value: 'taiga'

repo_ensure

Data type: Enum['present', 'latest']

Ensure value for Taiga's vcs repository.

Default value: 'present'

repo_revision

Data type: String[1]

Revision for Taiga's vcs repository.

Default value: 'stable'

install_dir

Data type: Stdlib::Absolutepath

Directory where is installed the backend of Taiga.

Default value: '/srv/www/taiga-back'

venv_dir

Data type: Stdlib::Absolutepath

Directory where is installed Taiga pyhton dependencies.

Default value: '/srv/www/taiga-venv'

admins

Data type: Array[Taiga::Admin]

Administrators to notify of Taiga exceptions.

Default value: []

public_register_enabled

Data type: Boolean

Enable anyone to register on this instance.

Default value: true

ldap_enable

Data type: Boolean

Enable the LDAP client.

Default value: false

ldap_server

Data type: Optional[String[1]]

LDAP server.

Default value: undef

ldap_port

Data type: Integer

LDAP port.

Default value: 389

ldap_bind_dn

Data type: Optional[String[1]]

DN to use for LDAP authentication.

Default value: undef

ldap_bind_password

Data type: Optional[String[1]]

Password to use for LDAP authentication.

Default value: undef

ldap_search_base

Data type: String[1]

Search base for users.

Default value: 'ou=people,dc=example,dc=com'

ldap_search_property

Data type: String[1]

Property holding users login.

Default value: 'uid'

ldap_search_suffix

Data type: Optional[String[1]]

Default value: undef

ldap_email_property

Data type: String[1]

Property holding users e-mail.

Default value: 'mail'

ldap_full_name_property

Data type: String[1]

Property holding users full name.

Default value: 'cn'

email_use_tls

Data type: Boolean

Use TLS to connect to the mail server.

Default value: false

email_host

Data type: String[1]

Hostname of the mail server.

Default value: 'localhost'

email_port

Data type: Integer

Port of the mail server.

Default value: 25

email_user

Data type: Optional[String[1]]

Username to authenticate on the mail server.

Default value: undef

email_password

Data type: Optional[String[1]]

Password to authenticate on the mail server.

Default value: undef

change_notification_min_interval

Data type: Optional[Integer]

Interval for sending change notifications.

Default value: undef

default_project_slug_prefix

Data type: Optional[Boolean]

Add username to project slug

Default value: undef

taiga::front

Install taiga front

Parameters

The following parameters are available in the taiga::front class:

• back_hostname
• back_protocol
• events
• user
• repo_ensure
• repo_revision
• install_dir
• default_language
• public_register_enabled
• ldap_enable
• gravatar

back_hostname

Data type: String[1]

Hostname used to reach the backend.

back_protocol

Data type: Enum['http', 'https']

Protocol used to reach the backend.

events

Data type: Boolean

Default value: false

user

Data type: String[1]

Name of the user owning the files of the frontend.

Default value: 'nobody'

repo_ensure

Data type: Enum['present', 'latest']

Ensure value for Taiga's vcs repository.

Default value: 'present'

repo_revision

Data type: String[1]

Revision for Taiga's vcs repository.

Default value: 'stable'

install_dir

Data type: Stdlib::Absolutepath

Directory where is installed the frontend of Taiga.

Default value: '/srv/www/taiga-front'

default_language

Data type: String[2, 2]

Default language.

Default value: 'en'

public_register_enabled

Data type: Boolean

Enable anyone to register on this instance.

Default value: true

ldap_enable

Data type: Boolean

Enable the LDAP client.

Default value: false

gravatar

Data type: Boolean

Use gravatar.

Default value: true

taiga::vhost

Configure an apache Virtual Host for taiga

Parameters

The following parameters are available in the taiga::vhost class:

• protocol
• hostname
• back_directory
• venv_directory
• front_directory
• back_user
• ssl_cert
• ssl_key
• ssl_chain

protocol

Data type: Enum['http', 'https']

Protocol to be used.

hostname

Data type: String[1]

Hostname that will be used to reach the Taiga instance.

back_directory

Data type: Stdlib::Absolutepath

Directory where is installed the backend of Taiga.

venv_directory

Data type: Stdlib::Absolutepath

Directory where is installed python dependencies.

front_directory

Data type: Stdlib::Absolutepath

Directory where is installed the frontend of Taiga.

back_user

Data type: String[1]

Name of the user running the backend daemon.

ssl_cert

Data type: Optional[String[1]]

Certificate to use for apache VirtualHost.

Default value: undef

ssl_key

Data type: Optional[String[1]]

Key to use for apache VirtualHost.

Default value: undef

ssl_chain

Data type: Optional[String[1]]

Certificate chain to use for apache VirtualHost.

Default value: undef

Data types

Taiga::Admin

A Taiga::Admin is composed of a full name and an e-mail address

Alias of Tuple[String[1], Pattern[/.@./]]

Tasks

project_change_slug

Change a project slug

Supports noop? false

Parameters

current_slug

Data type: String[1]

Current project slug

new_slug

Data type: String[1]

New project slug

backend_directory

Data type: String[1]

Backend directory

venv_directory

Data type: String[1]

Python virtual env directory

user_change_fullname

Change the full name for specified user

Supports noop? false

Parameters

username

Data type: String[1]

Username

fullname

Data type: String[1]

Full name

database

Data type: String[1]

Database name

user_disable

Disable the specified user

Supports noop? false

Parameters

username

Data type: String[1]

Username

database

Data type: String[1]

Database name

user_list

List users

Supports noop? false

Parameters

database

Data type: String[1]

Database name

version

Retrieve Taiga back and front versions

Supports noop? false

Parameters

backend_directory

Data type: String[1]

Backend directory

frontend_directory

Data type: String[1]

Frontend directory