Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sangupta/httpd
Simple HTTP server for development
https://github.com/sangupta/httpd
Last synced: 4 days ago
JSON representation
Simple HTTP server for development
- Host: GitHub
- URL: https://github.com/sangupta/httpd
- Owner: sangupta
- License: other
- Created: 2014-12-22T06:42:47.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T21:10:19.000Z (over 2 years ago)
- Last Synced: 2024-04-16T11:17:28.980Z (7 months ago)
- Language: Java
- Homepage: http://sangupta.com/projects/httpd
- Size: 35.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
httpd
=====
`httpd` is a simple HTTP server for development that serves the directory from which
it is run over HTTP. Directory listing and proper MIME types are supported.
The reason I wrote `httpd` was simple: When using windows machines I do not have to
install `python` or `nodejs` to run a simple server. For me, `Java` is always there
on the machines. Also, in some of our `Linux` environments we do not have the ability
to download and run `nodejs` - in such environments running a HTTP server via command
line to just transfer files, makes it very easy.
Been using it for a few months now and works for me. Some of the things I use this for:
* transferring huge files (in GBs) between machines
* testing my `github.com` blog
* testing prototypes that are static HTML/CSS/JS files
* and some more...
Changelog
---------
**Version 1.2.1**
* Added MIME extension for `log` files to `text/plain`
**Version 1.2.0**
* Added clean exit when a user presses Ctrl+C to end the session
**Version 1.1.0**
* Added configuration params: `port`, `path`, `noLogs`, `nosniff`, `noCache`
* Added default behavior to serve `index.html` or `index.htm` if present in the directory
* Added option to disable directory listing
* Added weak etags based on file name, time and size. Also, an option to disable etag generation.
**Version 1.0.0**
* Supports Directory Listing
* Supports correct MIME type
* Supports `If-Modified-Since` header
* Supports hidden-files by sending `NOT FOUND` status
Usage
-----
```text
NAME
httpd - A simple vanilla HTTP server for local development
SYNOPSIS
httpd [(-h | --help)] [(-nc | --noCache)] [(-ndl | --noDirList)]
[(-ne | --noEtag)] [(-ni | --noIndex)] [(-nl | --noLogs)]
[(-ns | --noSniff)] [(-p | --port )] [--path ]
OPTIONS
-h, --help
Display help information
-nc, --noCache
Return all files with a no-cache header for browsers. Default is
false.
-ndl, --noDirList
Do not show directory listing
-ne, --noEtag
Do not generate the weak ETAGs
-ni, --noIndex
Do not show index page by default
-nl, --noLogs
Do not show any logs when serving request
-ns, --noSniff
Add a `X-Content-Type-Options: nosniff` header to all responses
-p , --port
The port to run on. Default is 8180.
--path
The directory to run the server on. Default is current directory.
```
Downloads
---------
The binary can be downloaded directly from:
**1.2.0**: http://static.sangupta.com/binaries/httpd-1.2.0.jar
```
MD5: 7452a7b0653544a7d270df06e47c4a06
SHA1: 124197a24c2256e0f0bd36f8923809aa1292b198
```
**1.1.0**: http://static.sangupta.com/binaries/httpd-1.1.0.jar
```
MD5: edbc6d3fd27265d3183f71feb98a100c
SHA1: e1d5fa9676466651294263d40196c48d2ae69bb8
```
**1.0.0**: http://static.sangupta.com/binaries/httpd-1.0.0.jar
```
MD5: 7feeb06d6505313d381d3d3c4c53ba08
SHA1: 20fa6d9a0e7dea2a329f14bdebe305fda829a40d
```
Hacking
-------
If you would like to hack or use the server in an embedded mode, include the following Maven
dependency in your project.
```xml
com.sangupta
httpd
1.0.0
```
Versioning
----------
For transparency and insight into our release cycle, and for striving to maintain backward compatibility,
`httpd` will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the follow format:
`..`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
* Bug fixes and misc changes bump the patch
For more information on SemVer, please visit http://semver.org/.
License
-------
```
httpd - simple HTTP server for development
Copyright (c) 2014-2015, Sandeep Gupta
http://sangupta.com/projects/httpd
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```