diff --git a/FAQ.md b/FAQ.md index ef15eef..43dda0c 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,5 +1,64 @@ # Machete家庭相册系统使用FAQ常见问题 +项目完整名称为:Filesite/Machete,为求简单下文都以machete代替。 + +本文目录如下: + +* [Filesite/Machete家庭相册系统有哪些特点?](#Filesite/Machete家庭相册系统有哪些特点?) +* [用machete家庭相册系统管理我的照片安全吗?](#用machete家庭相册系统管理我的照片安全吗?) +* [怎么升级machete家庭相册代码?](#怎么升级machete家庭相册代码?) +* [系统配置文件在哪里?](#系统配置文件在哪里?) +* [怎么开启密码授权访问?](#怎么开启密码授权访问?) +* [怎么关闭网页底部的二维码?](#怎么关闭网页底部的二维码?) +* [怎么修改网站简介信息?](#怎么修改网站简介信息?) +* [怎么修改网站标题?](#怎么修改网站标题?) +* [怎么修改底部的版权信息?](#怎么修改底部的版权信息?) +* [怎么修改浏览器地址栏左侧的小图标?](#怎么修改浏览器地址栏左侧的小图标?) +* [相册部署到外网了,点击图片打开有点慢怎么办?](#相册部署到外网了,点击图片打开有点慢怎么办?) +* [在局域网内使用,能否所有图片使用原图而不是缩略图?](#在局域网内使用,能否所有图片使用原图而不是缩略图?) +* [我的设备cpu性能较差,缩略图显示有点慢且cpu占用较高怎么解决?](#我的设备cpu性能较差,缩略图显示有点慢且cpu占用较高怎么解决?) +* [更多问题如何联系?](#更多问题如何联系?) + + +## Filesite/Machete家庭相册系统有哪些特点? + +以下为machete家庭相册的几个与众不同的地方: + +* 以**你的照片目录**为数据源、**所见即所得**,保留你的照片管理习惯 +* 开放源代码,源码公开且免费使用 +* **无数据库**非常轻量、毫秒级响应 +* 点击图片放大浏览时**默认使用原图**,适合大屏幕欣赏高清图片 +* 支持背景音乐播放 +* 支持单个目录下所有图片自动循环播放 +* 支持单个目录下所有视频**自动循环播放** +* 支持白天/夜晚两种浏览模式 + + +## 用machete家庭相册系统管理我的照片安全吗? + +请放心使用machete家庭相册系统来把本地图片目录转化为一个网站,只要你遵循我们推荐的方式安装部署,它是绝对安全的! + +理由如下: +1. machete是开源项目,代码公开,接受任何人/机构的安全检测; +2. 推荐使用docker安装部署machete,docker的安全机制很完善; +3. 只给runtime/目录写入权限,其它文件和目录只读; + + +Filesite/machete是**开放源代码**的,它托管在以下几个git网站: +* [GitHub](https://github.com/filesite-io) +* [GitCode](https://gitcode.net/filesite/machete) +* [Gitee](https://gitee.com/filesite/machete) + +并遵循**MIT License**,任何个人或公司,只要在保留来源申明的情况下,都可以基于它根据需要做修改后免费使用。 + + +另外,推荐使用docker来安装部署machete家庭相册, +这样基于docker提供的安全沙箱环境,最大程度地保护你的电脑、服务器不受machete程序影响。 + +最后,machete程序只有临时文件存放目录runtime/需要开放**写入权限**,其它文件和目录都只需开放“只读”权限即可, +所以你在使用docker为machete配置volume或者本地映射目录时,相册目录只开放只读权限docker容器, +由此可以进一步确保你的照片目录不会被machete程序修改/删除。 + ## 怎么升级machete家庭相册代码? @@ -51,21 +110,29 @@ docker exec -it machete_album /var/www/machete/bin/upgrade.sh * allow里配置单个目录的授权密码,如果default配置为空,则只有allow里所设置的目录需要密码授权访问 -## 怎么修改浏览器地址栏左侧的小图标? - -请创建自己的icon文件,命名为favicon.ico,把它复制到你的图片根目录即可; +## 怎么关闭网页底部的二维码? -**以容器目录为例:** +在runtime/custom_config.json中增加配置: ``` -/var/www/machete/www/girls/favico.ico +"showQRImageInFooter": false ``` -## 怎么关闭网页底部的二维码? +## 怎么修改网站简介信息? + +请修改图片根目录下的**README.md**文件内容(如果你安装的是老版本,看不到这个文件,请手动创建),它是markdown格式的内容。 + +保存后,点网页右上角“刷新”图标,清空缓存查看效果。 + + +## 怎么修改网站标题? + +网站标题显示在网页左上角,以及浏览器tab栏上,系统默认的标题是“家庭相册”或者“Filesite/Machete”。 + +请在图片根目录下,创建文件**README_title.txt**,用一行文字来设置,示例如下: -在runtime/custom_config.json中增加配置: ``` -"showQRImageInFooter": false +我的相册 ``` @@ -81,6 +148,16 @@ by FileSite.io ``` +## 怎么修改浏览器地址栏左侧的小图标? + +请创建自己的icon文件,命名为favicon.ico,把它复制到你的图片根目录即可; + +**以容器目录为例:** +``` +/var/www/machete/www/girls/favico.ico +``` + + ## 相册部署到外网了,点击图片打开有点慢怎么办? machete家庭相册默认为局域网使用,配置**enableSmallImageForWan**开启查看大图显示缩略图是关闭的, diff --git a/themes/beauty/controller/SiteController.php b/themes/beauty/controller/SiteController.php index 09fe87e..7bc2185 100644 --- a/themes/beauty/controller/SiteController.php +++ b/themes/beauty/controller/SiteController.php @@ -674,9 +674,27 @@ Class SiteController extends Controller { } } + $maxScanDeep = 0; + + //获取根目录下的readme + $htmlReadme = ''; + $cacheKey = $this->getCacheKey('root', 'readme', $maxScanDeep); + $expireSeconds = 86400; + $readmeFile = Common::getCacheFromFile($cacheKey, $expireSeconds); + if (!empty($readmeFile)) { + $htmlReadme = $readmeFile['htmlReadme']; + } + + $copyright = ''; + if (!empty($readmeFile['copyright'])) { + $copyright = $readmeFile['copyright']; + } + $pageTitle = '密码授权'; $viewName = 'pwdauth'; $params = compact( + 'htmlReadme', + 'copyright', 'checkDir', 'goBackUrl', 'password', diff --git a/themes/beauty/views/layout/main.php b/themes/beauty/views/layout/main.php index 8048652..31a04a0 100644 --- a/themes/beauty/views/layout/main.php +++ b/themes/beauty/views/layout/main.php @@ -68,6 +68,14 @@ require_once __DIR__ . '/../../../../plugins/Html.php';