HTTP-Server

Choose Your Own Adventure

Be sure to checkout out the scope of the project for information on special features, routes, etc

Visit on the Web

karakelley.rocks

The server is deployed at karakelley.rocks where several public files/directories are currently being served. If you want to check the functionality and poke around without spinning up the server locally with your own directory, this is a great option.

Using Docker

Get latest docker image

$ docker pull klkelley/http-server:master.latest

Pull a Specific Image

To pull a specific image:

$ docker pull klkelley/http-sever:<IMAGE-NAME>

Visit the HTTP-Server DockerHub Repo to pick a specific image.

There are three different types of tagged images:

• master.latest which is considered to be the most up to date image associated with the master branch
• Images specific the latest build on a development branch, i.e. feat-get-request.latest.
• Immutable images for each merge to master. These are designated as master.<SHA> and are the only group of images that do not change.

Run project

Running the below command will automatically pull and run the image specified

$ docker run -it --rm -p 8080:8080 -v <DIRECTORY YOU WANT TO SERVE>:<PATH WHERE DIRECTORY WILL BE MOUNTED> klkelley/http-server:master.latest --port 8080 --directory <MOUNTED PATH>

An example: ex. docker run -it --rm -p 8080:8080 -v /Users/karakelley/:/var/public klkelley/http-server:master.latest --port 8080 --directory /var/public

Using Gradle

Build

$ gradle build 

Run project

The default port is set to 0 and can be set to specific port by passing a port number as an argument.

$ java -jar build/libs/http-server.jar -p <OPTIONAL PORT NUMBER> -d <OPTIONAL DIRECTORY PATH>

Run tests

$ gradle test

Scope of Project

Supported requests:

• GET
• POST
• PUT
• DELETE

Features: Basic authorization & Query Parameters

Basic Authorization credentials:

• username: admin
• password: chicago32

Special routes:

• /parse which supports query parameters
• /redirectme which will redirect you back to root

Without a directory: If you do not pass in a directory the root page will display "Hello World".

With a directory: If a requested directory contains an index.html file it will be served otherwise the directory listing will be served.

UML Diagrams

Two UML diagrams are served in the directory /files/UML. Here you will find a class diagram and package diagram illustrating the entire project.