# legspcpd/openlist-next architecture

> Architecture diagram of the GitHub repository legspcpd/openlist-next, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/legspcpd/openlist-next
- Repository: https://github.com/legspcpd/openlist-next

## Overview

OpenList Next aggregates files from cloud drives, object stores, and file protocols into a unified browser and API. The main request path enters the edge-compatible backend, is routed to filesystem operations, resolves a configured storage driver, and reads or changes files; raw endpoints handle content delivery. Supporting branches include authentication and sharing, persistence configuration, and WebDAV/S3/MCP exposure. The README documents these capabilities; source excerpts confirm the main router, storage, and persistence links. Several feature handlers and driver implementations were not sampled, so their internal connections are not expanded.

Main entry points: [`src/backend/server/router.ts`](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/router.ts) (API router), [`src/backend/internal/op/storage.ts`](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/op/storage.ts) (Storage operations), [`src/backend/index.ts`](https://github.com/legspcpd/openlist-next/blob/main/src/backend/index.ts) (Backend entry), [`src/backend/server/raw.ts`](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/raw.ts) (Raw transfer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_request["Request handling"]
  node_backend["Backend entry<br/>[index.ts]"]
  node_router["API router<br/>[router.ts]"]
  node_filesystem["Filesystem API<br/>[fs.ts]"]
  node_raw["Raw transfer<br/>[raw.ts]"]
end

subgraph group_storage["Storage aggregation"]
  node_storageops["Storage operations<br/>[storage.ts]"]
  node_driverbase["Driver interface<br/>[base.ts]"]
  node_drivers["Storage drivers"]
  node_database[("OpenList data<br/>[db.ts]")]
  node_storefactory["Store backend<br/>[backend.ts]"]
  node_crypto["Credential encryption<br/>[crypto.ts]"]
end

subgraph group_identity["Identity and sharing"]
  node_auth["Authentication<br/>[auth.ts]"]
  node_middleware["Request middleware<br/>[middlewares.ts]"]
  node_sharing["Sharing and search<br/>[share.ts]"]
end

subgraph group_interfaces["External interfaces"]
  node_webdav["WebDAV interface<br/>[webdav.ts]"]
  node_s3api["S3 interface<br/>[s3.ts]"]
  node_mcp["MCP endpoint<br/>[mcp.ts]"]
end

node_user(("User"))
node_externalstore[("Platform or external DB")]
node_client(("External clients"))

node_user -->|"sends request"| node_backend
node_backend -->|"mounts API"| node_router
node_backend -->|"mounts routes"| node_raw
node_router -->|"routes to"| node_filesystem
node_filesystem -.->|"uses drivers"| node_storageops
node_raw -->|"resolves driver"| node_storageops
node_storageops -->|"loads config"| node_database
node_storageops -->|"returns driver"| node_driverbase
node_drivers -->|"implements interface"| node_driverbase
node_database -->|"loads and saves"| node_storefactory
node_storefactory -->|"persists data"| node_externalstore
node_database -->|"encrypts secrets"| node_crypto
node_router -->|"registers routes"| node_auth
node_router -->|"registers middleware"| node_middleware
node_raw -->|"resolves share"| node_sharing
node_router -->|"mounts protocol"| node_webdav
node_router -->|"mounts protocol"| node_s3api
node_router -->|"registers endpoint"| node_mcp
node_client -->|"accesses files"| node_webdav
node_client -->|"accesses files"| node_s3api
node_client -->|"calls tools"| node_mcp

click node_backend "https://github.com/legspcpd/openlist-next/blob/main/src/backend/index.ts"
click node_router "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/router.ts"
click node_filesystem "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/fs.ts"
click node_raw "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/raw.ts"
click node_storageops "https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/op/storage.ts"
click node_driverbase "https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/driver/base.ts"
click node_drivers "https://github.com/legspcpd/openlist-next/tree/main/src/backend/drivers"
click node_database "https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/model/db.ts"
click node_storefactory "https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/model/store/backend.ts"
click node_crypto "https://github.com/legspcpd/openlist-next/blob/main/src/backend/pkg/crypto.ts"
click node_auth "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/auth.ts"
click node_middleware "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/middlewares.ts"
click node_sharing "https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/op/share.ts"
click node_webdav "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/webdav.ts"
click node_s3api "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/s3.ts"
click node_mcp "https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/mcp.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_backend,node_router,node_filesystem,node_raw,node_user,node_client toneBlue
class node_storageops,node_driverbase,node_drivers,node_database,node_storefactory,node_crypto,node_externalstore toneAmber
class node_auth,node_middleware,node_sharing toneMint
class node_webdav,node_s3api,node_mcp toneRose
```

## Components

### Request handling

- [Backend entry](https://github.com/legspcpd/openlist-next/blob/main/src/backend/index.ts): `src/backend/index.ts`
- [API router](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/router.ts): `src/backend/server/router.ts`
- [Filesystem API](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/fs.ts): `src/backend/server/fs.ts`
- [Raw transfer](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/raw.ts): `src/backend/server/raw.ts`

### Storage aggregation

- [Storage operations](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/op/storage.ts): `src/backend/internal/op/storage.ts`
- [Driver interface](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/driver/base.ts): `src/backend/internal/driver/base.ts`
- [Storage drivers](https://github.com/legspcpd/openlist-next/tree/main/src/backend/drivers): `src/backend/drivers`
- [OpenList data](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/model/db.ts): `src/backend/internal/model/db.ts`
- [Store backend](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/model/store/backend.ts): `src/backend/internal/model/store/backend.ts`
- [Credential encryption](https://github.com/legspcpd/openlist-next/blob/main/src/backend/pkg/crypto.ts): `src/backend/pkg/crypto.ts`

### Identity and sharing

- [Authentication](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/auth.ts): `src/backend/server/auth.ts`
- [Request middleware](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/middlewares.ts): `src/backend/server/middlewares.ts`
- [Sharing and search](https://github.com/legspcpd/openlist-next/blob/main/src/backend/internal/op/share.ts): `src/backend/internal/op/share.ts`

### External interfaces

- [WebDAV interface](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/webdav.ts): `src/backend/server/webdav.ts`
- [S3 interface](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/s3.ts): `src/backend/server/s3.ts`
- [MCP endpoint](https://github.com/legspcpd/openlist-next/blob/main/src/backend/server/mcp.ts): `src/backend/server/mcp.ts`

### Other components

- **User**
- **Platform or external DB**
- **External clients**

## Connections

- User → Backend entry: sends request (evidence: `README.md`)
- Backend entry → API router: mounts API (evidence: `src/backend/index.ts`)
- Backend entry → Raw transfer: mounts routes (evidence: `src/backend/index.ts`)
- API router → Filesystem API: routes to (evidence: `src/backend/server/router.ts`)
- Filesystem API → Storage operations: uses drivers
- Raw transfer → Storage operations: resolves driver (evidence: `src/backend/server/raw.ts`)
- Storage operations → OpenList data: loads config (evidence: `src/backend/internal/op/storage.ts`)
- Storage operations → Driver interface: returns driver (evidence: `src/backend/internal/op/storage.ts`)
- Storage drivers → Driver interface: implements interface (evidence: `src/backend/drivers/115open/driver.ts`)
- OpenList data → Store backend: loads and saves (evidence: `src/backend/internal/model/db.ts`)
- Store backend → Platform or external DB: persists data (evidence: `README.md`)
- OpenList data → Credential encryption: encrypts secrets (evidence: `src/backend/internal/model/db.ts`)
- API router → Authentication: registers routes (evidence: `src/backend/server/router.ts`)
- API router → Request middleware: registers middleware (evidence: `src/backend/server/router.ts`)
- Raw transfer → Sharing and search: resolves share (evidence: `src/backend/server/raw.ts`)
- API router → WebDAV interface: mounts protocol (evidence: `src/backend/index.ts`)
- API router → S3 interface: mounts protocol (evidence: `src/backend/index.ts`)
- API router → MCP endpoint: registers endpoint (evidence: `src/backend/server/router.ts`)
- External clients → WebDAV interface: accesses files (evidence: `README.md`)
- External clients → S3 interface: accesses files (evidence: `README.md`)
- External clients → MCP endpoint: calls tools (evidence: `README.md`)
