Xdir 帮助文档【介绍】

　　Xdir是一款使用基于PHP开发的目录列表程序，基于开源Directory Lister内核，无需数据库，体积小巧，功能完善，简单实用，免费开源，下载源码开箱即用，就是这么干脆 。

　　本程序是在Zdir v1.55二次开发中调优了部分程序而编译的，调优了部分程序功能、保留了绝大部分内核，基本实现本地化、部分内容完全中文语言化，体验感更好了。

如果页面提示Unable to open file! 或 无法打开索引文件，说明您的索引目录不可写，请自行检查目录权限，确保functions/caches该目录可读写。

为了降低资源消耗，文件索引存在24小时缓存，您可以访问index.php?c=cache&del=cache清除当前缓存并重新生成索引。

环境要求

• PHP >= 5.6(建议PHP 7.2，博主用的是PHP 7.4)
• 文件索引依赖于curl组件
• 如果需要获得更高级的文件管理功能，依赖于Fileinfo, iconv, zip, tar and mbstring组件（非必须）
• 如果是Linux环境，前端不显示文件和目录，那么可能是 PHP函数 scandir 被禁用，取消禁用即可；

本软件库已实现的主要功能

• [√] 列表目录浏览
• [√] MarkDown文件预览
• [√] CSS/JavaScript一键复制
• [√] 支持文件Hash查看
• [√] 支持在线图片预览 [√] 支持在线视频播放（支持.mp4格式和.m3u8）
• [√] 支持音乐播放
• [√] 支持文本查看器（支持的格式有.txt .sh .py .go .c .cpp）
• [√] 支持Office在线预览（支持.doc .docx .xls .xlsx .ppt .pptx）注意：如果是内网或IP访问方式不支持预览
• [√] 支持站内文件索引
• [√] 支持二维码生成分享使用
• [√] 文件删除
• [√] 文件搜索（建议搜索之前，通过底部更新索引一下，搜索效果更佳）
• [√] 文件上传
• [√] 密码验证（已于2022-03-25进行优化为密码验证页面方式）
• [√] 支持中文显示（Linux、Windows）
• [√] 手机界面支持搜索
• [√] 去除前台删除按钮转入文件管理操作
• [√] 首页支持密码验证登录
• [√] 支持程序放在子目录运行
• [√] 支持网站统计代码，程序将自动加载（可以新建static/tongji.js）
• [√] 支持广告设置（程序根目录下创建config.json可支持广告设置）
• [√] 文件夹与文件重新排序（默认文件夹在最前面）
• [√] 文件管理（创建，删除，修改，查看，快速查看，下载，压缩，复制和移动文件等）
• [√] 增加页面返回顶部控件
• [√] 优化了部分CSS

v1.50更新说明

此版本基于Zdir v1.55版本源码二次开发，现可将魔改Xdir放在子目录中运行。

• 优化CSS
• 修复一些BUG
• 可以新建static/tongji.js并添加网站统计代码，Xdir将自动加载
• 文件管理器的用户名、密码可以在config.php自定设置
• config.json可支持广告设置
• 此版本可将Xdir放在子目录中运行
  自v1.50版本开始，Zdir支持安装在子目录运行，比如您的站点目录为/data/wwwroot/default，您可以将Xdir源码放在/data/wwwroot/default/Xdir安装在子目录需要设置伪静态才能正常运行。

魔改Xdir v1.60.20220508更新说明

• 更新Tiny File Manager版本至2.4.7，优化google 的 js 库至本地，部分为国内CDN调用；
• 修复Tiny File Manager2.4.7直链问题，一级目录为文件夹的链接跳转修复；
• 修复Tiny File Manager2.4.7部分按钮弹窗后文本中文编码转换异常问题，现转换为中文编码；
• Tiny File Manager支持在Linux，Windows或Mac平台上在线或本地运行；
• 魔改Xdir v1.6.0支持PHP >= 7.4(建议PHP 5.6-7.2之间为好)；
• 如果需要获得更高级的文件管理功能，依赖于Fileinfo, iconv, zip, tar and mbstring组件（非必须）
• Xdir v1.60支持站点维护模式；

Nginx伪静态

• 需要个将默认首页设置为Xdir/index.php，比如index Xdir/index.php index.html index.htm index.php
• 需要在Server的配置中添加一行伪静态规则：rewrite ^/static/(.+) /Xdir/static/$1 break;

server {
  listen 80;
  server_name localhost;
  #access_log /var/log/Xdir.log combined;
  index Xdir/index.php index.html index.htm index.php;
  root /data/wwwroot/default;

  #rewrite
  rewrite ^/static/(.+) /Xdir/static/\ break;
  #error_page 404 /404.html;
  #error_page 502 /502.html;

  location ~ [^/]\.php(/|$) {
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_index index.php;
    include fastcgi.conf;
  }

  location ~ .*\.(gif|jpg|jpeg|png|bmp|swf|flv|mp4|ico)$ {
    expires 30d;
    access_log off;
  }
  location ~ .*\.(js|css)?$ {
    expires 7d;
    access_log off;
  }
  location ~ /\.ht {
    deny all;
  }
}

