From d4b6eb73a5a6ae326bd089f863bb5ef9215f65a9 Mon Sep 17 00:00:00 2001 From: marmattheo Date: Sat, 14 Jun 2025 15:59:10 +0800 Subject: [PATCH] readability --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6c76050..4892d90 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,14 @@ This playbook automates the installation and setup of the **stable** version of ## How to Run 1. **Setup:** Clone the repository and go to the project directory ```bash - git clone https://git.marmattheo.com/marmattheo/incus-stable-playbook.git && cd incus-stable-playbook + git clone https://git.marmattheo.com/marmattheo/LXC-Incus-stable-playbook.git incus-stable-playbook && cd incus-stable-playbook ``` -1. **Customize Variables (Optional):** Open `playbook.yml` and review the `vars` section. - 2. **Execute the Playbook:** Run the following command from the same directory as the playbook file. It will prompt you for your `sudo` password to perform the administrative tasks. ```bash - ansible-playbook playbook.yml --ask-become-pass + ansible-playbook playbook.yml -i inventory.ini --ask-become-pass ``` * `--ask-become-pass`: This flag tells Ansible to prompt for the password needed for privilege escalation (`sudo`). @@ -58,8 +56,9 @@ After the playbook completes successfully: You can test the installation by running. ```bash - incus list + incus --version ``` + > This should return incus current version i.e., '6.13' 4. **Access the Incus Web UI:** @@ -72,9 +71,11 @@ After the playbook completes successfully: Then, access the Web UI at: ```bash - https://localhost:8443 or https://vps-ip:8443 + https://localhost:8443 ``` - > Follow the self-signed certificate instructions when prompted. + > If you're using a remote server use ipv4/ipv6 instead: https://vps-ip:8443 + + > Follow the self-signed certificate instructions when prompted to start using Incus. 5. **Configure Firewall using ufw (Optional):** @@ -96,9 +97,10 @@ After the playbook completes successfully: Configuring name-to-IP resolution so the host OS can reach Incus containers using their names. ```bash - ansible-playbook incus-network.yml --ask-become-pass + ansible-playbook incus-network.yml -i inventory.ini --ask-become-pass ``` > After this you should be able to reach your containers via their names or with the domain .incus + > i.e., `sudo ping container_name`, `sudo ping container_name.incus` on terminal or `http://container_name.incus` inside an nginx config