-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.yaml
81 lines (73 loc) · 2.3 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Ansible Role Nginx
# License of this project
license: "MIT"
# Canonical GitHub repo
github_repo: clouddrove/ansible-role-nginx
# Badges to display
badges:
- name: "Ansible"
image: "https://img.shields.io/badge/Ansible-2.9-green?style=flat&logo=ansible"
url: "https://www.ansible.com"
- name: "Licence"
image: "https://img.shields.io/badge/License-MIT-blue.svg"
url: "LICENSE.md"
- name: "Distribution"
image: "https://img.shields.io/badge/ubuntu-18.x-orange?style=flat&logo=ubuntu"
url: "https://ubuntu.com/"
- name: "Distribution"
image: "https://img.shields.io/badge/ubuntu-20.x-orange?style=flat&logo=ubuntu"
url: "https://ubuntu.com/"
- name: "Distribution"
image: "https://img.shields.io/badge/centos-7.x-orange"
url: "https://www.centos.org/"
- name: "Distribution"
image: "https://img.shields.io/badge/CentOS-8-green?style=flat&logo=centos"
url: "https://www.centos.org/"
- name: "Distribution"
image: "https://img.shields.io/badge/Amazon_linux-2-yellow?style=flat&logo=linux"
url: "https://aws.amazon.com/amazon-linux-ami/"
- name: "Actions"
image: "https://github.com/clouddrove/ansible-role-nginx/actions/workflows/lint.yml/badge.svg"
url: "https://github.com/clouddrove/ansible-role-nginx/actions/workflows/lint.yml"
# Prerequesties to display
# yamllint disable
prerequesties:
- name: "Ansible2.9"
url: "https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html"
- name: "Python"
url: "https://www.python.org/downloads"
# yamllint enable
# What Includes to display
what_includes:
- name: "nginx"
# description of this project
description: |-
This ansible role is used to install Nginx Server on linux.
# How to use this project
usage: |-
```yaml
- hosts: localhost
remote_user: root
roles:
- clouddrove.ansible_role_nginx
```
# Variables use in the project
variables: |-
```yaml
state: present
nginx_user: nginx
nginx_group: nginx
nginx_config_dir: /etc/nginx
nginx_log_path: /var/log/nginx
```
# How to install project
installation: |-
```console
$ ansible-galaxy install clouddrove.ansible_role_nginx
```