29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
|
# AGENTS.md
|
||
|
|
|
||
|
|
## Repo Purpose
|
||
|
|
|
||
|
|
This repository contains small Proxmox LXC helper scripts.
|
||
|
|
|
||
|
|
- `ct/` contains host-side Proxmox creation entrypoints
|
||
|
|
- `install/` contains in-container install logic pushed into the created CT
|
||
|
|
|
||
|
|
## Working Rules
|
||
|
|
|
||
|
|
- Keep changes minimal and shell-first
|
||
|
|
- Prefer aligning host scripts with the `community-scripts` lifecycle when practical
|
||
|
|
- Preserve the documented legacy environment variables in `README.md` even when adding `var_*` support
|
||
|
|
- Use `apply_patch` for manual file edits
|
||
|
|
- Do not add extra tooling or framework files unless they directly support the scripts
|
||
|
|
|
||
|
|
## Script Expectations
|
||
|
|
|
||
|
|
- Host scripts should stay runnable with `bash ct/<name>.sh` on a Proxmox host
|
||
|
|
- In-container installers should stay runnable as root inside the CT
|
||
|
|
- Favor documented Proxmox long options like `--content` and `--perms`
|
||
|
|
- Any new runtime service should be enabled explicitly and remain configurable through environment variables
|
||
|
|
|
||
|
|
## Verification
|
||
|
|
|
||
|
|
- Run `bash -n` on changed shell scripts after edits
|
||
|
|
- Update `README.md` when user-facing behavior or environment variables change
|