#######################################################################################################

:exclamation: DEPRECATION :exclamation:

This repository and the role associated are deprecated in favor of the Manala Ansible Collection

You will find informations on its usage on the collection repository

#######################################################################################################

Ansible Role: Oh My Zsh

:exclamation: Report issues and send Pull Requests in the main Ansible Role repository :exclamation:

This role will deal with the setup of Oh My Zsh.

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

Requirements

None.

Dependencies

None.

Installation

Ansible 2+

Using ansible galaxy cli:

ansible-galaxy install manala.ohmyzsh

Using ansible galaxy requirements file:

- src: manala.ohmyzsh

Role Handlers

None

Role Variables

Oh My Zsh configuration

The manala_ohmyzsh_users_defaults key will allow you to define different users configuration default templates.

manala_ohmyzsh_users_defaults:
  template: my/.zshrc.j2

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

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

User configuration

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

manala_ohmyzsh_users:
  # Template (recommended)
  - user: root
    template: users/manala/.zshrc.j2
    config:
      ZSH_THEME: default.prod
      plugins: [git, debian, common-aliases, history, history-substring-search]
  # Dict config
  - user: root
    group: foo # Default to user primary group, but can be overriden
    config:
      ZSH_THEME: default.prod
      plugins: [git, debian, common-aliases, history, history-substring-search]
  # Raw config
  - user: root
    config: |
      # Path to your oh-my-zsh installation.
      export ZSH=$HOME/.oh-my-zsh
  # Dict's array parameters (deprecated):
  - user: root
    config:
      - ZSH_THEME: default.prod
      - plugins: (git debian common-aliases history history-substring-search)
  - user: bar
    state: ignore # Entry will be ignored
  # Flatten users
  - "{{ my_custom_users_array }}"

Custom themes

manala_ohmyzsh_custom_themes_exclusive allow you to clean up existing custom themes into directory defined by the manala_ohmyzsh_custom_themes_dir key. Made to be sure no old or manually created files will alter current configuration.

manala_ohmyzsh_custom_themes_exclusive: true

manala_ohmyzsh_custom_themes:
  - file: foo.zsh-theme
    config: |
      PROMPT="%{$fg[red]%}%n%{$reset_color%}@%{$fg[blue]%}%m %{$fg[yellow]%}%~ %{$reset_color%}%% "
  # Template based (file name based on template)
  - template: ohmyzsh/custom/template.zsh-theme.j2
  # Template based (force file name)
  - file: bar.zsh-theme
    template: ohmyzsh/custom/template.zsh-theme.j2
  # Ensure config is absent
  - file: absent.zsh-theme
    state: absent # "present" by default
  # Ignore config
  - file: ignore.zsh-theme
    state: ignore
  # Flatten themes
  - "{{ my_custom_themes_array }}"

Note: to ensure backward compatibility, this role will install these custom themes templates by default:

• custom/themes/default.dev.j2
• custom/themes/default.demo.j2
• custom/themes/default.staging.j2
• custom/themes/default.prod.j2

Flags

Allow Oh My Zsh to retrieve new revisions from the repository

manala_ohmyzsh:
  update: true

# Can also be set across manala roles
manala:
  update: true

Example playbook

- hosts: servers
  roles:
    - role: manala.ohmyzsh

Licence

MIT

Author information

Manala (http://www.manala.io/)