Skip to content

Commit

Permalink
docs readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
voidquark committed Sep 24, 2023
1 parent 016ed6c commit bdbcf5e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Flags:
The inventory configuration for Voidify is inspired by Ansible YAML inventory structure but simplified for ease of use. It consists of two main sections: `Environment` and `hosts`.

- `Environment`: Represents different environments, such as `production` and `development`, where your hosts are grouped.
- `hosts`: Defines individual hosts with user-friendly names, like `mariadb`, which make it easy to identify where you want to connect.
- `hosts`: Defines individual hosts with user-friendly names (alias), like `mariadb`, which make it easy to identify where you want to connect.

Inside each `host`, you need to specify `key: value` pairs, where `key` corresponds to a supported SSH config parameter. Ensure that the `key` is written exactly as it appears in a typical SSH config file. The `value` field holds the value for that key.

Expand Down Expand Up @@ -119,7 +119,7 @@ Host grafana
IdentitiesOnly Yes
```

## Instalation
## Installation

Voidify is designed for installation on your workstation, to be executed via your terminal application.

Expand Down Expand Up @@ -152,6 +152,7 @@ git clone https://github.com/voidquark/voidify

**Step 2: Download modules to local cache**
```shell
cd voidify
go mod download
```

Expand Down

0 comments on commit bdbcf5e

Please sign in to comment.