Files
archy/README.md
2026-01-24 22:59:20 +00:00

2.5 KiB

Archipelago Bitcoin Node OS

Next-generation Bitcoin Node OS built on Alpine Linux with Podman containerization.

Quick Start

Development Setup

  1. Run setup script (optional):

    ./scripts/dev-setup.sh
    
  2. Start development servers:

    Quick start (mock backend for UI development):

    ./scripts/dev.sh
    

    Or use the interactive starter:

    ./scripts/dev-start.sh
    

    Or manually:

    # Terminal 1: Backend
    cd /Users/tx1138/Code/Archipelago/core
    cargo run --bin startbox
    
    # Terminal 2: Frontend
    cd /Users/tx1138/Code/Archipelago/neode-ui
    npm run dev
    
  3. Open in browser:

Mock Backend (UI Development Only)

For frontend-only development:

cd /Users/tx1138/Code/Archipelago/neode-ui
npm run dev:mock

Project Structure

Archipelago/
├── core/                    # Rust backend
│   ├── container/          # Container orchestration (NEW)
│   ├── parmanode/          # Parmanode compatibility (NEW)
│   ├── security/           # Security modules (NEW)
│   ├── performance/        # Performance optimization (NEW)
│   └── startos/            # Main backend (in Code/Archipelago)
├── neode-ui/               # Vue.js frontend (in Code/Archipelago)
├── apps/                   # App manifests (NEW)
├── image-recipe/           # Alpine Linux build files
├── scripts/                # Development and build scripts
└── docs/                   # Documentation

Development

See Development Setup Guide for detailed instructions.

Architecture

See Architecture Documentation for system design details.

App Manifests

See App Manifest Specification for creating containerized apps.

Features

  • 🐧 Alpine Linux Base - Minimal 130MB OS
  • 🐳 Podman Containers - Rootless, secure containerization
  • 🔒 Security Hardened - AppArmor, secrets management, image verification
  • High Performance - Resource management, optimization
  • 🔌 Parmanode Compatible - Run existing Parmanode modules
  • 📱 Modern UI - Vue.js 3 with TypeScript
  • 🌐 Web5 & Nostr - Decentralized protocols support
  • 📡 Mesh Networking - Meshtastic and router support

Requirements

  • Rust (latest stable)
  • Node.js 18+
  • Podman (for containers)
  • PostgreSQL (for backend)

License

MIT