Skip to content

Commit fefb78e

Browse files
committed
docs: add documentation for ansible boilerplate
1 parent cf2b5c8 commit fefb78e

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
https://chatgpt.com/c/66ed8251-8394-8002-9b4a-029f4255770c
1+
# Ansible Boilerplate
2+
A production-ready Ansible boilerplate for automated server provisioning
3+
4+
## Clone the repository
5+
6+
```bash
7+
git clone https://github.com/code4mk/ansible-boilerplate.git
8+
```
9+
10+
## Setup environment variables
11+
12+
```bash
13+
cp .env.example .env
14+
```
15+
16+
## Usage
17+
18+
```bash
19+
./deploy.sh <playbook_name> [additional_vars]
20+
```
21+
22+
## List available playbooks
23+
24+
```bash
25+
./deploy.sh
26+
```
27+
28+
## folder structure
29+
```bash
30+
.
31+
├── credentials/
32+
│ └── README.md
33+
├── hosts/
34+
│ └── inventory.ini
35+
├── playbook/
36+
│ ├── docker-playbook.yml
37+
│ └── nginx-playbook.yml
38+
├── roles/
39+
│ ├── docker/
40+
│ └── nginx/
41+
├── .env
42+
├── .gitignore
43+
├── README.md
44+
├── ansible.cfg
45+
└── deploy.sh
46+
```
47+
48+
## docs
49+
* [credentials management](credentials/README.md)

0 commit comments

Comments
 (0)