8233304ee2
<message>Enhance the README files to provide clearer instructions for deploying the CM4 eMMC provisioning service on Proxmox, including detailed prerequisites and deployment steps. Update the .gitignore to exclude deploy logs generated during the deployment process, ensuring a cleaner repository. Additionally, refine archived documentation for better historical context and clarity on the active provisioning workflow.
29 lines
1.7 KiB
Markdown
29 lines
1.7 KiB
Markdown
<!-- Revision: 2 -->
|
|
# reTerminal DM4
|
|
|
|
Project for **reTerminal DM4** (Seeed) with CM4: Chromium kiosk, eMMC provisioning (USB + network boot), and first-boot configuration via cloud-init.
|
|
|
|
## Revisions
|
|
|
|
A single **revision number** is kept in `REVISION` and in a comment line in tracked files (`# Revision: N` or `<!-- Revision: N -->`) so you can see what changed across hosts and deploys.
|
|
|
|
- **Bump revision (update all files):** from repo root run
|
|
`./emmc-provisioning/scripts/bump-revision.sh`
|
|
- **Auto-bump on every commit:** install the pre-commit hook
|
|
`cp emmc-provisioning/scripts/pre-commit-revision.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit`
|
|
Then every commit will bump the revision and update the revision line in all tracked files.
|
|
|
|
## Repository structure
|
|
|
|
| Path | Purpose |
|
|
|------|---------|
|
|
| **emmc-provisioning/** | **Main workflow:** eMMC deploy/backup, cloud-init first-boot, Chromium kiosk assets, file server, dashboard, network boot. See [emmc-provisioning/README.md](emmc-provisioning/README.md). |
|
|
| **archive/** | Legacy or unused files (guides, old scripts). Not used for deployment. See [archive/README.md](archive/README.md). |
|
|
|
|
## Quick start
|
|
|
|
1. **New deployment:** Follow **[emmc-provisioning/docs/DEPLOY-NEW-PROXMOX.md](emmc-provisioning/docs/DEPLOY-NEW-PROXMOX.md)** for step-by-step instructions (Proxmox host prep → LXC deploy → network boot → portal files).
|
|
2. **Sync first-boot assets** to the file server after deploy:
|
|
`./emmc-provisioning/scripts/sync-portal-files-to-lxc.sh root@<LXC-IP>`
|
|
3. Provision devices via USB boot or network boot; first-boot configures the Chromium kiosk, labwc Wayland desktop, screen rotation, wallpaper, dark theme, and CM4 boot order.
|