Skip to content

Latest commit

 

History

History
110 lines (68 loc) · 7.76 KB

README.zh-CN.md

File metadata and controls

110 lines (68 loc) · 7.76 KB
Raw

OneDrive-Index（一键部署Vercel版）

English | 简体中文

本项目fork自spencerwooo/onedrive-vercel-index，基于原作者于2023年6月24日归档的版本并进行了一些小修改，让您可以一键部署在完全免费托管的Vercel，在一个网页中展示、分享、预览和下载您的OneDrive文件。具体部署方法请参考下面的说明。

本版本只测试通过E5开发者帐户，其他类型的OneDrive帐户有待进一步测试。

修改说明

  • 本版本主要把原本需要在config/目录下的api.config.js和site.config.js这两个配置文件中设置的一些变量搬到了Vercel的环境变量中进行设置。如此便无须——先fork原仓库——然后手动修改配置文件——再部署，而是可以直接点击本文档中的一键部署按钮，在部署过程中输入环境变量的值，然后完成部署。

  • 再就是本版本设定了当完成OAuth认证后，自动关闭OAuth认证通道，以防有心人通过OAuth认证的网址链接就轻易地获取到用户的配置信息。

在线预览

本一键部署版的在线预览 | 原作者提供的在线预览（已暂停维护）

demo

部署方法

前期准备

  1. 设置OneDrive帐户的API权限：
  • 本项目是通过调用OneDrive的API来获取文件列表以及下载链接的，所以设置OneDrive帐户的API权限是必须的，获取方法请参考原作者编写的使用文档。

需要设置的API权限为以下三个：user.read、files.read.all、offline_access。

  1. 准备好在Vercel部署时填写的五个必要环境变量（点击查看说明）的值：

部署到Vercel

  1. 当您做好准备工作，就可以点击下面的按钮进行部署了：

Deploy with Vercel

  • 如果你有需要密码保护的目录：

Deploy with Vercel with NEXT_PUBLIC_PROTECTED_ROUTES

  • 如果你有多个OneDrive帐户需要使用同一个Redis数据库：

Deploy with Vercel with KV_PREFIX

  • 如果你需要部署多个OneDrive-Index同时都有需要密码保护的目录：

Deploy with Vercel with NEXT_PUBLIC_PROTECTED_ROUTES & KV_PREFIX

  1. 初次部署成功后，部署的页面上去是404的，因为我们还需要连接到Redis数据库。

REDIS_URL：如果您是第一次接触Redis数据库，那么强烈推荐您使用免费且与Vercel深度合作的Upstash，详细参考Vercel Integration，按说明在Vercel的Upstash集成中设置好（简单说就是在Upstash的Redis选项卡中新建一个数据库，再在Vercel Integrations中新建集成，把刚部署的OneDrive-Index项目与Redis数据库进行关联），它会自动填入项目部署后的环境变量中。

  1. REDIS_URL设置成功后，再重新部署一次项目。

  2. 部署成功后，当您第一次访问您的onedrive-vercel-index页面时，会引导你进行OAuth认证（相当简单），详情请参考原作者编写的说明文档。

环境变量

必要变量

名称 描述 原路径 说明
NEXT_PUBLIC_SITE_TITLE 展示页面的标题 config/site.config.js 例如：尼加拉瓜首富的OneDrive
USER_PRINCIPAL_NAME 您的OneDrive帐户 config/site.config.js 字母大小写必须一致
BASE_DIRECTORY 您要分享的OneDrive目录 config/site.config.js （格式为/目录名），根目录则填写/
CLIENT_ID 您在微软Azure注册的应用程序客户端ID config/api.config.js 原作者提供的已过期，建议自己注册一个，有效期可以设到两年（反正也要设置帐户的API权限，顺道咯）。获取方式参照原作者编写的使用文档
CLIENT_SECRET 您在微软Azure注册的应用程序客户端密钥 config/api.config.js 获取方式同上，特别注意这个需要对原密钥进行AES加密（可在原作者编写的使用文档中进行）

可选变量

名称 描述 原路径 说明
NEXT_PUBLIC_PROTECTED_ROUTES 需要密码访问的文件夹路径 config/site.config.js 格式：/route1,/route2， 多个路径使用,间隔
NEXT_PUBLIC_EMAIL 显示在右上角的联系Email config/site.config.js example@example.com
KV_PREFIX 用于KV存储（键值对存储）的前缀 config/site.config.js Upstash只提供一个免费的Redis数据库，如果想要部署多个OneDrive-Index，就可为不同的Index设置不同的KV_PREFIX值，那么就不会有键值冲突了

说明文档

更多玩法请查阅原作者编写的使用文档

安全风险

  • 在原作者的存档版本中，部署者的OneDrive账户userPrincipalName、clientId和obfuscatedClientSecret都会暴露在网页的源代码中。

本版本在执行OAuth认证过程时会检查是否已经通过了认证，若已通过认证则会重定向到主页，否则才会继续进行OAuth认证过程。如此访问者便不能通过访问OAuth认证的链接地址轻易获取你的clientId 和clientSecret了。

  • 因为Next.js的设计决策，以NEXT_PUBLIC_开头的环境变量不仅在服务器端可用，而且在客户端（浏览器）也可用。这意味着任何NEXT_PUBLIC_前缀的环境变量都会被包含在构建的JavaScript文件中，并会被发送到用户的浏览器。因此，任何访问你的网站的人都可以通过查看网站的源代码或网络请求来查看这些环境变量的值。

本版本把userPrincipalName、clientId、obfuscatedClientSecret以及baseDirectory变量使用了非NEXT_PUBLIC_前缀的环境变量，尽可能让网站浏览者不能轻易获取你的OneDrive帐号、ClientID以及ClientSecret等信息。

待办事项

  • 将密码放在环境变量中，而不是加密目录下的.password文件中。

不过如此便比较难为不同的加密目录设置不同的访问密码了。

  • 重新设计LOGO。原始LOGO的对比度太低，与页面上其他图标和字体的风格不够一致。

License

MIT License

© 2021-2023 spencer woo

© 2023 iRedScarf

Made by spencer woo | Modified by iRedScarf