mirror of
https://github.com/harivansh-afk/betterNAS.git
synced 2026-04-17 13:05:06 +00:00
move
This commit is contained in:
parent
23e0baa1ef
commit
93d610db29
4 changed files with 0 additions and 0 deletions
51
docs/repository-root/control.md
Normal file
51
docs/repository-root/control.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Control
|
||||
|
||||
This repo is the coordination and implementation ground for betterNAS.
|
||||
|
||||
Use it for:
|
||||
|
||||
- shared contracts
|
||||
- architecture and planning docs
|
||||
- runtime scripts
|
||||
- stack verification
|
||||
- implementation of the self-hosted stack
|
||||
|
||||
## Current product focus
|
||||
|
||||
The default betterNAS product is:
|
||||
|
||||
- self-hosted on the user's NAS
|
||||
- WebDAV-first
|
||||
- Finder-mountable
|
||||
- managed through a web control plane
|
||||
|
||||
The main parts are:
|
||||
|
||||
- `node-service`
|
||||
- `apps/node-agent`
|
||||
- `control-server`
|
||||
- `apps/control-plane`
|
||||
- `web control plane`
|
||||
- `apps/web`
|
||||
- `optional cloud adapter`
|
||||
- `apps/nextcloud-app`
|
||||
|
||||
## Rules
|
||||
|
||||
- shared interface changes land in `packages/contracts` first
|
||||
- `docs/architecture.md` is the canonical architecture contract
|
||||
- the self-hosted mount flow is the critical path
|
||||
- optional Nextcloud work must not drive the main architecture
|
||||
|
||||
## Command surface
|
||||
|
||||
- `pnpm verify`
|
||||
- static verification
|
||||
- `pnpm stack:up`
|
||||
- boot the self-hosted stack
|
||||
- `pnpm stack:verify`
|
||||
- verify the working stack
|
||||
- `pnpm stack:down --volumes`
|
||||
- tear the stack down cleanly
|
||||
- `pnpm agent:verify`
|
||||
- bootstrap, verify, boot, and stack-verify in one loop
|
||||
Loading…
Add table
Add a link
Reference in a new issue