Update README and configuration for macOS support
- Revamped README.md to enhance clarity and detail on features, installation, and system requirements for Archipelago. - Added macOS-specific configuration in `config.rs` to detect when running from a macOS app bundle, adjusting data directory paths accordingly. - Introduced a new production build script in `package.json` for optimized deployment of the Neode UI.
This commit is contained in:
Dorian
+152
@@ -0,0 +1,152 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to Archipelago will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.1.0] - 2026-01-28
|
||||
|
||||
### 🎉 Initial Release
|
||||
|
||||
The first production release of Archipelago - a next-generation Bitcoin Node OS for macOS.
|
||||
|
||||
### Added
|
||||
|
||||
#### Core Features
|
||||
- **Native Rust Backend** - High-performance async server using Tokio and Hyper
|
||||
- **Modern Vue.js Frontend** - Beautiful glassmorphism UI with Tailwind CSS
|
||||
- **Docker Integration** - Seamless container orchestration via Docker Desktop
|
||||
- **Real-time WebSocket** - Live updates for container status and system events
|
||||
- **Authentication System** - Secure user login and session management
|
||||
|
||||
#### Bitcoin & Lightning
|
||||
- **Bitcoin Core** - Full node in regtest mode with custom UI
|
||||
- **LND** - Lightning Network Daemon with dedicated interface
|
||||
- **BTCPay Server** - Bitcoin payment processing
|
||||
- **Mempool Explorer** - Blockchain visualization and analytics
|
||||
|
||||
#### Applications
|
||||
- **Penpot** - Open-source design and prototyping platform
|
||||
- **Endurain** - Self-hosted fitness tracking
|
||||
- **Morphos** - File conversion utility
|
||||
- **Nextcloud** - Cloud storage and file management
|
||||
- **Home Assistant** - Home automation hub
|
||||
- **Grafana** - Metrics and monitoring dashboards
|
||||
- **OnlyOffice** - Document editing suite
|
||||
- **SearXNG** - Privacy-respecting search engine
|
||||
- **Fedimint** - Federated e-cash system
|
||||
|
||||
#### User Interface
|
||||
- **Onboarding Flow** - Guided setup for new users
|
||||
- **Dashboard** - Real-time system overview
|
||||
- **My Apps** - Alphabetically sorted app management
|
||||
- **Cloud Interface** - File management by type (Documents, Photos, Videos, Music)
|
||||
- **Web5 Explorer** - Decentralized identity and data management
|
||||
- **Settings** - System configuration and preferences
|
||||
- **Custom Launch Pages** - Dedicated UIs for Bitcoin Core and LND
|
||||
|
||||
#### Technical Features
|
||||
- **Container Runtime Abstraction** - Support for Docker and Podman
|
||||
- **Dynamic Package Discovery** - Automatic detection of running containers
|
||||
- **Health Monitoring** - Container status and health checks
|
||||
- **Data Persistence** - Docker volumes for app data
|
||||
- **Network Isolation** - Secure container networking
|
||||
- **Resource Management** - CPU and memory allocation
|
||||
|
||||
### Architecture
|
||||
|
||||
- **Backend**: Rust + Tokio + Hyper + WebSocket
|
||||
- **Frontend**: Vue 3 + TypeScript + Vite + Pinia
|
||||
- **Styling**: Tailwind CSS + Custom Glassmorphism
|
||||
- **Containers**: Docker Compose + Dockerode API
|
||||
- **Build System**: Cargo + npm + macOS App Bundle
|
||||
|
||||
### Known Limitations
|
||||
|
||||
- Requires Docker Desktop (23.0+)
|
||||
- macOS only (Intel and Apple Silicon)
|
||||
- Single-user mode
|
||||
- No auto-updates (manual download required)
|
||||
- Ollama excluded due to image size
|
||||
- Manual Docker container management
|
||||
|
||||
### System Requirements
|
||||
|
||||
- macOS 10.15 (Catalina) or later
|
||||
- 8GB RAM minimum (16GB recommended)
|
||||
- 20GB free disk space (50GB+ for blockchain data)
|
||||
- Docker Desktop 23.0 or later
|
||||
- Internet connection for initial container downloads
|
||||
|
||||
### Installation
|
||||
|
||||
1. Download `Archipelago-0.1.0-macOS.dmg`
|
||||
2. Open the DMG and drag Archipelago to Applications
|
||||
3. Install Docker Desktop if not already installed
|
||||
4. Launch Archipelago from Applications
|
||||
5. Access the UI at http://localhost:8100
|
||||
|
||||
### Security
|
||||
|
||||
- **Code Signed**: Yes (Developer ID)
|
||||
- **Notarized**: Yes (Apple notarization)
|
||||
- **Sandboxed**: No (requires full disk access for Docker)
|
||||
- **Hardened Runtime**: Yes
|
||||
- **Gatekeeper**: Compatible
|
||||
|
||||
### Documentation
|
||||
|
||||
- README.md - Project overview
|
||||
- BUILD_MACOS.md - Build instructions
|
||||
- DEPLOYMENT_CHECKLIST.md - Release process
|
||||
- docs/ - Detailed documentation
|
||||
|
||||
### Credits
|
||||
|
||||
Built with:
|
||||
- Rust (backend)
|
||||
- Vue.js (frontend)
|
||||
- Docker (containers)
|
||||
- Alpine Linux (inspiration)
|
||||
- Parmanode (Bitcoin scripts)
|
||||
- And many open-source dependencies
|
||||
|
||||
### License
|
||||
|
||||
[Specify your license here]
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
### 0.1.0 - 2026-01-28
|
||||
Initial public release
|
||||
|
||||
---
|
||||
|
||||
## Future Roadmap
|
||||
|
||||
See GitHub Issues for planned features:
|
||||
- [ ] Auto-update system
|
||||
- [ ] Multi-user support
|
||||
- [ ] Native container runtime (no Docker Desktop)
|
||||
- [ ] iOS companion app
|
||||
- [ ] Hardware wallet integration
|
||||
- [ ] Tor integration
|
||||
- [ ] VPN/Tailscale support
|
||||
- [ ] Backup/restore functionality
|
||||
- [ ] Mac App Store distribution
|
||||
- [ ] Windows and Linux builds
|
||||
|
||||
## Contributing
|
||||
|
||||
See CONTRIBUTING.md for development setup and guidelines.
|
||||
|
||||
## Support
|
||||
|
||||
- GitHub Issues: Report bugs and request features
|
||||
- Documentation: See `/docs` directory
|
||||
- Community: [Discord/Telegram/Forum link]
|
||||
Reference in New Issue
Block a user