From ecb13d6f6f4c2402efffd7de7035be18145cb294 Mon Sep 17 00:00:00 2001 From: Patrick Fraley Date: Sun, 28 Dec 2025 11:16:29 +0100 Subject: [PATCH] Modified README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 77f321a..953ee0a 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,46 @@ Comprehensive Ansible configuration for managing Fedora Workstation laptops. This repository provides automated configuration management for system setup, package management, security hardening, and laptop-specific optimizations. +## Running the Playbook + +### Basic Usage + +Run the main playbook against localhost: + +```bash +ansible-playbook -i inventory/hosts playbook.yml --ask-become-pass +``` + +The `--ask-become-pass` flag will prompt you for your sudo password, which is needed for most system configuration tasks. + +### Useful Variations + +**Dry run first** (see what would change without making changes): +```bash +ansible-playbook -i inventory/hosts playbook.yml --check --diff +``` + +**Check syntax** before running: +```bash +ansible-playbook playbook.yml --syntax-check +``` + +**Run only specific tags**: +```bash +ansible-playbook -i inventory/hosts playbook.yml --tags "packages" --ask-become-pass +``` + +**List all tasks** that would be executed: +```bash +ansible-playbook -i inventory/hosts playbook.yml --list-tasks +``` + +**Run against specific host**: +```bash +ansible-playbook -i inventory/hosts playbook.yml --limit hostname --ask-become-pass +``` + +### Recommendation + +It's recommended to start with `--check --diff` to preview changes before actually applying them to your system. +