跳转到主要内容

使用FastAPI构建的elfinder连接器,专门用于与jupyter服务器代理一起工作。

项目描述

ImJoy elFinder Binder Open In Colab PyPI Version Test

ImJoy elFinder是一个用于管理远程Jupyter服务器上数据的网络文件浏览器,专门为ImJoy项目构建,这是一个用于将计算工具部署给最终用户的开源平台。

前端使用elFinder构建,后端服务器使用Python。

什么是elFinder

elFinder是一个基于JavaScript的Web开源文件管理器,使用jQuery和jQuery UI编写,该项目由Studio 42维护。

在这里尝试他们的在线演示.

安装

需要Python 3.7+。

pip install -U imjoy-elfinder

基本用法

在您的终端中,运行以下命令

imjoy-elfinder --thumbnail

(缩略图选项启用图像缩略图,它将在您的当前文件夹下创建一个名为.tmb的文件夹,您也可以通过删除--thumbnail选项来禁用它。)

您将看到以下信息

==========ImJoy elFinder server is running=========
http://127.0.0.1:8765

根据您启动命令的位置,文件浏览器将显示当前文件夹作为根目录或HOME。

为了浏览您自己的目录,您可以通过传递--root-dir=/PATH/TO/MY/FOLDER手动设置根目录。

imjoy-elfinder-screenshot

与远程Jupyter笔记本服务器一起使用

如果您没有Jupyter笔记本,请运行

pip install -U jupyter

接下来,使用jupyter服务器代理扩展安装ImJoy elFinder

pip install -U imjoy-elfinder[jupyter]

现在像平时一样启动Jupyter笔记本,例如

jupyter notebook --ip=0.0.0.0

您将在http://YOUR_NOTEBOOK_URL/elfinder(取决于您的笔记本,例如,URL可以是http://localhost:8000/elfinder)看到一个网络文件浏览器。

使用MyBinder启动演示

  1. 在MyBinder上启动一个实例:https://mybinder.org/v2/gh/imjoy-team/imjoy-elfinder/master?urlpath=elfinder

  2. 您应该能看到一个文件浏览器。

安全考虑

请注意,在本地或通过互联网远程使用ImJoy elFinder存在潜在风险。

以下是一些建议

  1. 尽量将root-dir设置为您实际需要的文件所在的文件夹,尽可能小,避免暴露整个文件系统。

  2. 对于远程服务器,通过Jupyter代理使用它,这样访问将通过jupyter令牌或密码受到保护。此外,不要在Jupyter中关闭身份验证。

  3. 对于本地运行,我们使用允许源头(CORS)来保护来自随机网站访问,为此,请使用现代浏览器并保持其更新。

  4. 定期使用'pip install -U imjoy-elfinder'更新ImJoy elFinder,以防有安全更新。

开发

  • 对于开发者,您可以使用hupper启用热重载
hupper -m imjoy_elfinder
  • 使用以下命令安装所有开发需求
pip install -r requirements_dev.txt

您还可以通过添加 -w 参数来观看额外的文件(例如:hupper -m imjoy_elfinder -w imjoy_elfinder/templates/elfinder/main.js

许可证

MIT

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源代码分发

imjoy-elfinder-0.1.63.tar.gz (35.7 kB 查看哈希值)

上传时间 源代码

构建分发

imjoy_elfinder-0.1.63-py3-none-any.whl (37.1 kB 查看哈希值)

上传时间 Python 3