Home

Awesome

elFinder NodeJS Connector

Tests cov

This package allows you to use elFinder file manager with Nodejs. It currently implements LocalFileStorage only. Work is being done to allow ftp, ssh and cloud storage compatibility.

Demo

https://studio-42.github.io/elFinder/

Installation

npm install elfinder-node --save

or

yarn add elfinder-node

Usage

This package should be implemented as a middleware for Express server. You can see an example of how this package is used here.

Below is a summary of how it is used:

const express = require('express');
const app = express();
const elFinder = require('elfinder-node');

const roots = [
  {
    driver: elFinder.LocalFileStorage,
    URL: '/uploads/', //Required
    path: '/path/to/dir', //Required
    permissions: { read: 1, write: 1, lock: 0 },
  },
  {
    driver: elFinder.LocalFileStorage,
    URL: '/404/', //Required
    path: 'private', //Required
    permissions: { read: 1, write: 0, lock: 1 },
  },
];

app.use('/connector', elFinder(roots));

app.listen(process.env.PORT || 8000);

Configuration

The connector takes an array of volumes. All volumes are local files and must be created before the connector is initiated

permissions: function (path) {
  if (user.canAccess(path)) {
    return { read: 1, write: 1, lock: 0 };
  } else return { read: 0, write: 0, lock: 1 };
};

Contributing

There is more work to be done to make this project great. View the ROADMAP for a list of tasks to be done

Credits

Most of the work was done by @quantv