# nodexer > Browse directory trees and view files in the browser. Latest version **1.1.62** (published 2020-07-31) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install nodexer pnpm add nodexer yarn add nodexer bun add nodexer ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.1.62 | | Published | 2020-07-31 | | First published | 2020-07-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 278.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 38 | | Author | ему | | Maintainers | sixem | | Keywords | indexer, directory, lister, gallery, browser, files, listing | ## Links - npm: https://www.npmjs.com/package/nodexer - Repository: https://github.com/sixem/nodexer - Homepage: https://github.com/sixem/nodexer#readme - Issues: https://github.com/sixem/nodexer/issues - npm.io page: https://npm.io/package/nodexer ## Dependencies (8) - [pug](https://npm.io/package/pug.md) ^3.0.0 - [dotenv](https://npm.io/package/dotenv.md) ^8.2.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.19 - [express](https://npm.io/package/express.md) ^4.17.1 - [compression](https://npm.io/package/compression.md) ^1.7.4 - [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.5 - [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.10.5 - [express-basic-auth](https://npm.io/package/express-basic-auth.md) ^1.2.0 ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 1.1.62 (latest) — 2020-07-31 - 1.1.61 — 2020-07-30 - 1.1.6 — 2020-07-28 ## README

# nodexer npm David Travis (.com) A directory indexer written in Node. This is a highly customizable indexer with good support for mainly image and video files while also having most of the basic features of any other directory lister. It has a gallery mode, hoverable previews and persistent user-set settings like sorting and other small adjustments. It is also designed to have a slightly retro and simple feel to it which is why it does not use any flashy CSS or icon packs.

You can view a demo of the script [here](https://index.five.sh/). Please note that this is a very early version of this project, so it may contain a few bugs. # Install ### NPM ``` npm install nodexer ``` # Usage Require Nodexer: ```javascript var nodexer = require('nodexer'); ``` Basic initialization example: ```javascript var server = nodexer.run(3000, '/var/www/html/'); ``` This will spin up a webserver on `http://localhost:3000/` with the path set to `/var/www/html/`.

Another example. This time with a windows path and a few options set: ```javascript var server = nodexer.run(3000, 'E:/Downloads', { authentication : { users: { 'username': 'password' } }, gallery : { fit_content : true }, style : { compact : true } }); ``` This will also start a webserver on `http://localhost:3000/` with the path set to `E:/Downloads`. In this example it'll also enable a basic authentication system and a few other options options. A documentation of the available options can be found [here](https://github.com/sixem/nodexer/wiki/Documentation#options). # Development *Note: The development environment utilizes ES6.* Clone the repository and install the required `npm` packages: ``` git clone https://github.com/sixem/nodexer cd nodexer npm install ``` Create a `run.js` file with a simple initialization of the script: ```javascript var port = 3000, directory = '/var/www/html/'; require('./index.js').run(port, directory, { debug : true }); ``` Then start `run.js` through `nodemon`: ``` npm run dev ``` # Compile To compile the script run: ``` npm run compile ``` Hopefully everything looks OK. This will create a `lib` and a `dist` directory with the transpiled and minified files. To use the compiled source, edit `.env` and change the environment from `development` to `production`: ``` NODE_ENV=production ``` ## Other Projects This is a node version of the [eyy-indexer](https://github.com/sixem/eyy-indexer) which is written in PHP, so check that project out if you want something for PHP. ## Disclaimer As always, use this script at your own risk. There may exist bugs that i do not know of. ## License MIT License Copyright (c) 2020 ему (sixem) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --- _Source: https://npm.io/package/nodexer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._