Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gantsign/ansible-role-oh-my-zsh
Ansible role for installing and configuring oh-my-zsh
https://github.com/gantsign/ansible-role-oh-my-zsh
ansible ansible-role oh-my-zsh
Last synced: 28 days ago
JSON representation
Ansible role for installing and configuring oh-my-zsh
- Host: GitHub
- URL: https://github.com/gantsign/ansible-role-oh-my-zsh
- Owner: gantsign
- License: mit
- Created: 2016-08-18T17:33:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-16T10:45:01.000Z (about 1 year ago)
- Last Synced: 2024-09-30T17:23:45.043Z (about 1 month ago)
- Topics: ansible, ansible-role, oh-my-zsh
- Language: Shell
- Homepage: https://galaxy.ansible.com/gantsign/oh-my-zsh
- Size: 142 KB
- Stars: 165
- Watchers: 6
- Forks: 41
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ansible Role: Oh My Zsh
=======================
[](https://github.com/gantsign/ansible-role-oh-my-zsh/actions?query=workflow%3ATests)
[](https://galaxy.ansible.com/gantsign/oh-my-zsh)
[](https://raw.githubusercontent.com/gantsign/ansible-role-oh-my-zsh/master/LICENSE)
Role to download, install and configure [Oh-My-Zsh](http://ohmyz.sh/).
:thumbsdown: Deprecation Notice :thumbsdown:
--------------------------------------------
This role is no longer maintained.
Requirements
------------
* Ansible >= 5 (Ansible Core >= 2.12)
* Linux Distribution
* Debian Family
* Debian
* Stretch (9)
* Buster (10)
* Bullseye (11)
* Ubuntu
* Bionic (18.04)
* Focal (20.04)
* RedHat Family
* Rocky Linux
* 8
* Fedora
* 35
* SUSE Family
* openSUSE
* 15.3
* Note: other versions are likely to work but have not been tested.
Role Variables
--------------
The following variables will change the behavior of this role (default values
are shown below):
```yaml
# Default theme
oh_my_zsh_theme: robbyrussell
# Default plugins
oh_my_zsh_plugins:
- git
# Whether to install by default for all specified users.
# May be overridden by `oh_my_zsh: install:` under each user.
oh_my_zsh_install: true
# Default update mode for Oh-My-Zsh
# accepted values are:
# disabled (default)
# auto
# reminder
oh_my_zsh_update_mode: disabled
# Default update frequency in days. When the update mode is set to a value other
# than "disabled", this is the frequency (in days) to check for a new version.
# The value 0 will check every time a new shell session starts.
oh_my_zsh_update_frequency: 13
# Whether to write the ~/.zshrc file
# May be overridden by `oh_my_zsh: write_zshrc:` under each user.
oh_my_zsh_write_zshrc: true
# User configuration
# Important: oh-my-zsh is installed per user so you need to specify the users to install it for.
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
----------------
```yaml
- hosts: servers
roles:
- role: gantsign.oh-my-zsh
users:
- username: example
```
More Roles From GantSign
------------------------
You can find more roles from GantSign on
[Ansible Galaxy](https://galaxy.ansible.com/gantsign).
Development & Testing
---------------------
This project uses [Molecule](http://molecule.readthedocs.io/) to aid in the
development and testing; the role is unit tested using
[Testinfra](http://testinfra.readthedocs.io/) and
[pytest](http://docs.pytest.org/).
To develop or test you'll need to have installed the following:
* Linux (e.g. [Ubuntu](http://www.ubuntu.com/))
* [Docker](https://www.docker.com/)
* [Python](https://www.python.org/) (including python-pip)
* [Ansible](https://www.ansible.com/)
* [Molecule](http://molecule.readthedocs.io/)
Because the above can be tricky to install, this project includes
[Molecule Wrapper](https://github.com/gantsign/molecule-wrapper). Molecule
Wrapper is a shell script that installs Molecule and it's dependencies (apart
from Linux) and then executes Molecule with the command you pass it.
To test this role using Molecule Wrapper run the following command from the
project root:
```bash
./moleculew test
```
Note: some of the dependencies need `sudo` permission to install.
License
-------
MIT
Author Information
------------------
John Freeman
GantSign Ltd.
Company No. 06109112 (registered in England)