archipelagoandClaude Opus 5
cc00884b98
Untracking the ops docs broke every reference to them. Repoints or removes those references across README, architecture, ROADMAP, the archive index, lifecycle TESTING, the hardening plan, and the security docs — pointing at the issue tracker where a live task list was meant, and dropping the entry entirely where it only existed to link an internal file. Also fixes two pre-existing broken links found by validating every relative link in the tracked docs: - README linked docs/OPEN_SOURCE_READINESS.md, which never existed (underscores vs hyphens). - reticulum-daemon/README.md linked a local Claude session plan at ../../.claude/plans/enchanted-strolling-rocket.md — outside the repo, and a path that would have shipped publicly pointing at nothing. All relative links in tracked markdown now resolve: 0 broken. audit-secrets.sh still 5/5. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
110 lines
4.1 KiB
Markdown
110 lines
4.1 KiB
Markdown
# Archipelago
|
|
|
|
> Self-sovereign Bitcoin node OS and manifest-driven app platform.
|
|
|
|
Archipelago is a bootable personal server OS for Bitcoin infrastructure,
|
|
self-hosted apps, mesh communication, decentralized identity, and federation.
|
|
Apps are packaged as declarative `manifest.yml` files and run as rootless
|
|
Podman containers managed by the Rust backend.
|
|
|
|
[](https://www.debian.org/)
|
|
[](LICENSE)
|
|
[](https://www.rust-lang.org/)
|
|
[](https://vuejs.org/)
|
|
[]()
|
|
|
|
## What is here
|
|
|
|
- `core/` - Rust workspace: backend API, container runtime, security, OpenWrt
|
|
helpers, and performance/resource management.
|
|
- `neode-ui/` - Vue 3 + TypeScript frontend.
|
|
- `apps/` - app manifests and custom app container sources.
|
|
- `docker/` - supporting container build contexts for UI companion surfaces.
|
|
- `image-recipe/` - bootable image/ISO build inputs.
|
|
- `Android/` - Android companion app.
|
|
- `scripts/` - development, release, deployment, and validation tooling.
|
|
- `docs/` - architecture, app packaging, operations, API, and roadmap docs.
|
|
|
|
## Platform model
|
|
|
|
Archipelago is built as a developer-ready app platform, not a fixed appliance:
|
|
|
|
- Apps are declared in `apps/<app-id>/manifest.yml`.
|
|
- The Rust parser in `core/container/src/manifest.rs` is the canonical schema.
|
|
- The orchestrator compiles manifests to rootless Podman/Quadlet runtime state.
|
|
- App data lives under `/var/lib/archipelago/<app-id>/`.
|
|
- Secrets are generated or read from `/var/lib/archipelago/secrets/` and
|
|
injected through Podman secrets rather than static environment values.
|
|
- Release and app catalogs are signed and verified against a pinned trust
|
|
anchor.
|
|
|
|
Start with:
|
|
|
|
- [Architecture](docs/architecture.md)
|
|
- [Developer Guide](docs/developer-guide.md)
|
|
- [App Developer Guide](docs/app-developer-guide.md)
|
|
- [App Manifest Spec](docs/app-manifest-spec.md)
|
|
- [Nostr Git Source Hosting Plan](docs/nostr-git-source-hosting.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
|
|
## Quick start
|
|
|
|
### Frontend
|
|
|
|
```bash
|
|
cd neode-ui
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
The dev UI runs at `http://localhost:8100` with a mock backend on `:5959`.
|
|
|
|
### Backend
|
|
|
|
```bash
|
|
cd core
|
|
cargo build
|
|
cargo test --all-features
|
|
```
|
|
|
|
Linux is the supported backend runtime and release-build target. macOS is fine
|
|
for frontend work and many Rust compile/test loops, but host integration tests
|
|
that touch Podman, systemd, networking, or image build paths require Linux.
|
|
|
|
### App manifests
|
|
|
|
```bash
|
|
./scripts/validate-app-manifest.sh apps/filebrowser/manifest.yml
|
|
python3 scripts/generate-app-catalog.py
|
|
python3 scripts/check-app-catalog-drift.py --release --strict
|
|
```
|
|
|
|
`scripts/generate-app-catalog.py` requires Python with PyYAML installed.
|
|
|
|
## Documentation map
|
|
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [Architecture](docs/architecture.md) | System layers, crates, data paths, security model |
|
|
| [Developer Guide](docs/developer-guide.md) | Local setup, code workflow, testing |
|
|
| [API Reference](docs/api-reference.md) | JSON-RPC API overview |
|
|
| [App Developer Guide](docs/app-developer-guide.md) | How to package and test apps |
|
|
| [App Manifest Spec](docs/app-manifest-spec.md) | Manifest schema and validation rules |
|
|
| [Nostr Git Source Hosting Plan](docs/nostr-git-source-hosting.md) | ngit/NIP-34 contribution workflow and maintainer model |
|
|
| [Apps README](apps/README.md) | Packaged app catalog overview |
|
|
| [Image Recipe](image-recipe/README.md) | Bootable image build flow |
|
|
| [Roadmap](docs/ROADMAP.md) | Shipped, in-progress, and planned work |
|
|
| [Archive](docs/archive/) | Historical plans, audits, and handoffs |
|
|
|
|
## Contributing
|
|
|
|
Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. For
|
|
security issues, follow [SECURITY.md](SECURITY.md) and do not open a public
|
|
issue.
|
|
|
|
## License
|
|
|
|
Archipelago is licensed under the [MIT License](LICENSE). Third-party notices
|
|
are listed in [NOTICE](NOTICE) and generated license inventories in component
|
|
release artifacts.
|