okooooooo/PicHost
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 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
+26 -18
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.en.md
+13 -9
View File
@@ -30,15 +30,15 @@
## Screenshots
| Login | Upload |
|:---:|:---:|
| :----------------------------------: | :------------------------------------: |
| ![Login](docs/screenshots/login.png) | ![Upload](docs/screenshots/upload.png) |
| Upload preferences | Stats & gallery |
|:---:|:---:|
| :----------------------------------------------: | :----------------------------------: |
| ![Preferences](docs/screenshots/preferences.png) | ![Stats](docs/screenshots/stats.png) |
| Settings | |
|:---:|:---:|
| :----------------------------------------: | :-: |
| ![Settings](docs/screenshots/settings.png) | |
## Features
@@ -96,7 +96,7 @@ If you only had `ADMIN_SECRET` and no user table, log in with the secret once an
## Tech Stack
| Layer | Technology |
|-------|------------|
| -------- | --------------------------------------------------- |
| Frontend | Nuxt 4, Vue 3, Nuxt UI 4, Tailwind CSS 4 |
| Backend | Nitro (Node.js), SQLite |
| Images | sharp (WebP transcoding & compression) |
@@ -108,7 +108,7 @@ If you only had `ADMIN_SECRET` and no user table, log in with the secret once an
## Environment variables
| Variable | Description |
|----------|-------------|
| ----------------------- | --------------------------------------------------------------------------- |
| `API_UPLOAD_TOKEN` | Global upload token (`Auth-Token` header); can be generated in the API page |
| `ALLOWED_REFERER_HOSTS` | Hotlink allowlist (comma-separated hostnames) |
| `IMAGE_BASE_URL` | Public base URL for image links |
@@ -123,7 +123,7 @@ Environment variables override database settings. See [`.env.example`](.env.exam
## Users & permissions
| Scenario | Auth | Ownership / visibility |
|----------|------|------------------------|
| ------------------------------ | -------------------- | --------------------------- |
| Web upload | Session | Current user |
| API upload + **user token** | `Auth-Token` | Token owner |
| API upload + **global token** | `Auth-Token` | Admin (`userId` null) |
@@ -148,7 +148,7 @@ Pattern: `folder/YYYY/MM/randomId.webp` + `.meta.json`. Back up the entire `/dat
## API overview
| Method | Path | Description |
|--------|------|-------------|
| ------ | -------------------- | ---------------------- |
| POST | `/api/images/upload` | Upload image |
| GET | `/api/images` | Paginated list |
| DELETE | `/api/images` | Delete one (`key`) |
@@ -168,7 +168,7 @@ Full docs and copyable cURL snippets are on the **API** page after deployment.
## Twikoo
| Setting | Value |
|---------|-------|
| ----------------- | ----------------------------------- |
| `IMAGE_CDN` | `easyimage` |
| `IMAGE_CDN_URL` | `https://your-domain/api/index.php` |
| `IMAGE_CDN_TOKEN` | Same as `API_UPLOAD_TOKEN` |
@@ -193,7 +193,7 @@ npm test # Unit tests
## Roadmap
| Version | Plan |
|---------|------|
| ---------- | -------------------------------------------------------------- |
| **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.1** | Settings version display, mobile upload preferences layout fix |
@@ -203,3 +203,7 @@ npm test # Unit tests
## License
[MIT](LICENSE)
## Friend links
[LINUX DO](https://linux.do/)
README.md
+13 -9
View File
@@ -30,15 +30,15 @@
## 界面预览
| 登录 | 上传 |
|:---:|:---:|
| :---------------------------------: | :----------------------------------: |
| ![登录](docs/screenshots/login.png) | ![上传](docs/screenshots/upload.png) |
| 上传偏好 | 统计与图库 |
|:---:|:---:|
| :-------------------------------------------: | :---------------------------------: |
| ![上传偏好](docs/screenshots/preferences.png) | ![统计](docs/screenshots/stats.png) |
| 系统设置 | |
|:---:|:---:|
| :------------------------------------: | :-: |
| ![设置](docs/screenshots/settings.png) | |
## 特性
@@ -101,7 +101,7 @@ npm run dev
## 技术栈
| 层级 | 技术 |
|------|------|
| -------- | ------------------------------------------ |
| 前端 | Nuxt 4、Vue 3、Nuxt UI 4、Tailwind CSS 4 |
| 后端 | Nitro（Node.js）、SQLite |
| 图片处理 | sharp（WebP 转码与压缩） |
@@ -113,7 +113,7 @@ npm run dev
## 环境变量
| 变量 | 说明 |
|------|------|
| ----------------------- | ------------------------------------------------------------ |
| `API_UPLOAD_TOKEN` | 全局上传 Token（`Auth-Token` 头）；未配置可在后台 API 页生成 |
| `ALLOWED_REFERER_HOSTS` | 防盗链白名单（逗号分隔 hostname） |
| `IMAGE_BASE_URL` | 图片直链公网域名（反代时建议填写） |
@@ -128,7 +128,7 @@ npm run dev
## 用户与权限
| 场景 | 鉴权 | 图片归属 / 可见范围 |
|------|------|---------------------|
| -------------------------- | -------------------- | -------------------------- |
| 网页上传 | Session | 当前登录用户 |
| API 上传 + **个人 Token** | `Auth-Token` | 该 Token 所属用户 |
| API 上传 + **全局 Token** | `Auth-Token` | 管理员（`userId` 为空） |
@@ -153,7 +153,7 @@ npm run dev
## API 概览
| 方法 | 路径 | 说明 |
|------|------|------|
| ------ | -------------------- | ---------------------- |
| POST | `/api/images/upload` | 上传图片 |
| GET | `/api/images` | 分页列表 |
| DELETE | `/api/images` | 删除单张（`key`） |
@@ -173,7 +173,7 @@ curl -X POST "https://pic.example.com/api/images/upload" \
## Twikoo
| 配置项 | 值 |
|--------|-----|
| ----------------- | -------------------------------- |
| `IMAGE_CDN` | `easyimage` |
| `IMAGE_CDN_URL` | `https://你的域名/api/index.php` |
| `IMAGE_CDN_TOKEN` | 与 `API_UPLOAD_TOKEN` 相同 |
@@ -198,7 +198,7 @@ npm test # 单元测试
## 路线图
| 版本 | 计划 |
|------|------|
| ---------- | ------------------------------------------------- |
| **v1.0.3** | CI 与 Docker 多架构构建修复（当前） |
| **v1.0.2** | 中英文、移动端菜单、统计/上传 UI、Docker 重置密码 |
| **v1.0.1** | 设置页版本展示、移动端上传偏好布局修复 |
@@ -208,3 +208,7 @@ npm test # 单元测试
## License
[MIT](LICENSE)
## 友链
[LINUX DO](https://linux.do/)