diff options
| author | Craig Jennings <c@cjennings.net> | 2026-02-23 05:31:05 -0600 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-02-23 05:31:05 -0600 |
| commit | ff29361074e2908cd010627efdcf77ad69a1485d (patch) | |
| tree | 5f931cf0ec0e78a4ea6e2716e6108f19aae5c8f0 | |
| parent | a171caf0b0a5541246f994155406e840b28390de (diff) | |
| download | archangel-ff29361074e2908cd010627efdcf77ad69a1485d.tar.gz archangel-ff29361074e2908cd010627efdcf77ad69a1485d.zip | |
docs: update README.org for open-source release
- Fill in author field
- Add SSH security warning for live ISO known password
- Update project structure to match current files (add Makefile,
RESCUE-GUIDE.txt, test-configs/, full-test.sh, boot-vm.sh)
- Remove docs/ from project structure (gitignored)
| -rw-r--r-- | README.org | 16 |
1 files changed, 12 insertions, 4 deletions
@@ -1,5 +1,5 @@ #+TITLE: archangel - Arch Linux ZFS/Btrfs Installation ISO -#+AUTHOR: +#+AUTHOR: Craig Jennings #+OPTIONS: toc:3 * Overview @@ -99,6 +99,7 @@ sudo ./build.sh #+BEGIN_EXAMPLE archangel/ ├── build.sh # Main ISO build script +├── Makefile # Build, lint, test, and release targets ├── custom/ │ ├── archangel # Interactive installation script │ ├── archangel.conf.example # Example config for unattended install @@ -109,16 +110,19 @@ archangel/ │ │ ├── zfs.sh # ZFS-specific functions │ │ └── btrfs.sh # Btrfs-specific functions │ ├── zfssnapshot # ZFS snapshot utility -│ └── zfsrollback # ZFS rollback utility +│ ├── zfsrollback # ZFS rollback utility +│ └── RESCUE-GUIDE.txt # Recovery tools documentation ├── scripts/ │ ├── test-vm.sh # QEMU test VM launcher │ ├── test-install.sh # Automated install tests +│ ├── test-configs/ # Test configuration files +│ ├── full-test.sh # Comprehensive test suite │ ├── sanity-test.sh # Quick ISO verification +│ ├── boot-vm.sh # Boot VM from disk or ISO │ └── build-release # Build and distribute ISO ├── vm/ # VM disk images (created by test-vm.sh) ├── work/ # Build working directory -├── out/ # Built ISO output -└── docs/ # Documentation +└── out/ # Built ISO output #+END_EXAMPLE ** Script Descriptions @@ -151,6 +155,10 @@ This creates a 50GB virtual disk and boots the ISO. ** SSH Access to VM +*Security Warning*: The live ISO has SSH root login enabled with the password +~archangel~. This is intended for testing and headless installations only. +Do not expose the live environment to untrusted networks. + #+BEGIN_SRC bash # Password: archangel ssh -p 2222 root@localhost |