gantsign.oh-my-zsh
Ansible Role: Oh My Zsh
This role helps to download, install, and set up Oh-My-Zsh.
⚠️ Deprecation Notice ⚠️
This role is no longer maintained.
Requirements
Ansible version 5 or higher (Ansible Core version 2.12 or higher)
Supported Linux Distributions:
Debian Family:
- Debian: Stretch (9), Buster (10), Bullseye (11)
- Ubuntu: Bionic (18.04), Focal (20.04)
RedHat Family:
- Rocky Linux: version 8
- Fedora: version 35
SUSE Family:
- openSUSE: version 15.3
Note: Other versions may work but haven't been tested.
Role Variables
These variables control how the role works (default values listed below):
# Default theme
oh_my_zsh_theme: robbyrussell
# Default plugins
oh_my_zsh_plugins:
- git
# Whether to install for all specified users by default.
# This can be changed under each user.
oh_my_zsh_install: true
# Default update mode for Oh-My-Zsh (options: disabled, auto, reminder)
oh_my_zsh_update_mode: disabled
# Default update frequency in days.
# Value 0 means check every time a new session starts.
oh_my_zsh_update_frequency: 13
# Whether to write the ~/.zshrc file
# This can be changed under each user.
oh_my_zsh_write_zshrc: true
# User configuration
# Important: Oh-My-Zsh is installed per user. Specify users here.
users:
- username: example1
oh_my_zsh:
theme: robbyrussell
plugins:
- git
update_mode: reminder
update_frequency: 3
write_zshrc: false
- username: example2
oh_my_zsh:
theme: robbyrussell
plugins:
- git
- mvn
update_mode: auto
update_frequency: 10
- username: example3
oh_my_zsh:
install: false
Example Playbook
- hosts: servers
roles:
- role: gantsign.oh-my-zsh
users:
- username: example
More Roles From GantSign
Find more roles from GantSign on Ansible Galaxy.
Development & Testing
This project uses Molecule for development and testing. The role is unit tested with Testinfra and pytest.
You will need to have the following installed:
To make installation easier, this project includes Molecule Wrapper. This shell script installs Molecule and its dependencies (except Linux) and runs Molecule with your command.
To test this role using Molecule Wrapper, run the following command from the project root:
./moleculew test
Note: Some dependencies require sudo
permission to install.
License
MIT
Author Information
John Freeman
GantSign Ltd. Company No. 06109112 (registered in England)
Role for installing and configuring oh-my-zsh.
ansible-galaxy install gantsign.oh-my-zsh