https://github.com/derhuerst/casket

casket is an easy-to-use web file storage.
https://github.com/derhuerst/casket

gui http server

Last synced: about 1 month ago
JSON representation

casket is an easy-to-use web file storage.

• Host: GitHub
• URL: https://github.com/derhuerst/casket
• Owner: derhuerst
• License: isc
• Created: 2015-07-19T05:59:05.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-31T13:36:40.000Z (over 3 years ago)
• Last Synced: 2024-09-14T05:59:49.279Z (about 2 months ago)
• Topics: gui, http, server
• Language: JavaScript
• Homepage: https://github.com/derhuerst/casket#casket
• Size: 235 KB
• Stars: 12
• Watchers: 4
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        
# *casket*

***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), and it can stream any audio file to an AirPlay receiver.

![casket serving a directory](demo.png)

[![npm version](https://img.shields.io/npm/v/casket.svg)](https://www.npmjs.com/package/casket)

[![dependency status](https://img.shields.io/david/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket)

[![dev dependency status](https://img.shields.io/david/dev/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket#info=devDependencies)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/casket.svg)

[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)

[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

## Installing

```shell

npm install -g casket

```

## Usage

```

Usage:

	casket [--name my-little-server] [--dir ~/path/to/dir] [--airplay my-apple-tv.local]

Options:

    --name      -n  The name of the server, as shown in the GUI.

    --dir       -d  The directory to serve, default is the current directory.

    --readonly  -r  Do not allow deletion of files & uploads.

    --no-delete -w  Do not allow deletion of files.

    --no-upload -u  Do not allow file upload.

    --port      -p  Default is 8000.

    --airplay   -a  An AirPlay receiver to stream audio to.

```

## Contributing

If 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).