RewriteEngine On
DirectoryIndex Xdir/index.php
RewriteRule 'static/(.*)

"thedir"	=>	'/data/wwwroot/default',

其它安装说明

1. 可通过捐赠向笔者索引提供源码下载路径，后并解压到站点根目录下。
2. 将config.simple.php修改为config.php
3. 修改config.php 文件，设置网站关键词、描述等、密码等
4. 访问您的域名测试，文件管理用户名为admin，密码为config.php中设置的密码。
   更多说明请查看帮助文档：https://www.xuxiaokun.com/1046.html

config.php配置文件说明

打开config.php 配置文件

$siteinfo = array(
		"site_name"	=>	"<i class='fa fa-sitemap' aria-hidden='true'></i> Xdir软件库",
		"title"		=>	"Xdir 实用的目录列表程序",
		"keywords"	=>	"xdir,h5ai,Directory Lister,Fdscript,目录列表,目录索引",
		"description"	=>	"Xdir是一款使用PHP开发的目录列表程序，简单实用，免费开源，是Zdir源码二次开发版本。"
	);

• site_name：网站名称（左上角显示）
• title:设置站点标题（浏览器上显示）
• keywords：设置网站关键词
• description：设置网站描述

排除某个目录

//需要忽略的目录
	$ignore	= array(
		".",
		".git",
		"favicon.ico",
		"functions",
		"config.php",
		"index.php",
		"static",
		"LICENSE",
		"template",
		"cache.php",
		"indexes.php"
	);

如果您需要排除某个目录，请修改上面的$ignore变量。

支持添加统计代码

此版本可以在Xdir目录下新建一个tongji.js文件，里面放入网站统计代码，Zdir将自动加载，注意统计代码不需要script标签，百度统计代码测试通过，其它统计代码未做测试。

左右两侧悬浮广告设置

此版本支持网站左右两侧的悬浮广告设置，需要在Zdir目录下新建一个文件命名为config.json，内容参考：

{
"gg":{
    "gg_left":"<a href='https://xuxiaokun.com/d' target='_blank' rel="noopener noreferrer"><img src='https://xuxiaokun.com/c'></a>",
    "gg_right":"<a href='https://www.xuxiaokun.com/imgs/' target='_blank' rel="noopener noreferrer"><img src='https://www.xuxiaokun.com/imgs/2022/03/20220301.png'></a>"
}

其它功能使用说明

Markdown预览

　　Xdir支持Markdown文件预览，如果以readme.md命名，会直接出现“使用说明”按钮，如果是其它.md后缀的文件会出现一个“小眼睛”按钮，点击该按钮可以预览Markdown文件。

文件索引

　　为了快速找出需要的文件，Xdir提供了文件索引功能，可访问点击导航栏“文件索引”进行查看，访问该页面后可按Ctrl + F搜索文件，如下截图。

　　如果页面提示无法打开文件！，说明您的目录不可写，请自行检查目录权限，确保functions/caches该目录可读写。

　　为了降低资源消耗，文件索引存在24小时缓存，您可以访问index.php?c=cache&del=cache清除当前缓存并重新生成索引。

已知问题，当启用密码验证时，因两者冲突，更新索引会出现失败异常。

文件搜索

　　文件搜索功能依赖于“文件索引”，因此请先确保您的文件索引功能可以正常使用，并且已经成功生成了索引文件。然后在右上角输入搜索框进行搜索，如下截图。

文件管理

　　点击导航栏“文件管理”或者访问functions/admin.php进入，用户名为admin，密码为config.php中设置的密码。文件管理支持上传、修改、删除等功能，如下截图。

启用密码验证

1. 修改 config.php 将 "auth"  => FALSE 参数修改为 TRUE 
2. 再次访问首页会要求输入账号、密码，用户名为 admin 密码为 config.php 中设置的密码

注意事项：
　　应部分网友要求，添加了简单的密码验证，但此功能无法防止用户下载文件，只要知道真实地址依然可请求文件。

站点维护模式

移动手机访问

查看程序版本

找到路径 /functions/version.txt

注意事项

• 仅限于本工作室自用及赞助者通过密码获得访问与下载
• 访问者若出现页面乱码、无法下载时请与笔者联络，谢谢反馈。

Demo

• http://demo.yxnwork.com/
• http://demo.xuxiaokun.com/

联系博主及获取捐赠版

　　未经作者授权，请勿去掉底部版权。或者通过赞赏通道，留言您的网址可获取捐赠版，捐赠版可去除底部版权。

• Blog：http://www.xuxiaokun.com/
• 社区支持：http://bbs.yxnwork.com/

请笔者喝一杯咖啡

• 赞赏通道：https://www.xuxiaokun.com/zanshang

呜谢

　　魔改Xdir的诞生离不开以下开源项目，在此表示感谢，非常感谢xiaoz的耐心和指导并提供程序源文及技术咨询，原版版权归原作者。

• Zdir
• tinyfilemanager
• parsedown
• LayUI

本文最后更新于 2022-06-02 20:56