https://github.com/knpwrs/ws

https://github.com/knpwrs/ws

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/knpwrs/ws
• Owner: knpwrs
• License: mit
• Created: 2012-04-06T17:24:13.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-04-09T14:46:59.000Z (almost 13 years ago)
• Last Synced: 2024-06-12T17:38:33.710Z (7 months ago)
• Language: Ruby
• Homepage:
• Size: 105 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ws(3) -- Simple Local Web Server

## SYNOPSIS

    :::text

    ws [-v | --verbose] [-d | --directory DIRECTORY] [-p | --port PORT] [-i | --index INDEXFILE] [-h | --help]

## INSTALLTION

To install, make sure you have the latest version of Ruby and RubyGems installed (tested and working on Ruby 1.9.3, RubyGems 1.8.19) and execute `gem install ws`.

## DESCRIPTION

`ws` is a simple script which launches a server for testing of static websites.

## EXAMPLES

### Launch a server with the current directory as the root

    :::text

    ws

### Launch a server with the current directory as the root, on port 1337

    :::text

    ws -p 1337

### Launch a server on port 1337, with the home folder as the root, in verbose mode

    :::text

    ws -d ~ -p 1337 -v

### Launch a server and use `default.htm` as the default file to serve.

    :::text

    ws -i default.htm

### Show help

    :::text

    ws -h

## MIME TYPES

When this script first executes it creates a file in your home directory called `.wsmimetypes.rb`. You can edit this file to change the mime types that are sent to the client on requests. If you need to reset the file back to its original state simply delete it -- the script will recreate it on the next run if it doesn't exist.

## AUTHOR

Kenneth Powers [`[email protected]`](mailto:[email protected])  

[http://bitbucket.org/KenPowers](http://bitbucket.org/KenPowers)