UNPKG

1.37 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**. It also supports file search [using Spotlight](https://github.com/derhuerst/node-spotlight).
4
5![casket serving a directory](demo.png)
6
7[![npm version](https://img.shields.io/npm/v/casket.svg)](https://www.npmjs.com/package/casket)
8[![dependency status](https://img.shields.io/david/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket)
9[![dev dependency status](https://img.shields.io/david/dev/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket#info=devDependencies)
10![ISC-licensed](https://img.shields.io/github/license/derhuerst/casket.svg)
11[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)
12
13
14## Installing
15
16```shell
17npm install -g casket
18```
19
20
21## Usage
22
23```
24Usage:
25 casket [--name my-little-server] [--dir ~/path/to/dir]
26
27Options:
28 --name -n The name of the server, as shown in the GUI.
29 --dir -d The directory to serve, default is the current directory.
30 --readonly -r Do not allow deletion of files & uploads.
31```
32
33
34## Contributing
35
36If 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).