docs: add initial repo cloning documentation
This commit is contained in:
12
README.md
12
README.md
@@ -6,6 +6,7 @@ RailianceHosts is an open-source control repo that provisions and manages server
|
||||
|
||||
## Quickstart
|
||||
|
||||
0. **Clone**: clone the repo
|
||||
1. **Install**: terraform >= 1.7, ansible >= 2.16, age, sops.
|
||||
2. **Generate master key (age)** and put the **private key** in your password manager. Save the **public key** to `keys/age.pub`.
|
||||
3. **Create Hetzner Project** + API token and store it (encrypted) in `inventory/group_vars/secrets.sops.yaml` under `ops.hcloud_token`.
|
||||
@@ -17,6 +18,17 @@ RailianceHosts is an open-source control repo that provisions and manages server
|
||||
|
||||
See inline comments across the repo for details. Remember to **encrypt secrets** with SOPS before committing.
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
First, clone this repository to your workstation:
|
||||
|
||||
```bash
|
||||
git clone https://<your-gitea-host>/coulomb/railliance-hosts.git
|
||||
cd railiance-hosts
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 🔑 Secrets Management
|
||||
|
||||
This project uses [SOPS](https://github.com/getsops/sops) with [age](https://age-encryption.org) for secret encryption.
|
||||
|
||||
Reference in New Issue
Block a user