UNPKG

1.52 kBMarkdownView Raw
1# *casket*
2
3***casket* is an HTTP server** that supports `GET`, `POST` and `DELETE` requests. It can respond in HTML, JSON and plain text format, **the HTML-version being a file management UI**.
4
5It also supports file search [using Spotlight](https://github.com/derhuerst/node-spotlight). For the specific needs of mine, it serves ad-hoc [M3U playlists](https://en.wikipedia.org/wiki/M3U) for any directory.
6
7![casket serving a directory](demo.png)
8
9[![npm version](https://img.shields.io/npm/v/casket.svg)](https://www.npmjs.com/package/casket)
10[![dependency status](https://img.shields.io/david/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket)
11[![dev dependency status](https://img.shields.io/david/dev/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket#info=devDependencies)
12![ISC-licensed](https://img.shields.io/github/license/derhuerst/casket.svg)
13[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)
14
15
16## Installing
17
18```shell
19npm install -g casket
20```
21
22
23## Usage
24
25```
26Usage:
27 casket [--name my-little-server] [--dir ~/path/to/dir]
28
29Options:
30 --name -n The name of the server, as shown in the GUI.
31 --dir -d The directory to serve, default is the current directory.
32 --readonly -r Do not allow deletion of files & uploads.
33 --port -p Default is 8000.
34```
35
36
37## Contributing
38
39If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/casket/issues).