46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
# Server Reference — Claude Instructions
|
|
|
|
This directory is living documentation for a two-server home infrastructure. Your job is to keep it accurate as things change.
|
|
|
|
## The Servers
|
|
|
|
- **Homelab** — Primary server. SSH hostname: `homelab`. Dockhand API: `?env=1`
|
|
- **Raspberry Pi** — Secondary server. SSH hostname: `raspi`. Dockhand API: `?env=2`
|
|
|
|
## How to Pull Data
|
|
|
|
Read `AI-UPDATE-INSTRUCTIONS.md` in this directory. It has every API endpoint, SSH command, and a step-by-step update checklist. Always start there.
|
|
|
|
## Ground Rules
|
|
|
|
- **Read before you write.** Always read the relevant doc file before comparing it to live data. Never overwrite blindly.
|
|
- **Credentials live in `credentials.gpg`** — AES256 GPG symmetric. Do not write credentials in plaintext anywhere in this directory.
|
|
- **Compose files contain redacted secrets** — use `<redacted>` as a placeholder for any passwords, tokens, or keys in compose blocks.
|
|
- **This is a personal vault** — be direct, no fluff. Documentation should be useful to a new admin, not padded.
|
|
|
|
## File Structure
|
|
|
|
```
|
|
21-Server Reference/
|
|
├── CLAUDE.md ← You are here
|
|
├── README.md ← Root index
|
|
├── AI-UPDATE-INSTRUCTIONS.md ← How to pull data and update docs
|
|
├── credentials.gpg ← Encrypted credentials
|
|
├── homelab/ ← Primary server docs
|
|
│ ├── README.md
|
|
│ ├── hardware.md
|
|
│ ├── network.md
|
|
│ ├── environments.md
|
|
│ └── stacks/ ← One file per Docker stack
|
|
└── pihole/ ← Raspberry Pi docs
|
|
├── README.md
|
|
└── stacks/
|
|
```
|
|
|
|
## When Asked to Update
|
|
|
|
1. Read `AI-UPDATE-INSTRUCTIONS.md`
|
|
2. Read the existing doc files that are relevant
|
|
3. Pull live data from Dockhand API (or SSH if needed)
|
|
4. Update only what changed — don't rewrite sections that are still accurate
|