docs: clarify instructions, improve project description

This commit is contained in:
Ivan R. 2024-04-08 21:05:17 +05:00
parent 4afd8d158e
commit b0ebe9af3c
Signed by: lumin
GPG key ID: E0937DC7CD6D3817

View file

@ -1,27 +1,40 @@
# 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
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.
## Inventory example
2. Create an inventory file.
Example:
```ini
; this group name is used in all playbooks.
[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.
Ansible allows you not only to initially configure the system,
but also to synchronize settings between several computers.
## Contributing
Bug fixes and improvements are welcome, please submit your pull requests.