Revise getting started guide for setup process

Updated setup instructions for clarity and added steps for installing git and generating secrets.
This commit is contained in:
Kelin
2026-01-12 18:52:19 -05:00
committed by GitHub
parent a1b78ef6d2
commit de1ac31274

View File

@@ -12,22 +12,34 @@ For most users, the automated setup script handles everything:
- **Internet connection** - **Internet connection**
- **VS Code with GitHub Copilot** (for AI assistance) - **VS Code with GitHub Copilot** (for AI assistance)
### One-Command Setup ### Simple Setup
1. **Connect to your server** via SSH 1. **Connect to your server** via SSH
2. **Run the setup script**: 2. **Install git if needed**
```bash
sudo apt update && sudo apt upgrade -y && sudo apt install git
4. **Run the setup script**:
```bash ```bash
git clone https://github.com/kelinfoxy/AI-Homelab.git git clone https://github.com/kelinfoxy/AI-Homelab.git
cd AI-Homelab cd AI-Homelab
sudo ./scripts/setup-homelab.sh sudo ./scripts/setup-homelab.sh
``` ```
3. **Log out and back in** (or run `newgrp docker`) 5. **Log out and back in** (or run `newgrp docker`)
4. **Configure environment**: 6. **Generate Authelia/Authentik Secrets
```bash
# TODO: provide instructions for generating required secrets
AUTHELIA_JWT_SECRET=your-jwt-secret-here-64-chars
AUTHELIA_SESSION_SECRET=your-session-secret-here-64-chars
AUTHELIA_STORAGE_ENCRYPTION_KEY=your-encryption-key-here-64-chars
AUTHENTIK_SECRET_KEY=your-authentik-secret-key-here-100-chars
8. **Configure environment**:
```bash ```bash
cp .env.example .env cp .env.example .env
nano .env # Edit with your settings nano .env # Edit with your settings
``` ```
5. **Deploy core services**: 9. **Deploy core services**:
```bash ```bash
./scripts/deploy-homelab.sh ./scripts/deploy-homelab.sh
``` ```