chore: finalize build docker and documentation

This commit is contained in:
OpenClaw Agent
2026-09-22 03:28:14 +08:00
parent c98452b8e1
commit ae0becffec
4 changed files with 175 additions and 8 deletions
+6 -5
View File
@@ -4,14 +4,15 @@ COPY go.mod go.sum ./
RUN go mod download RUN go mod download
COPY . . COPY . .
ARG VERSION=dev ARG VERSION=dev
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags "-s -w -X main.version=${VERSION}" -o /out/chfs-ng ./cmd/chfs ARG TARGETOS=linux
ARG TARGETARCH=amd64
ARG TARGETVARIANT=
RUN set -eux; GOARM=""; if [ "$TARGETARCH" = "arm" ] && [ "$TARGETVARIANT" = "v7" ]; then GOARM=7; fi; CGO_ENABLED=0 GOOS="$TARGETOS" GOARCH="$TARGETARCH" GOARM="$GOARM" go build -trimpath -ldflags "-s -w -X main.version=${VERSION}" -o /out/chfs-ng ./cmd/chfs
FROM alpine:3.22 FROM scratch
RUN apk add --no-cache ca-certificates tzdata COPY --from=build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt
COPY --from=build /out/chfs-ng /usr/local/bin/chfs-ng COPY --from=build /out/chfs-ng /usr/local/bin/chfs-ng
RUN mkdir -p /data && chmod 755 /data
VOLUME ["/data"] VOLUME ["/data"]
EXPOSE 80 EXPOSE 80
ENTRYPOINT ["/usr/local/bin/chfs-ng"] ENTRYPOINT ["/usr/local/bin/chfs-ng"]
CMD ["-path", "/data", "-port", "80"] CMD ["-path", "/data", "-port", "80"]
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 CMD wget -q -O - http://127.0.0.1/healthz >/dev/null || exit 1
+19 -2
View File
@@ -1,11 +1,12 @@
APP := chfs-ng APP := chfs-ng
VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo dev) VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo dev)
LDFLAGS := -s -w -X main.version=$(VERSION) LDFLAGS := -s -w -X main.version=$(VERSION)
OUT := bin
.PHONY: build test race vet check run docker-build docker-run .PHONY: build test race vet check run build-linux-amd64 build-linux-arm64 build-linux-armv7 build-linux cross docker-build docker-run clean
build: build:
CGO_ENABLED=0 go build -trimpath -ldflags '$(LDFLAGS)' -o bin/$(APP) ./cmd/chfs CGO_ENABLED=0 go build -trimpath -ldflags '$(LDFLAGS)' -o $(OUT)/$(APP) ./cmd/chfs
test: test:
go test ./... go test ./...
@@ -22,8 +23,24 @@ check: test race vet
run: run:
go run -ldflags '$(LDFLAGS)' ./cmd/chfs go run -ldflags '$(LDFLAGS)' ./cmd/chfs
build-linux-amd64:
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags '$(LDFLAGS)' -o $(OUT)/$(APP)-linux-amd64 ./cmd/chfs
build-linux-arm64:
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -trimpath -ldflags '$(LDFLAGS)' -o $(OUT)/$(APP)-linux-arm64 ./cmd/chfs
build-linux-armv7:
CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=7 go build -trimpath -ldflags '$(LDFLAGS)' -o $(OUT)/$(APP)-linux-armv7 ./cmd/chfs
build-linux: build-linux-amd64 build-linux-arm64 build-linux-armv7
cross: build-linux
docker-build: docker-build:
docker build --build-arg VERSION=$(VERSION) -t $(APP):$(VERSION) -t $(APP):latest . docker build --build-arg VERSION=$(VERSION) -t $(APP):$(VERSION) -t $(APP):latest .
docker-run: docker-run:
docker run --rm -p 8080:80 -v $(PWD)/data:/data $(APP):latest -path /data -port 80 docker run --rm -p 8080:80 -v $(PWD)/data:/data $(APP):latest -path /data -port 80
clean:
rm -rf $(OUT)
+149
View File
@@ -0,0 +1,149 @@
# CHFS-NG
CHFS-NG 是基于 CHFS 思路重构的轻量级、自托管 Web 文件管理器。它保留单二进制、低资源占用和 WebDAV 的特点,同时提供现代化文件管理 UI、动态用户、个人私有盘以及移动端友好操作。
## 特性
- 单 Go 二进制,前端资源内嵌,无外部前端依赖
- 现代文件管理 UI:列表/网格、排序、多选、拖拽、批量复制/移动/删除、搜索
- 图片 Gallery、音视频预览、视频倍速/PiP、音频迷你播放器
- 在线文本/代码编辑,支持 Ctrl/Cmd+S 保存
- 上传队列、进度、取消与重试,支持文件夹拖拽上传
- 动态用户管理与独立个人私有目录
- 多根目录与目录级读写/删除权限
- 分享、二维码移动传输、WebDAV
- 健康检查:/healthz
- 构建产物使用 -s -w,适合轻量 NAS
## 快速开始
### 直接运行
```bash
make build
./bin/chfs-ng -path /srv/files -port 8080
```
访问 http://127.0.0.1:8080/。
### Docker Compose
在仓库根目录执行:
```bash
mkdir -p deploy/data
cd deploy
docker compose up -d --build
```
默认宿主机端口为 8080,数据位于 deploy/data。可用 CHFS_PORT=9090 docker compose up -d --build 修改端口。
## 启动参数
| 参数 | 默认值 | 说明 |
| --- | --- | --- |
| -path | /data | 共享根目录;可用 | 分隔多个根目录 |
| -port | 80 | HTTP 监听端口 |
| -file | 空 | 配置文件路径 |
| -allow | 空 | 允许访问的 IPv4 地址 |
| -rule | 空 | 访问规则,可重复指定 |
| -version | false | 输出版本后退出 |
示例:
```bash
./bin/chfs-ng -path /srv/files -port 8080 -file /etc/chfs-ng/config.ini
```
显式指定的命令行参数会覆盖配置文件中的对应值。
## 动态用户与个人私有盘
CHFS-NG 支持运行时管理动态用户。管理员可以在 Web UI 的“用户管理”中创建、启用/禁用、修改密码和删除用户,并为用户设置个人空间。
默认个人空间根目录为:
```
users/
├── alice/
├── bob/
└── ...
```
用户登录后,“我的空间”指向自己的个人目录。个人目录由系统自动创建,并默认具有该用户的读、写、删除权限;其他普通用户不会因为登录而自动获得这些目录的访问权。
个人空间根目录可通过配置项 UserHome 指定。动态用户数据默认持久化到操作系统用户配置目录下的 chfs-ng/users.json;Docker 部署时,建议把用户文件配置到持久化的 /data 下。
管理员账号可以通过配置文件提供,例如:
```ini
[account]
username = admin
password = change-me
role = admin
```
实际配置字段以当前版本配置解析器支持的格式为准。
## WebDAV
WebDAV 地址:
```
http://HOST:PORT/webdav
```
### Windows
“此电脑” → “映射网络驱动器”,输入 http://HOST:PORT/webdav,使用 CHFS-NG 用户名和密码登录。生产环境建议通过 HTTPS 暴露。
### macOS
Finder → “前往” → “连接服务器”,输入:
```
http(s)://HOST:PORT/webdav
```
### Linux
桌面文件管理器选择“连接到服务器”,GNOME Files 可使用:
```
dav://HOST:PORT/webdav
davs://HOST:PORT/webdav
```
命令行可使用支持 WebDAV 的客户端,例如 cadaver。
WebDAV 与 Web UI 使用同一套用户权限模型。多根目录模式下保持根目录隔离,不允许跨虚拟根目录复制或移动。
## 交叉编译
```bash
make build-linux-amd64
make build-linux-arm64
make build-linux-armv7
make build-linux
```
输出:
```
bin/chfs-ng-linux-amd64
bin/chfs-ng-linux-arm64
bin/chfs-ng-linux-armv7
```
所有目标均使用 CGO_ENABLED=0、-trimpath 和 -ldflags "-s -w",不依赖目标机器上的 Go 环境。
## 开发与验证
```bash
make test
make race
make vet
make check
```
版本号默认来自 git describe --tags --always --dirty,也可以:
```bash
make build VERSION=v1.0.0
./bin/chfs-ng -version
```
## Docker
采用 Go Alpine 多阶段构建:builder 只负责编译,runtime 仅保留 CHFS-NG、CA 证书和时区数据,并提供容器健康检查。
```bash
docker build --build-arg VERSION=v1.0.0 -t chfs-ng:v1.0.0 .
docker run -d --name chfs-ng --restart unless-stopped -p 8080:80 -v /srv/chfs:/data chfs-ng:v1.0.0
```
最终镜像目标控制在 15 MB 以内;实际大小会随 Go/Alpine 版本变化。
## 数据与安全
- /data 为推荐持久化目录
- 生产环境建议使用 HTTPS 反向代理
- 不要使用弱管理员密码
- 动态用户数据库需要与数据目录一起备份
- 公开部署时建议配合防火墙/反向代理
- WebDAV 优先使用 HTTPS
## License
本项目许可证以仓库中的 LICENSE 文件为准。
+1 -1
View File
@@ -7,7 +7,7 @@ services:
image: chfs-ng:${VERSION:-latest} image: chfs-ng:${VERSION:-latest}
restart: unless-stopped restart: unless-stopped
ports: ports:
- "8080:80" - "${CHFS_PORT:-8080}:80"
volumes: volumes:
- ./data:/data - ./data:/data
command: ["-path", "/data", "-port", "80"] command: ["-path", "/data", "-port", "80"]