woecifaun/ansible-role-ohmyzsh

This role will assume the checkout and setup of ohmyzsh.

Ansible Role: OhMyZsh (see: https://github.com/robbyrussell/oh-my-zsh)

This role will assume the following configuration:

• Install ohmyzsh globally
• Setup a local zshrc file

It's part of the ELAO Ansible Stack but can be used as a stand alone component.

Requirements

• Ansible 1.9.0+

Dependencies

None.

Installation

Ansible 2+

Using ansible galaxy cli:

ansible-galaxy install elao.ohmyzsh,2.0

Using ansible galaxy requirements file:

- src:     elao.ohmyzsh
  version: 2.0

Ansible 1 (no longer maintained)

Using ansible galaxy cli:

ansible-galaxy install elao.ohmyzsh,1.0

Using ansible galaxy requirements file:

- src:     elao.ohmyzsh
  version: 1.0

Role Handlers

None

Role Variables

Name	Default	Type	Description
elao_ohmyzsh_dir	/usr/local/share/oh-my-zsh	String	ohMyZsh installation directory
elao_ohmyzsh_update	false	Boolean	Whether or not we should auto retrieve new revision of ohMyZsh
elao_ohmyzsh_users_template	users/base.j2	String	User config template
elao_ohmyzsh_users	[]	Array	Collection of users with ohMyZsh custom configurations.

Oh My Zsh configuration

The elao_ohmyzsh_users_template key will allow you to use differents main configuration templates. The role is shipped with basic templates :

• base (Simple template with common configuration)
• dev (Dev configuration, provide a different OhMyZsh theme than production template)
• empty ("Let me handle this" template, no default configuration inside.)
• prod (For production purpose.)

Example

elao_ohmyzsh_users_template: users/base.j2

The elao_ohmyzsh_dir key is used to specify the path where to checkout oh-my-zsh

Example

elao_ohmyzsh_dir: /usr/local/share/oh-my-zsh

The elao_ohmyzsh_update option will allow Oh My Zsh to retrieve new revisions from the repository.

Example

elao_ohmyzsh_update: false

User configuration

This part allow you, with the key elao_ohmyzsh_users, to configure each user account as following:

Name	Default	Type	Description
user	~ (required)	String	User account name
home	root or '/home/' ~ item.user	String	User account home directory
template	~ (required)	String	Template used for Oh My Zsh configuration
config	[]	Array	List of Oh My Zsh options

---

_env:        prod

elao_ohmyzsh_users:
  - user:     root
    template: users/{{ _env }}.j2
    config:
      - ZSH_THEME: elao-prod
      - plugins: (git debian common-aliases history history-substring-search)
  - user:     elao
    group:    root # Default to user primary group, but can be overriden
    template: users/{{ _env }}.j2
    config:
      - ZSH_THEME: elao-prod
      - plugins: (git debian common-aliases history history-substring-search)

Example playbook

- hosts: servers
  roles:
     - { role: elao.ohmyzsh }

Licence

MIT

Author information

ELAO (http://www.elao.com/)