mirror of
https://github.com/okxlin/appstore.git
synced 2026-11-22 00:00:30 +00:00
Confine internally created paths, leave existing external data directories untouched, and avoid deleting bind data on uninstall. Document the upgrade behavior and preserve legacy environment values.
59 lines
2.8 KiB
Markdown
59 lines
2.8 KiB
Markdown
# Lychee
|
|
|
|
## 产品介绍
|
|
Lychee 是自托管照片管理与分享应用。
|
|
|
|
英文说明:Photo gallery manager maintained by LinuxServer.io.
|
|
|
|
## 主要功能
|
|
- 在网页界面管理和分享照片。
|
|
- 将应用配置和 SQLite 数据库保存在 `CONFIG_PATH`,将照片保存在 `PICTURES_PATH`。
|
|
- 可使用 SQLite,也可按表单配置 MySQL 或 PostgreSQL。
|
|
|
|
## 部署说明
|
|
- 本应用使用 Docker Compose 在 1Panel 中部署。
|
|
- 应用分类:媒体。
|
|
- 支持架构:amd64、arm64。
|
|
- 可选版本:`latest`;固定版本以应用商店当前版本目录和安装表单为准。
|
|
- 安装后按应用表单中的端口访问 Web UI、SSH 或对应服务。
|
|
|
|
## 端口
|
|
| 变量 | 说明 | 默认值 | 必填 |
|
|
| --- | --- | --- | --- |
|
|
| PANEL_APP_PORT_HTTP | HTTP 端口 | 80 | 是 |
|
|
| DB_PORT | 数据库端口 | - | 否 |
|
|
|
|
## 数据持久化
|
|
| 变量 | 说明 | 默认值 | 必填 |
|
|
| --- | --- | --- | --- |
|
|
| CONFIG_PATH | 配置文件路径 | ./data/config | 是 |
|
|
| PICTURES_PATH | 图片目录 | ./data/pictures | 是 |
|
|
|
|
新安装时请让 `PICTURES_PATH` 指向空目录;Lychee 会管理其中的内容。已有安装升级时不要清空图片目录。升级或迁移前,请在 1Panel 中备份上述数据目录。
|
|
|
|
升级会沿用现有的 `CONFIG_PATH`、`PICTURES_PATH` 和数据库参数,不会搬迁配置或图片。应用目录内的相对路径可以由初始化脚本创建;已有绝对路径或指向应用目录外的相对路径必须已存在,脚本不会创建或递归修改这些外部目录的属主。外部目录需要允许容器 UID/GID `1000:1000` 读写。
|
|
|
|
## 配置项
|
|
| 变量 | 说明 | 默认值 | 必填 |
|
|
| --- | --- | --- | --- |
|
|
| TIME_ZONE | 时区 | Asia/Shanghai | 是 |
|
|
| APP_NAME | 相册名称 | Lychee | 否 |
|
|
| APP_URL | 对外访问 URL | - | 否 |
|
|
| TRUSTED_PROXIES | 反向代理 IP 或网段,公网环境不要填写 * | - | 否 |
|
|
| DB_CONNECTION | 数据库连接类型 | sqlite | 是 |
|
|
| DB_DATABASE | 数据库名称或路径 | /config/lychee.sqlite | 是 |
|
|
| DB_HOST | 数据库主机 | - | 否 |
|
|
| DB_USERNAME | 数据库用户名 | - | 否 |
|
|
| DB_PASSWORD | 数据库密码 | - | 否 |
|
|
|
|
## 使用说明
|
|
- 安装完成后,在 1Panel 应用页面查看运行状态、端口和日志。
|
|
- 首次启用前,请按安装表单填写域名、账号、密码、Token、数据目录等参数。
|
|
- 如需对外开放访问,请同步检查防火墙、安全组和反向代理配置。
|
|
- 升级脚本只为旧配置补充缺失的 `APP_NAME`、`APP_URL`、`TRUSTED_PROXIES`、`DB_CONNECTION` 和 `DB_DATABASE`,已有数据库连接值不会被覆盖。
|
|
|
|
## 参考资料
|
|
- 官网: <https://lycheeorg.dev/>
|
|
- 文档: <https://docs.linuxserver.io/images/docker-lychee/>
|
|
- 源码: <https://github.com/linuxserver/docker-lychee>
|