mirror of
https://github.com/harivansh-afk/betterNAS.git
synced 2026-04-15 06:04:40 +00:00
update docs
This commit is contained in:
parent
c5be520772
commit
5bc24fa99d
11 changed files with 591 additions and 632 deletions
|
|
@ -1,69 +1,71 @@
|
|||
# betterNAS Part 4: Cloud / Web Layer
|
||||
# betterNAS Part 4: Web Control Plane and Optional Cloud Layer
|
||||
|
||||
This document describes the optional browser, mobile, and cloud-drive style access layer.
|
||||
This document describes the browser UI that users interact with, plus the
|
||||
optional cloud adapter layer that may exist later.
|
||||
|
||||
## What it is
|
||||
|
||||
The cloud/web layer is the part of betterNAS that makes storage accessible beyond local mounts.
|
||||
The web control plane is part of the core product.
|
||||
|
||||
This is where we can reuse Nextcloud heavily for:
|
||||
It should provide:
|
||||
|
||||
- browser file UI
|
||||
- uploads and downloads
|
||||
- sharing links
|
||||
- WebDAV-based cloud access
|
||||
- mobile reference behavior
|
||||
- onboarding
|
||||
- node and export management
|
||||
- mount instructions
|
||||
- sharing and browser file access later
|
||||
|
||||
An optional cloud adapter may later provide:
|
||||
|
||||
- Nextcloud-backed browser file UI
|
||||
- mobile-friendly access
|
||||
- share and link workflows
|
||||
|
||||
## What it does
|
||||
|
||||
- gives users a browser-based file experience
|
||||
- supports sharing and link-based access
|
||||
- gives us a cloud mode in addition to mount mode
|
||||
- can act as a reference surface while the main betterNAS product grows
|
||||
- gives users a browser-based entry point into betterNAS
|
||||
- talks only to `control-server`
|
||||
- exposes the mount flow cleanly
|
||||
- optionally layers on cloud/mobile/share behavior later
|
||||
|
||||
## What it should not do
|
||||
|
||||
- own the product system of record
|
||||
- become the only way users access storage
|
||||
- swallow control-plane logic that should stay in betterNAS
|
||||
- own product state separately from `control-server`
|
||||
- become the only way users access their storage
|
||||
- make the optional cloud adapter part of the core mount path
|
||||
|
||||
## Diagram
|
||||
|
||||
```text
|
||||
betterNAS system
|
||||
self-hosted betterNAS stack
|
||||
|
||||
NAS node <---------> control plane <---------> local device
|
||||
| | |
|
||||
| | |
|
||||
+---------------------------+-----------------------+-----------+
|
||||
|
|
||||
v
|
||||
+----------------------+
|
||||
| [THIS DOC] cloud/web |
|
||||
|----------------------|
|
||||
| Nextcloud adapter |
|
||||
| browser UI |
|
||||
| sharing / mobile |
|
||||
+----------------------+
|
||||
node-service <--------> control-server <--------> [THIS DOC] web control plane
|
||||
^ |
|
||||
| |
|
||||
+----------- Finder mount flow -+
|
||||
|
||||
optional later:
|
||||
Nextcloud adapter / cloud/mobile/share surface
|
||||
```
|
||||
|
||||
## Core decisions
|
||||
|
||||
- The cloud/web layer is optional but very high leverage.
|
||||
- Nextcloud is a strong fit here because it already gives us file UI and sharing primitives.
|
||||
- It should sit beside mount mode, not replace it.
|
||||
- The web control plane is part of the core product now.
|
||||
- Nextcloud is optional and secondary.
|
||||
- The first user value is managing exports and getting a mount URL, not a full
|
||||
browser file manager.
|
||||
|
||||
## Likely role of Nextcloud
|
||||
## Likely near-term role of the web control plane
|
||||
|
||||
- browser-based file UI
|
||||
- share and link management
|
||||
- optional mobile and cloud-drive style access
|
||||
- adapter over the same storage exports the control plane knows about
|
||||
- sign in
|
||||
- see available NAS nodes
|
||||
- see available exports
|
||||
- request mount instructions
|
||||
- copy or launch the WebDAV mount flow
|
||||
|
||||
## TODO
|
||||
|
||||
- Decide whether Nextcloud is directly user-facing in v1 or mostly an adapter behind betterNAS.
|
||||
- Define how storage exports from the NAS node appear in the cloud/web layer.
|
||||
- Define how shares in this layer map back to control-plane access grants.
|
||||
- Define what mobile access looks like in v1.
|
||||
- Define branding and how much of the cloud/web layer stays stock vs customized.
|
||||
- Define the first user-facing screens for nodes, exports, and mount actions.
|
||||
- Define how auth/session works in the web UI.
|
||||
- Decide whether browser file viewing is part of V1 or follows later.
|
||||
- Decide whether Nextcloud remains an internal adapter or becomes user-facing.
|
||||
- Define what sharing means before adding any cloud/mobile layer.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue