Yeomai/FileHost
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

docs: add Linux.do friend link and align README tables

Browse Source
This commit is contained in:
O96u committed 2026-08-24 10:41:52 +08:00
1 parent 9d2ee96af0
commit 661146ce20
2 files changed
+110 -102
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.en.md
+55 -51
View File
@@ -29,17 +29,17 @@
## Screenshots ## Screenshots
| Login | Upload | | Login | Upload |
|:---:|:---:| | :----------------------------------: | :------------------------------------: |
| ![Login](docs/screenshots/login.png) | ![Upload](docs/screenshots/upload.png) | | ![Login](docs/screenshots/login.png) | ![Upload](docs/screenshots/upload.png) |
| Upload preferences | Stats & gallery | | Upload preferences | Stats & gallery |
|:---:|:---:| | :----------------------------------------------: | :----------------------------------: |
| ![Preferences](docs/screenshots/preferences.png) | ![Stats](docs/screenshots/stats.png) | | ![Preferences](docs/screenshots/preferences.png) | ![Stats](docs/screenshots/stats.png) |
| Settings | | | Settings | |
|:---:|:---:| | :----------------------------------------: | :-: |
| ![Settings](docs/screenshots/settings.png) | | | ![Settings](docs/screenshots/settings.png) | |
## Features ## Features
@@ -95,41 +95,41 @@ If you only had `ADMIN_SECRET` and no user table, log in with the secret once an
## Tech Stack ## Tech Stack
| Layer | Technology | | Layer | Technology |
|-------|------------| | -------- | --------------------------------------------------- |
| Frontend | Nuxt 4, Vue 3, Nuxt UI 4, Tailwind CSS 4 | | Frontend | Nuxt 4, Vue 3, Nuxt UI 4, Tailwind CSS 4 |
| Backend | Nitro (Node.js), SQLite | | Backend | Nitro (Node.js), SQLite |
| Images | sharp (WebP transcoding & compression) | | Images | sharp (WebP transcoding & compression) |
| Auth | Session cookie, scrypt password hashing, API tokens | | Auth | Session cookie, scrypt password hashing, API tokens |
| Storage | Local disk (`DATA_DIR`) | | Storage | Local disk (`DATA_DIR`) |
| Deploy | Docker (amd64 / arm64), docker compose | | Deploy | Docker (amd64 / arm64), docker compose |
| Tests | Vitest | | Tests | Vitest |
## Environment variables ## Environment variables
| Variable | Description | | Variable | Description |
|----------|-------------| | ----------------------- | --------------------------------------------------------------------------- |
| `API_UPLOAD_TOKEN` | Global upload token (`Auth-Token` header); can be generated in the API page | | `API_UPLOAD_TOKEN` | Global upload token (`Auth-Token` header); can be generated in the API page |
| `ALLOWED_REFERER_HOSTS` | Hotlink allowlist (comma-separated hostnames) | | `ALLOWED_REFERER_HOSTS` | Hotlink allowlist (comma-separated hostnames) |
| `IMAGE_BASE_URL` | Public base URL for image links | | `IMAGE_BASE_URL` | Public base URL for image links |
| `WEBP_QUALITY` | Server WebP quality 1–100, default 80 | | `WEBP_QUALITY` | Server WebP quality 1–100, default 80 |
| `AUTO_DELETE_DAYS` | Global auto-delete days (0 = off); admin + orphan images only | | `AUTO_DELETE_DAYS` | Global auto-delete days (0 = off); admin + orphan images only |
| `DATA_DIR` | Data directory, default `/data` (container) or `./data` (local) | | `DATA_DIR` | Data directory, default `/data` (container) or `./data` (local) |
| `ADMIN_SECRET` | Legacy v1.0 migration only | | `ADMIN_SECRET` | Legacy v1.0 migration only |
| `DEV_BYPASS_ACCESS` | Dev only — bypass auth (never in production) | | `DEV_BYPASS_ACCESS` | Dev only — bypass auth (never in production) |
Environment variables override database settings. See [`.env.example`](.env.example). Environment variables override database settings. See [`.env.example`](.env.example).
## Users & permissions ## Users & permissions
| Scenario | Auth | Ownership / visibility | | Scenario | Auth | Ownership / visibility |
|----------|------|------------------------| | ------------------------------ | -------------------- | --------------------------- |
| Web upload | Session | Current user | | Web upload | Session | Current user |
| API upload + **user token** | `Auth-Token` | Token owner | | API upload + **user token** | `Auth-Token` | Token owner |
| API upload + **global token** | `Auth-Token` | Admin (`userId` null) | | API upload + **global token** | `Auth-Token` | Admin (`userId` null) |
| Twikoo `/api/index.php` | form `token` | Same as global token | | Twikoo `/api/index.php` | form `token` | Same as global token |
| Gallery list / search / delete | Session or token | Users: own only; admin: all | | Gallery list / search / delete | Session or token | Users: own only; admin: all |
| Direct link `GET /images/...` | None (Referer rules) | Public if URL is known | | Direct link `GET /images/...` | None (Referer rules) | Public if URL is known |
Regular users are limited to the `images/` folder; custom `folder` requires admin or global token. Regular users are limited to the `images/` folder; custom `folder` requires admin or global token.
@@ -147,12 +147,12 @@ Pattern: `folder/YYYY/MM/randomId.webp` + `.meta.json`. Back up the entire `/dat
## API overview ## API overview
| Method | Path | Description | | Method | Path | Description |
|--------|------|-------------| | ------ | -------------------- | ---------------------- |
| POST | `/api/images/upload` | Upload image | | POST | `/api/images/upload` | Upload image |
| GET | `/api/images` | Paginated list | | GET | `/api/images` | Paginated list |
| DELETE | `/api/images` | Delete one (`key`) | | DELETE | `/api/images` | Delete one (`key`) |
| POST | `/api/index.php` | Twikoo / EasyImage 2.0 | | POST | `/api/index.php` | Twikoo / EasyImage 2.0 |
Upload example: Upload example:
@@ -167,11 +167,11 @@ Full docs and copyable cURL snippets are on the **API** page after deployment.
## Twikoo ## Twikoo
| Setting | Value | | Setting | Value |
|---------|-------| | ----------------- | ----------------------------------- |
| `IMAGE_CDN` | `easyimage` | | `IMAGE_CDN` | `easyimage` |
| `IMAGE_CDN_URL` | `https://your-domain/api/index.php` | | `IMAGE_CDN_URL` | `https://your-domain/api/index.php` |
| `IMAGE_CDN_TOKEN` | Same as `API_UPLOAD_TOKEN` | | `IMAGE_CDN_TOKEN` | Same as `API_UPLOAD_TOKEN` |
## Reverse proxy ## Reverse proxy
@@ -192,14 +192,18 @@ npm test # Unit tests
## Roadmap ## Roadmap
| Version | Plan | | Version | Plan |
|---------|------| | ---------- | -------------------------------------------------------------- |
| **v1.0.3** | CI and Docker multi-arch build fixes (current) | | **v1.0.3** | CI and Docker multi-arch build fixes (current) |
| **v1.0.2** | i18n, mobile menus, stats/upload UI, Docker password reset | | **v1.0.2** | i18n, mobile menus, stats/upload UI, Docker password reset |
| **v1.0.1** | Settings version display, mobile upload preferences layout fix | | **v1.0.1** | Settings version display, mobile upload preferences layout fix |
| **v1.0.0** | Local storage, multi-user, API, Twikoo | | **v1.0.0** | Local storage, multi-user, API, Twikoo |
| **v1.1.0** | S3, Cloudflare R2, and more object storage backends | | **v1.1.0** | S3, Cloudflare R2, and more object storage backends |
## License ## License
[MIT](LICENSE) [MIT](LICENSE)
## Friend links
[LINUX DO](https://linux.do/)
README.md
+55 -51
View File
@@ -29,17 +29,17 @@
## 界面预览 ## 界面预览
| 登录 | 上传 | | 登录 | 上传 |
|:---:|:---:| | :---------------------------------: | :----------------------------------: |
| ![登录](docs/screenshots/login.png) | ![上传](docs/screenshots/upload.png) | | ![登录](docs/screenshots/login.png) | ![上传](docs/screenshots/upload.png) |
| 上传偏好 | 统计与图库 | | 上传偏好 | 统计与图库 |
|:---:|:---:| | :-------------------------------------------: | :---------------------------------: |
| ![上传偏好](docs/screenshots/preferences.png) | ![统计](docs/screenshots/stats.png) | | ![上传偏好](docs/screenshots/preferences.png) | ![统计](docs/screenshots/stats.png) |
| 系统设置 | | | 系统设置 | |
|:---:|:---:| | :------------------------------------: | :-: |
| ![设置](docs/screenshots/settings.png) | | | ![设置](docs/screenshots/settings.png) | |
## 特性 ## 特性
@@ -100,41 +100,41 @@ npm run dev
## 技术栈 ## 技术栈
| 层级 | 技术 | | 层级 | 技术 |
|------|------| | -------- | ------------------------------------------ |
| 前端 | Nuxt 4、Vue 3、Nuxt UI 4、Tailwind CSS 4 | | 前端 | Nuxt 4、Vue 3、Nuxt UI 4、Tailwind CSS 4 |
| 后端 | Nitro（Node.js）、SQLite | | 后端 | Nitro（Node.js）、SQLite |
| 图片处理 | sharp（WebP 转码与压缩） | | 图片处理 | sharp（WebP 转码与压缩） |
| 鉴权 | Session Cookie、scrypt 密码哈希、API Token | | 鉴权 | Session Cookie、scrypt 密码哈希、API Token |
| 存储 | 本地磁盘（`DATA_DIR`） | | 存储 | 本地磁盘（`DATA_DIR`） |
| 部署 | Docker（amd64 / arm64）、docker compose | | 部署 | Docker（amd64 / arm64）、docker compose |
| 测试 | Vitest | | 测试 | Vitest |
## 环境变量 ## 环境变量
| 变量 | 说明 | | 变量 | 说明 |
|------|------| | ----------------------- | ------------------------------------------------------------ |
| `API_UPLOAD_TOKEN` | 全局上传 Token（`Auth-Token` 头）；未配置可在后台 API 页生成 | | `API_UPLOAD_TOKEN` | 全局上传 Token（`Auth-Token` 头）；未配置可在后台 API 页生成 |
| `ALLOWED_REFERER_HOSTS` | 防盗链白名单（逗号分隔 hostname） | | `ALLOWED_REFERER_HOSTS` | 防盗链白名单（逗号分隔 hostname） |
| `IMAGE_BASE_URL` | 图片直链公网域名（反代时建议填写） | | `IMAGE_BASE_URL` | 图片直链公网域名（反代时建议填写） |
| `WEBP_QUALITY` | 服务端 WebP 质量 1–100，默认 80 | | `WEBP_QUALITY` | 服务端 WebP 质量 1–100，默认 80 |
| `AUTO_DELETE_DAYS` | 全局自动删除天数（0 关闭）；仅影响管理员及无归属历史图 | | `AUTO_DELETE_DAYS` | 全局自动删除天数（0 关闭）；仅影响管理员及无归属历史图 |
| `DATA_DIR` | 数据目录，默认 `/data`（容器）或 `./data`（本地） | | `DATA_DIR` | 数据目录，默认 `/data`（容器）或 `./data`（本地） |
| `ADMIN_SECRET` | 仅遗留 v1.0 迁移，新安装不需要 | | `ADMIN_SECRET` | 仅遗留 v1.0 迁移，新安装不需要 |
| `DEV_BYPASS_ACCESS` | 开发用，跳过登录（生产勿开） | | `DEV_BYPASS_ACCESS` | 开发用，跳过登录（生产勿开） |
环境变量优先级高于后台设置。详见 [`.env.example`](.env.example)。 环境变量优先级高于后台设置。详见 [`.env.example`](.env.example)。
## 用户与权限 ## 用户与权限
| 场景 | 鉴权 | 图片归属 / 可见范围 | | 场景 | 鉴权 | 图片归属 / 可见范围 |
|------|------|---------------------| | -------------------------- | -------------------- | -------------------------- |
| 网页上传 | Session | 当前登录用户 | | 网页上传 | Session | 当前登录用户 |
| API 上传 + **个人 Token** | `Auth-Token` | 该 Token 所属用户 | | API 上传 + **个人 Token** | `Auth-Token` | 该 Token 所属用户 |
| API 上传 + **全局 Token** | `Auth-Token` | 管理员（`userId` 为空） | | API 上传 + **全局 Token** | `Auth-Token` | 管理员（`userId` 为空） |
| Twikoo `/api/index.php` | 表单 `token` | 与全局 Token 相同 | | Twikoo `/api/index.php` | 表单 `token` | 与全局 Token 相同 |
| 图库列表 / 搜索 / 删除 | Session 或 Token | 普通用户仅自己；管理员全部 | | 图库列表 / 搜索 / 删除 | Session 或 Token | 普通用户仅自己；管理员全部 |
| 图片直链 `GET /images/...` | 无（Referer 防盗链） | 知道 URL 即可访问 | | 图片直链 `GET /images/...` | 无（Referer 防盗链） | 知道 URL 即可访问 |
普通用户上传目录固定为 `images/`；自定义 `folder` 仅管理员或全局 Token 可用。 普通用户上传目录固定为 `images/`；自定义 `folder` 仅管理员或全局 Token 可用。
@@ -152,12 +152,12 @@ npm run dev
## API 概览 ## API 概览
| 方法 | 路径 | 说明 | | 方法 | 路径 | 说明 |
|------|------|------| | ------ | -------------------- | ---------------------- |
| POST | `/api/images/upload` | 上传图片 | | POST | `/api/images/upload` | 上传图片 |
| GET | `/api/images` | 分页列表 | | GET | `/api/images` | 分页列表 |
| DELETE | `/api/images` | 删除单张（`key`） | | DELETE | `/api/images` | 删除单张（`key`） |
| POST | `/api/index.php` | Twikoo / EasyImage 2.0 | | POST | `/api/index.php` | Twikoo / EasyImage 2.0 |
上传示例： 上传示例：
@@ -172,11 +172,11 @@ curl -X POST "https://pic.example.com/api/images/upload" \
## Twikoo ## Twikoo
| 配置项 | 值 | | 配置项 | 值 |
|--------|-----| | ----------------- | -------------------------------- |
| `IMAGE_CDN` | `easyimage` | | `IMAGE_CDN` | `easyimage` |
| `IMAGE_CDN_URL` | `https://你的域名/api/index.php` | | `IMAGE_CDN_URL` | `https://你的域名/api/index.php` |
| `IMAGE_CDN_TOKEN` | 与 `API_UPLOAD_TOKEN` 相同 | | `IMAGE_CDN_TOKEN` | 与 `API_UPLOAD_TOKEN` 相同 |
## 反向代理 ## 反向代理
@@ -197,14 +197,18 @@ npm test # 单元测试
## 路线图 ## 路线图
| 版本 | 计划 | | 版本 | 计划 |
|------|------| | ---------- | ------------------------------------------------- |
| **v1.0.3** | CI 与 Docker 多架构构建修复（当前） | | **v1.0.3** | CI 与 Docker 多架构构建修复（当前） |
| **v1.0.2** | 中英文、移动端菜单、统计/上传 UI、Docker 重置密码 | | **v1.0.2** | 中英文、移动端菜单、统计/上传 UI、Docker 重置密码 |
| **v1.0.1** | 设置页版本展示、移动端上传偏好布局修复 | | **v1.0.1** | 设置页版本展示、移动端上传偏好布局修复 |
| **v1.0.0** | 本地存储、多用户、API、Twikoo | | **v1.0.0** | 本地存储、多用户、API、Twikoo |
| **v1.1.0** | S3、Cloudflare R2 等对象存储后端 | | **v1.1.0** | S3、Cloudflare R2 等对象存储后端 |
## License ## License
[MIT](LICENSE) [MIT](LICENSE)
## 友链
[LINUX DO](https://linux.do/)