Ferver = File-Server

Ferver: A simple web app to serve files over HTTP packaged as a Ruby gem.

Build Status Code Climate Coverage Status Dependency Status Gem Version

Description

This is super, simple ruby gem to serve files over http, useful as a basic file server to quickly share files on your local network or something over the web. Just install the gem and go!

Here's the spec for ferver:

  • available over http
  • provide a list of files as html and json
  • ignore directories
  • serve files as individual files
  • minimal config
  • able to specify the directory to serve files from

Getting started

Using ferver could not be simpler - just install the ferver gem.

$ gem install ferver

Usage

You can run ferver from any directory, just pass in the directory you want to serve files from as a command line argument or leave blank to use the current directory.

Use the current directory
$ ferver
Use a specific directory

For exmple, to serve files from /Users/rob/Projects/ferver/ directory pass the path in as below;

$ ferver -d /Users/rob/Projects/ferver/
Command line help

For a list of arguments just use the -h switch.

$ ferver -h

Accessing files

The ferver gem uses Sinatra and runs on default port configuration so just point your browser to http://localhost:4567 to list the files.

HTML

List available files in your browser.

http://localhost:4567/files

JSON

Requesting content-type json, for exampled passing the header Accept: application/json will return the list of files as json.

curl -i -H "Accept: application/json" http://localhost:4567/files

Download a file

Files are available via their zero based index in the list, e.g. http://localhost:4567/files/:id

For example to download file appearing third in the list displayed earlier, request http://localhost:4567/files/2

Contributions

Please use the GitHub pull-request mechanism to submit contributions.

After cloning the repo, you can run the web application without having to install the gem package by running a Rake task named server, or it's alias s.

$ rake s

# or

$ rake s /path/to/dir

License

This project is available for use under the MIT software license. See LICENSE