Skip to content

skyone-wzw/nginx-autoindex

Repository files navigation

Nginx AutoIndex 美化

基于 React & MUI 的 Nginx AutoIndex 美化,完美支持GitHub Markdown语法,用了都说好!

[demo] 小水管,第一次打开速度慢...

React + MUI + Remark + KaTeX

预览

已完成:

  1. 很好看(大概)
  2. 适配手机等窄设备
  3. 按文件名、大小、修改时间排序
  4. 简单自定义
  5. 暗色模式 & 跟随系统模式
  6. README.md & gfm
  7. 数学公式、代码高亮
  8. 切换目录无需重载网页
  9. README 支持折叠

计划:

  1. 欢迎 issue

有人用才有动力更新呐~

作者很懒,代码基本怎么直接怎么写,欢迎修改

FileTable.tsx 写的很烂,别问,问就是懒,不想动脑子

部署教程

从 Releases 下载最新版 nginx-autoindex.zip ,解压到一个任意目录(例如 /path/to/file

/path/to/file
├─nginx-autoindex
│ ├─app.js
│ ├─xxx.js
│ └─xxx.css
└─autoindex.html

编辑文件 /path/to/file/autoindex.html ,按需修改

<script>
    window.siteConfig = {
        name: "文件分享",      // 标题,默认为 `文件分享`
        title: undefined,     // 浏览器标题栏显示的标题,默认与 `name` 相同
        footer: "Powered by Nginx AutoIndex & Skyone Beautify", // 最底部的说明
        readme: true,         // 是否启用 README.md , 需要 766KB , gzip 压缩后约 220KB
                              // 异步加载, 不会堵塞主界面, 还有不错地加载动画
                              // 还可以选择配置用于渲染 markdown 的服务器的 URL
                              // 例如: "https://example.com/markdown/render"
                              // 个人感觉没必要, 220KB 已经足够小了
        before: true          // README.md 显示在文件列表前面还是后面
    }
</script>
<!--  其余部分  -->

编辑 Nginx 配置文件,模板如下:

server {
    listen 80;                    # 监听的端口
    server_name www.skyone.host;  # 你的域名
    charset utf-8;

    location = /autoindex.html {
        root   /path/to/file;     # 改为 nginx-autoindex.zip 解压后文件的目录
    }

    location ~ ^/nginx-autoindex/ {
        root   /path/to/file;     # 改为 nginx-autoindex.zip 解压后文件的目录
    }

    location / {
        root /var/www;            # 要分享的文件的位置
        autoindex on;
        add_after_body /autoindex.html;
    }
}

Docker 部署

下载 docker-compose.yml 到本地,直接运行即可。

wget https://raw.githubusercontent.com/skyone-wzw/nginx-autoindex/master/docker-compose.yml
docker-compose up -d

将要分享的内容挂载到 /var/www/html ,默认为同目录下的 data 文件夹。

可以直接使用环境变量进行配置,以下环境变量与 window.siteConfig 相对应

  • SITECONFIG_NAME
  • SITECONFIG_TITLE
  • SITECONFIG_FOOTER
  • SITECONFIG_README
  • SITECONFIG_BEFORE

更多截图

preview.webp markdown-dark.webp

phone-01.webp phone-02.webp