Update .gitignore and remove obsolete documentation files
- Added new entries to .gitignore for build artifacts and macOS output directories to streamline the build process. - Deleted outdated documentation files: AUTH_LOGIN_FIX.md, AUTBOOT_CONFIGURATION.md, BACKEND_FIXES.md, BACKEND_STARTUP_FIX.md, BITCOIN_CORE_HEADLESS_FIX.md, BITCOIN_CORE_UI_COMPLETE.md, BITCOIN_STANDALONE_UI_COMPLETE.md, BITCOIN_UI_COMPLETE.md, BOOT_SEQUENCE_DIAGRAM.txt, and BUILD_COMMANDS_REFERENCE.txt to declutter the repository and remove unnecessary content.
This commit is contained in:
+50
-18
@@ -1,46 +1,78 @@
|
||||
# Archipelago OS Image Recipes
|
||||
|
||||
Build scripts and profiles for creating bootable Alpine Linux OS images for Archipelago Bitcoin Node OS.
|
||||
Build scripts for creating bootable Debian Linux OS images for Archipelago Bitcoin Node OS.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### On macOS
|
||||
### Build the ISO
|
||||
|
||||
```bash
|
||||
./build-macos.sh
|
||||
./build-debian-iso.sh
|
||||
```
|
||||
|
||||
### On Linux
|
||||
This creates a bootable Debian Live ISO with Archipelago pre-installed.
|
||||
|
||||
### Write to USB
|
||||
|
||||
```bash
|
||||
./build-linux.sh
|
||||
# Using dd (recommended)
|
||||
./write-usb-dd.sh /dev/diskN
|
||||
|
||||
# Or use Balena Etcher to flash the ISO
|
||||
```
|
||||
|
||||
See [Building OS Images](../../docs/building-os-images.md) for detailed instructions.
|
||||
See the Architecture documentation for detailed system information.
|
||||
|
||||
## What's Included
|
||||
|
||||
- **Alpine Linux Base**: Minimal, secure Linux distribution
|
||||
- **Podman**: Container runtime for apps
|
||||
- **Debian Linux Base**: Stable Debian 12 (Bookworm) distribution
|
||||
- **Podman**: Container runtime for apps (rootless by default)
|
||||
- **Archipelago Backend**: Rust-based API server
|
||||
- **Archipelago Frontend**: Vue.js web interface
|
||||
- **Systemd Services**: Automatic service management
|
||||
- **Network Configuration**: Ready for network setup
|
||||
- **Network Configuration**: NetworkManager for easy setup
|
||||
|
||||
## Build Output
|
||||
|
||||
- `archipelago-{version}-x86_64.iso` - Bootable ISO image
|
||||
- `archipelago-{version}-x86_64.img` - Disk image for flashing
|
||||
- `results/archipelago-debian-12-x86_64.iso` - Bootable hybrid ISO image
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
- **x86_64**: Dell Optiplex, HP ProDesk 400 G4 DM, and other x86_64 desktops
|
||||
- **Build Systems**: macOS (via Docker) and Linux (native or Docker)
|
||||
- **x86_64**: Dell OptiPlex, HP ProDesk 400 G4 DM, Start9 Server Pure, and other x86_64 machines
|
||||
- **Build Systems**: macOS (requires Docker) and Linux (native or Docker)
|
||||
|
||||
## Legacy StartOS Build
|
||||
## Installation Methods
|
||||
|
||||
The original StartOS build scripts are still available:
|
||||
- `build.sh` - StartOS Debian-based image builder
|
||||
- `run-local-build.sh` - StartOS build helper
|
||||
### 1. Live USB Boot
|
||||
Boot from USB, run in live mode to test, or install to disk.
|
||||
|
||||
See [Building OS Images](../../docs/building-os-images.md) for Archipelago-specific builds.
|
||||
### 2. Full Disk Installation
|
||||
From the live environment, run:
|
||||
```bash
|
||||
sudo /archipelago/install-to-disk.sh
|
||||
```
|
||||
|
||||
This installs Archipelago to a target disk using debootstrap.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
image-recipe/
|
||||
├── build-debian-iso.sh # Main ISO builder
|
||||
├── write-usb-dd.sh # Write ISO to USB with dd
|
||||
├── create-fat32-usb.sh # Alternative USB creation
|
||||
├── archipelago-scripts/ # Scripts included in ISO
|
||||
│ ├── install-to-disk.sh # Disk installer
|
||||
│ └── setup-bitcoin.sh # Bitcoin Core setup
|
||||
├── scripts/ # Build helper scripts
|
||||
│ ├── build-backend.sh # Compile Rust backend
|
||||
│ ├── build-frontend.sh # Build Vue.js frontend
|
||||
│ └── check-dependencies.sh # Verify build requirements
|
||||
└── results/ # Built ISO output
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker (for macOS builds)
|
||||
- xorriso (for ISO creation): `brew install xorriso`
|
||||
- 7zip (for ISO extraction): `brew install p7zip`
|
||||
|
||||
Reference in New Issue
Block a user