From 24ce337e85d9855dc2419f60f6d1335bc2bb8666 Mon Sep 17 00:00:00 2001 From: filesite Date: Sun, 12 Jan 2025 22:14:32 +0800 Subject: [PATCH] faq update --- FAQ.md | 253 ++++++++++++++++++++++++++++-------------- www/content/Manual.md | 1 + www/css/beauty.css | 1 + www/js/beauty.js | 43 ++++++- 4 files changed, 213 insertions(+), 85 deletions(-) diff --git a/FAQ.md b/FAQ.md index da81683..b53ec01 100644 --- a/FAQ.md +++ b/FAQ.md @@ -4,27 +4,48 @@ 本文目录如下： -* [Filesite/Machete家庭相册系统有哪些特点？](#filesitemachete家庭相册系统有哪些特点) +1）相册简介 +* [Filesite/Machete家庭相册系统有哪些特点？](#filesite-machete家庭相册系统有哪些特点) * [用machete家庭相册系统管理我的照片安全吗？](#用machete家庭相册系统管理我的照片安全吗) +* [相册支持哪些文件类型？](#相册支持哪些文件类型) * [怎么升级machete家庭相册代码？](#怎么升级machete家庭相册代码) * [系统配置文件在哪里？](#系统配置文件在哪里) -* [怎么开启密码授权访问？](#怎么开启密码授权访问) -* [怎么关闭网页底部的二维码？](#怎么关闭网页底部的二维码) +* [根目录下的README.md是必须的吗？](#根目录下的README.md是必须的吗) + + +2）UI自定义 * [怎么修改网站简介信息？](#怎么修改网站简介信息) * [怎么修改网站标题？](#怎么修改网站标题) * [怎么修改底部的版权信息？](#怎么修改底部的版权信息) +* [怎么关闭网页底部的二维码？](#怎么关闭网页底部的二维码) * [怎么修改浏览器地址栏左侧的小图标？](#怎么修改浏览器地址栏左侧的小图标) -* [相册部署到外网了，点击图片打开有点慢怎么办？](#相册部署到外网了点击图片打开有点慢怎么办) -* [在局域网内使用，能否所有图片使用原图而不是缩略图？](#在局域网内使用能否所有图片使用原图而不是缩略图) +* [怎么设置一级目录排序？](#怎么设置一级目录排序) * [怎么对照片、视频、音乐文件进行排序？](#怎么对照片、视频、音乐文件进行排序) -* [怎么设置每页照片、视频、音乐文件数量？](#怎么设置每页照片、视频、音乐文件数量) +* [怎么设置每页照片、视频、音乐文件数量？](#怎么设置每页照片-视频-音乐文件数量) +* [怎么设置菜单栏不显示年、月分类？](#怎么设置菜单栏不显示年-月分类) + + +3）图片控制 * [怎么设置自动播放时每张照片停留时间？](#怎么设置自动播放时每张照片停留时间) -* [怎么设置局域网内访问拥有刷新、设置封面等管理权限？](#怎么设置局域网内访问拥有刷新、设置封面等管理权限) -* [外网访问怎么设置允许当前IP访问拥有刷新、设置封面等管理权限？](#外网访问怎么设置允许当前IP访问拥有刷新、设置封面等管理权限) -* [我的设备cpu性能较差，缩略图显示有点慢且cpu占用较高怎么解决？](#我的设备cpu性能较差缩略图显示有点慢且cpu占用较高怎么解决) -* [在启用Imagick扩展后，CPU占用过高或者大图片缩略图无法生成怎么解决？](#在启用Imagick扩展后，CPU占用过高或者大图片缩略图无法生成怎么解决) -* [怎么设置菜单栏不显示年、月分类？](#怎么设置菜单栏不显示年、月分类) +* [在局域网内使用，能否所有图片使用原图而不是缩略图？](#在局域网内使用能否所有图片使用原图而不是缩略图) + + +4）外网使用相关 +* [相册部署到外网了，点击图片打开有点慢怎么办？](#相册部署到外网了-点击图片打开有点慢怎么办) +* [外网访问怎么设置允许当前IP访问拥有刷新、设置封面等管理权限？](#外网访问怎么设置允许当前IP访问拥有刷新-设置封面等管理权限) +* [怎么设置了本地外网IP还是没有刷新图标？](#怎么设置了本地外网IP还是没有刷新图标) * [使用cdn加速应该怎么配置cdn规则？](#使用cdn加速应该怎么配置cdn规则) + + +5）安全相关 +* [怎么设置局域网内访问拥有刷新、设置封面等管理权限？](#怎么设置局域网内访问拥有刷新-设置封面等管理权限) +* [怎么开启密码授权访问？](#怎么开启密码授权访问) + + +6）性能和其它 +* [点了刷新图标怎么等了快1分钟底部扫描进度条还没动静？](#点了刷新图标怎么等了快1分钟底部扫描进度条还没动静) +* [我的设备cpu性能较差，缩略图显示有点慢且cpu占用较高怎么解决？](#我的设备cpu性能较差缩略图显示有点慢且cpu占用较高怎么解决) +* [在启用Imagick扩展后，CPU占用过高或者大图片缩略图无法生成怎么解决？](#在启用Imagick扩展后-CPU占用过高或者大图片缩略图无法生成怎么解决) * [更多问题如何联系？](#更多问题如何联系) @@ -68,6 +89,28 @@ Filesite/machete是**开放源代码**的，它托管在以下几个git网站： 由此可以进一步确保你的照片目录不会被machete程序修改/删除。 +## 相册支持哪些文件类型？ + +虽然machete自称相册，但实际它除了支持常见的图片之外，还支持几种视频格式，以及一种音乐文件格式。 + +以下是machete相册支持的文件格式： + +| 后缀 | 类型 | +| ---- | ---- | +| .jpg | 图片 | +| .png | 图片 | +| .webp | 图片 | +| .gif | 图片 | +| .ico | 图标 | +| .mp4 | 视频 | +| .m3u8 | 视频 | +| .ts | 视频 | +| .mp3 | 音乐 | + + +其中m3u8和ts是配合使用的，详情请搜索苹果的m3u8标准。 + + ## 怎么升级machete家庭相册代码？ 执行容器命令即可： @@ -79,6 +122,12 @@ docker exec -it machete_album /var/www/machete/bin/upgrade.sh 说明： 其中容器名称**machete_album**请更换为你所启动的machete容器名字。 +还可以先docker exec进入容器的命令行，再执行：upgrade.sh： +``` +docker exec -it machete_album /bin/sh +upgrade.sh +``` + ## 系统配置文件在哪里？ @@ -92,38 +141,13 @@ docker exec -it machete_album /var/www/machete/bin/upgrade.sh 如果是使用docker安装的machete，请自行了解如何修改docker容器里的文件，或者如何把本地文件复制到容器替换。 -## 怎么开启密码授权访问？ +## 根目录下的README.md是必须的吗？ -在目录runtime/下创建配置文件：custom_password.json， -可复制conf/custom_password.json到runtime/目录下进行修改。 +**是的**。 -也可按下面示例创建： -``` -{ - "password_auth": { - "enable": true, - "default": "", - "allow": { - "目录1": "hello", - "目录2": "world" - } - } -} -``` +因为machete的实现机制，以及filesite.io的标准，相册根目录下的**README.md**是必须的，它是用来放你的相册的简介。 -**配置说明：** - -* enable开关设置true则启用，默认为false关闭状态 -* default选项配置全局默认密码，针对所有目录生效 -* allow里配置单个目录的授权密码，如果default配置为空，则只有allow里所设置的目录需要密码授权访问 - - -## 怎么关闭网页底部的二维码？ - -在runtime/custom_config.json中增加以下配置： -``` -"showQRImageInFooter": false -``` +如果你还没想好怎么介绍你的相册，README.md文件内容可以留空。 ## 怎么修改网站简介信息？ @@ -156,33 +180,33 @@ by FileSite.io ``` -## 怎么修改浏览器地址栏左侧的小图标？ - -请创建自己的icon文件，命名为favicon.ico，把它复制到你的图片根目录； +## 怎么关闭网页底部的二维码？ -**以容器目录为例：** +在runtime/custom_config.json中增加以下配置： ``` -/var/www/machete/www/girls/favico.ico +"showQRImageInFooter": false ``` -## 相册部署到外网了，点击图片打开有点慢怎么办？ +## 怎么修改浏览器地址栏左侧的小图标？ -machete家庭相册默认为局域网使用，配置**enableSmallImageForWan**开启查看大图显示缩略图是关闭的， -如果你的照片文件大小很大，那么在外网打开可能会很慢。 +请创建自己的icon文件，命名为favicon.ico，把它复制到你的图片根目录； -解决办法，为外网点击图片浏览大图开启缩略图功能， -在自定义配置：runtime/custom_config.json里增加以下配置： +**以容器目录为例：** ``` -"enableSmallImageForWan": true +/var/www/machete/www/girls/favico.ico ``` -## 在局域网内使用，能否所有图片使用原图而不是缩略图？ +## 怎么设置一级目录排序？ -系统配置**enableSmallImage**默认为true打开的，在自定义配置文件中，加入以下配置保存即可关闭所有缩略图功能： +在相册根目录下，确保README.md存在的情况下，创建README_sort.txt文件来配置根目录下的一级子目录排序，内容为子目录名称，格式为一行一个。 + +示例： ``` -"enableSmallImage": false +我的照片 +我的视频 +我的音乐 ``` @@ -216,6 +240,16 @@ sortOrderOfFiles则设定排序方式，asc顺序，desc倒序。 ``` +## 怎么设置菜单栏不显示年、月分类？ + +从0.4.0版本开始，filesite/machete相册支持按年、月分类所有图片、视频、音乐文件。 + +默认按年、月分类菜单是显示的，如需关闭，在自定义配置：runtime/custom_config.json里增加以下配置： +``` +"showYearMonthMenus": false +``` + + ## 怎么设置自动播放时每张照片停留时间？ 在自定义配置：runtime/custom_config.json里增加以下配置： @@ -226,18 +260,23 @@ sortOrderOfFiles则设定排序方式，asc顺序，desc倒序。 单位：秒。 -## 怎么设置局域网内访问拥有刷新、设置封面等管理权限？ +## 在局域网内使用，能否所有图片使用原图而不是缩略图？ -在自定义配置：runtime/custom_config.json里增加以下配置： +系统配置**enableSmallImage**默认为true打开的，在自定义配置文件中，加入以下配置保存即可关闭所有缩略图功能： ``` -"adminForLanIps": true +"enableSmallImage": false ``` -系统支持这三类IP： + +## 相册部署到外网了，点击图片打开有点慢怎么办？ + +machete家庭相册默认为局域网使用，配置**enableSmallImageForWan**开启查看大图显示缩略图是关闭的， +如果你的照片文件大小很大，那么在外网打开可能会很慢。 + +解决办法，为外网点击图片浏览大图开启缩略图功能， +在自定义配置：runtime/custom_config.json里增加以下配置： ``` -127.0.0.1 -172.17.0.1, -192.168.xxx.xxx +"enableSmallImageForWan": true ``` @@ -250,7 +289,15 @@ sortOrderOfFiles则设定排序方式，asc顺序，desc倒序。 ] ``` -如果部署的时候相册是经过nginx反向代理转发的，请在nginx的配置中设置转发用户ip地址： + +## 怎么设置了本地外网IP还是没有刷新图标？ + +可能存在以下几种原因： +* 你获取到的ip并不是你本地真实的外网ip（请使用ip138.com查看本地外网ip） +* 你设置了ipv4的地址，但是你实际访问用的是ipv6的地址，请把v4和v6的地址同时配置好 +* 如果你在docker容器之上加了nginx或其它web服务器做反向代理，没有把用户的真实ip传给docker容器 + +以nginx反向代理为例，请在nginx的反向代理配置中设置转发用户ip地址： ``` proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; @@ -258,6 +305,67 @@ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; ``` +## 使用cdn加速应该怎么配置cdn规则？ + +以腾讯云cdn为例，需要增加下面 3 个规则： +1. 针对静态文件缓存 30 天，文件类型：jpg;jpeg;png;svg;mp4;mov;ts;gif;webp;js;css +2. 针对动态缩略图缓存 30 天，网址：/site/smallimg/ +3. 针对所有文件，不缓存（这个放最下面权重最低，也就是除了上面两类文件之外，其它都不缓存） + +补充说明： +如果你的项目还存在其它静态资源需要缓存，可加入第一条规则中。 + + + +## 怎么设置局域网内访问拥有刷新、设置封面等管理权限？ + +在自定义配置：runtime/custom_config.json里增加以下配置： +``` +"adminForLanIps": true +``` + +系统支持这三类IP： +``` +127.0.0.1 +172.17.0.1, +192.168.xxx.xxx +``` + + +## 怎么开启密码授权访问？ + +在目录runtime/下创建配置文件：custom_password.json， +可复制conf/custom_password.json到runtime/目录下进行修改。 + +也可按下面示例创建： +``` +{ + "password_auth": { + "enable": true, + "default": "", + "allow": { + "目录1": "hello", + "目录2": "world" + } + } +} +``` + +**配置说明：** + +* enable开关设置true则启用，默认为false关闭状态 +* default选项配置全局默认密码，针对所有目录生效 +* allow里配置单个目录的授权密码，如果default配置为空，则只有allow里所设置的目录需要密码授权访问 + + + +## 点了刷新图标怎么等了快1分钟底部扫描进度条还没动静？ + +最新版相册源码设置了间隔 1 分钟检查一次是否需要扫描所有文件，所以在点击”刷新“图标之后，请耐心等待一会，就会看到底部进度条开始走动。 + +等到进度条进行到100%由蓝色变为绿色并在几秒之后消失自动刷新网页，就表示文件扫描任务已完成。 + + ## 我的设备cpu性能较差，缩略图显示有点慢且cpu占用较高怎么解决？ machete家庭相册在设计的时候考虑到在嵌入式设备中运行，缩略图功能可由用户的浏览器完成。 @@ -291,27 +399,6 @@ docker run --name machete -p 1080:80 \ ``` -## 怎么设置菜单栏不显示年、月分类？ - -从0.4.0版本开始，filesite/machete相册支持按年、月分类所有图片、视频、音乐文件。 - -默认按年、月分类菜单是显示的，如需关闭，在自定义配置：runtime/custom_config.json里增加以下配置： -``` -"showYearMonthMenus": false -``` - - -## 使用cdn加速应该怎么配置cdn规则？ - -以腾讯云cdn为例，需要增加下面 3 个规则： -1. 针对静态文件缓存 30 天，文件类型：jpg;jpeg;png;svg;mp4;mov;ts;gif;webp;js;css -2. 针对动态缩略图缓存 30 天，网址：/site/smallimg/ -3. 针对所有文件，不缓存（这个放最下面权重最低，也就是除了上面两类文件之外，其它都不缓存） - -补充说明： -如果你的项目还存在其它静态资源需要缓存，可加入第一条规则中。 - - ## 更多问题如何联系？ 请打开官方网站查看底部QQ群和微信： diff --git a/www/content/Manual.md b/www/content/Manual.md index 055810f..e9a850e 100644 --- a/www/content/Manual.md +++ b/www/content/Manual.md @@ -20,6 +20,7 @@ | .url | 快捷方式 | 20K | | .jpg | 图片 | 500K | | .png | 图片 | 500K | +| .webp | 图片 | 500K | | .gif | 图片 | 500K | | .ico | 图标 | 50K | | .mp4 | 视频 | 100M | diff --git a/www/css/beauty.css b/www/css/beauty.css index 794c9a6..20b39cd 100644 --- a/www/css/beauty.css +++ b/www/css/beauty.css @@ -213,6 +213,7 @@ a:focus,button.btn:focus{outline-color:lightblue} .lampshow .audio-item .title{color:#999} .lampshow .audio-list-item .im_img{opacity:0.65} .lampshow .audio-list-item .title{color:#999} +.lampshow .markdown-body .highlight pre, .lampshow .markdown-body pre{color:#999} @media screen and (max-width: 1199px) { diff --git a/www/js/beauty.js b/www/js/beauty.js index 8f939bf..9997caf 100644 --- a/www/js/beauty.js +++ b/www/js/beauty.js @@ -999,11 +999,50 @@ var RC_LEFT = 37; RC_RIGHT = 39; RC_DOWN = 40; RC_ENTER = 13; + + //tv only + RC_NEXT_CHANNEL = 10007, //TODO: 待确认 + RC_PRV_CHANNEL = 10008, RC_BACK = 10009; RC_EXIT = 10182; + +var getNextSibling = function(el, way) { + var next = null; + var tagName = el.tagName.toLowerCase(); + if (way == 'right') { + next = tagName == 'a' ? $(el).parent().next() : $(el).next(); + }else if (way == 'left') { + next = tagName == 'a' ? $(el).parent().prev() : $(el).prev(); + } + + if (next && next.length > 0) { + next = next.find(tagName); + } + + return next; +}; + +var keyPress = function(way) { + var focusedEl = $(':focus'); + if (focusedEl.length > 0) { + var next = getNextSibling(focusedEl.get(0), way); + if (next) { + next.focus(); + }else { + console.warn('No next sibling'); + } + }else { + console.warn('No focused element'); + } +}; + +//handle key press $(document.body).on('keydown', function(e) { console.log('Key pressed', e.keyCode); - //TODO: handle key press - + if (e.keyCode == RC_RIGHT) { + keyPress('right'); + }else if (e.keyCode == RC_LEFT) { + keyPress('left'); + } }); \ No newline at end of file