Skip to content

Latest commit

 

History

History
149 lines (120 loc) · 8.36 KB

README.md

File metadata and controls

149 lines (120 loc) · 8.36 KB
Raw

🖥️ Dotfiles and System Setup with Ansible

This repository contains my personal system configuration managed using Ansible. The configurations and dotfiles are designed specifically for Arch Linux and aim to provide a modular, automated setup for a consistent and efficient development environment.

📋 Table of Contents

✨ Features

  • Automated System Configuration: Configure tools like neovim, tmux, zsh, and more.
  • Symlinking Dotfiles: Dotfiles are symlinked rather than copied for easier updates.
  • Tag-Based Role Management: Organize roles for different environments using tags.
  • Customizable Execution with Extra Vars: Control the behavior of the playbook with the configure and update extra variables, allowing you to skip symlink creation or perform updates as needed.

⚙️ Prerequisites

  1. Operating System: Arch Linux or an Arch-based distro.
  2. Ansible Installed:
    Install Ansible with: 
    sudo pacman -S ansible

🚀 Installation

  1. Clone this repository:

    git clone https://github.com/vivalchemy/dotfiles.git
cd <repository-folder>

  2. Install the required Ansible collections:

    ansible-galaxy install -r requirements.yaml

  3. Edit the inventory file to include your local machine:

     this_pc:
   hosts:
     localhost

  4. Run the playbook:

    ansible-playbook main.yaml --ask-become-pass

    Note: Add --tags <tag-name> to limit roles to specific tags during execution.

🛠️ Available Roles

The following roles are included in the repository:

Role Activating Tags Description
alacritty always, alacritty, gui A modern terminal emulator that focuses on performance and simplicity.
applications always, applications, gui A collection of essential applications and tools for productivity and development.
bat always, bat, cli A modern alternative to cat that adds syntax highlighting and Git integration.
fastfetch always, fastfetch, cli A fast system information display tool designed to be lightweight and customizable.
git always, git, cli A distributed version control system designed to handle everything from small to very large projects.
hyprland always, hyprland, gui A dynamic tiling Wayland compositor, offering a customizable and efficient desktop environment.
keyd always, keyd, cli A tool to remap and customize keyboard keybindings, layouts, and macros.
lazygit always, lazygit, cli A simple terminal UI for Git that allows users to interact with repositories more efficiently.
mako always, mako, gui A lightweight and fast notification daemon for Wayland-based systems.
neovim always, neovim, cli A highly extensible and customizable text editor, often used for programming.
nodejs always, nodejs, cli A JavaScript runtime built on Chrome's V8 engine, used for building scalable applications.
rofi always, rofi, gui A window switcher and application launcher that is lightweight and highly customizable.
scripts always, scripts, cli, gui A set of personal shell scripts for automating various tasks and processes.
starship always, starship, cli A fast, customizable, and feature-rich prompt for any shell.
swayimg always, swayimg, gui Lightweight, fully customizable image viewer for Wayland. Supports various image formats, customizable keyboard bindings, gallery mode, and slideshow.
tmux always, tmux, cli A terminal multiplexer that allows users to manage multiple terminal sessions from a single window.
vivaldi always, vivaldi, gui A highly customizable web browser with advanced features for power users.
wallpapers always, wallpapers, gui A role to manage and symlink system wallpapers to predefined directories.
xfce4 always, xfce4, gui A lightweight and fast desktop environment for Unix-like operating systems.
yazi always, yazi, cli A tool for managing and syncing personal settings and configurations across systems.
zathura always, zathura, gui A lightweight, vim-like document viewer for PDF and other formats.
zellij always, zellij, cli A terminal workspace and multiplexer with a focus on usability and performance.
zen always, zen, gui A privacy-focused, customizable Firefox-based browser with advanced tab management and split views.
zsh always, zsh, cli A powerful shell that extends the capabilities of the traditional Bash shell.

Run specific tags with:

ansible-playbook main.yaml --ask-become-pass --tags "<comma-seperated-tag-names>"

Note:
When passing tags via the CLI (e.g., --tags), the specified tags have a union-like effect.
This means tasks or roles will be executed if they match any of the given tags. For example:

ansible-playbook main.yaml --tags "cli,gui"

In this case, all tasks associated with either the cli or gui tags will be executed.

🔌 Extra Arguments

You can pass additional arguments to customize the behavior of the Ansible playbook. The two main arguments are configure and update. These options allow you to control symlink creation and application updates during the execution of the playbook.

Arg Available Values Description
configure true (default), false true: Creates symlinks for config, data, etc., ensuring the application uses your specified configurations.
false: Skips creating symlinks, leaving existing configurations unchanged.
update true (default), false true: Updates the application/role to the latest version.
false: Skips the update process, keeping the current version as-is.

Usage Example

To run the playbook with custom arguments, use the following command:

ansible-playbook main.yaml --tags "cli" --extra-vars "configure=false update=true"

This command will run the playbook with the cli tag, skip symlink creation (by setting configure=false), and ensure that the applications are updated (by setting update=true).

✅ TODOs

  • Add zen userChrome.css configuration.
  • Add an extra args called debug to turn on debug mode
  • Install additional fonts.
  • Install remaining aur and non config packages via Ansible.

📝 Notes

  • Arch Linux Only: This configuration is tailored specifically for Arch Linux and may not work on other distros.
  • Modular Setup: You can customize the roles and tags based on your requirements.

🤝 Contributing

Feel free to submit issues or pull requests. Contributions are always welcome!

📜 License

This project is licensed under the MIT License.