Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Described this role and its use.
- Loading branch information
Showing
2 changed files
with
69 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,91 @@ | ||
Role Name | ||
========= | ||
Ansible Role: Default Web Browser | ||
================================= | ||
|
||
A brief description of the role goes here. | ||
[![Build Status](https://travis-ci.org/gantsign/ansible-role-default-web-browser.svg?branch=master)](https://travis-ci.org/gantsign/ansible-role-default-web-browser) | ||
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gantsign/ansible-role-default-web-browser/master/LICENSE) | ||
|
||
This role sets the default web browser for Ubuntu Unity and Xfce4. | ||
|
||
Requirements | ||
------------ | ||
|
||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. | ||
* Ansible >= 2.0 | ||
|
||
* Ubuntu | ||
|
||
* Trusty (14.04) | ||
* Wily (15.10) | ||
* Xenial (16.04) | ||
* Note: other Ubuntu versions are likely to work but have not been tested. | ||
|
||
* Supported desktop | ||
|
||
* Ubuntu Unity (i.e. the default desktop on Ubuntu) | ||
|
||
Note: other Gnome based desktops may work but have not been tested. | ||
|
||
* Xfce4 (i.e. the desktop on XUbuntu) | ||
|
||
Role Variables | ||
-------------- | ||
|
||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. | ||
|
||
Dependencies | ||
------------ | ||
The following variables will change the behavior of this role (default values | ||
are shown below): | ||
|
||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. | ||
```yaml | ||
# The web browser to make the default (i.e. the name of the .desktop file without the extension) | ||
default_web_browser: google-chrome | ||
``` | ||
|
||
Example Playbook | ||
---------------- | ||
|
||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: | ||
```yaml | ||
- hosts: servers | ||
roles: | ||
- role: gantsign.default-web-browser | ||
default_web_browser: google-chrome | ||
``` | ||
|
||
- hosts: servers | ||
roles: | ||
- { role: username.rolename, x: 42 } | ||
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/) | ||
|
||
To run the role (i.e. the `tests/test.yml` playbook), and test the results | ||
(`tests/test_role.py`), execute the following command from the project root | ||
(i.e. the directory with `molecule.yml` in it): | ||
|
||
```bash | ||
molecule test | ||
``` | ||
|
||
License | ||
------- | ||
|
||
BSD | ||
MIT | ||
|
||
Author Information | ||
------------------ | ||
|
||
An optional section for the role authors to include contact information, or a website (HTML is not allowed). | ||
John Freeman | ||
|
||
GantSign Ltd. | ||
Company No. 06109112 (registered in England) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
--- | ||
# The web browser to make the default (i.e. the name of the .desktop file) | ||
# The web browser to make the default (i.e. the name of the .desktop file without the extension) | ||
default_web_browser: google-chrome |