docs: clarify instructions, improve project description
This commit is contained in:
parent
4afd8d158e
commit
b0ebe9af3c
1 changed files with 22 additions and 9 deletions
31
README.md
31
README.md
|
@ -1,27 +1,40 @@
|
||||||
# System from scratch
|
# System from scratch
|
||||||
|
|
||||||
A set of ansible scripts to configure my system.
|
Ansible playbooks for system configuration.
|
||||||
|
|
||||||
|
This repo contains Ansible playbooks for configuring a Debian Linux system from scratch.
|
||||||
|
It handles tasks like installing packages, configuring services, users, etc.
|
||||||
|
|
||||||
## Example
|
## Getting Started
|
||||||
|
|
||||||
|
1. Clone the repo.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ansible-playbook -i inventory.ini [--connection=local] [--ask-become] playbooks/ping.yml
|
git clone https://git.comfycamp.space/lumin/system-from-scratch.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that `inventory.ini` is not included in the repo.
|
2. Create an inventory file.
|
||||||
|
|
||||||
|
|
||||||
## Inventory example
|
|
||||||
|
|
||||||
|
Example:
|
||||||
```ini
|
```ini
|
||||||
|
; this group name is used in all playbooks.
|
||||||
[odhosts]
|
[odhosts]
|
||||||
192.168.0.1
|
localhost ansible_connection=local
|
||||||
|
192.0.2.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
3. Run a playbook.
|
||||||
|
|
||||||
## Why is this repository public?
|
```bash
|
||||||
|
ansible-playbook -i inventory.ini [--ask-become] playbooks/ping.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
This repository can serve as a source of inspiration.
|
This repository can serve as a source of inspiration.
|
||||||
Ansible allows you not only to initially configure the system,
|
Ansible allows you not only to initially configure the system,
|
||||||
but also to synchronize settings between several computers.
|
but also to synchronize settings between several computers.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Bug fixes and improvements are welcome, please submit your pull requests.
|
||||||
|
|
Loading…
Reference in a new issue