HeaderBuddy is an API commissioned by Xebia and developed by students of the Windesheim University Of Applied Sciences. The Headerbuddy API checks the configured HTTP headers of a webserver and returns an advice report based on the returned HTTP headers.
The following should be installed:
- Docker
- Maven
- Java 8 or higher
git clone https://github.com/xebia-research/headerbuddy.git
mvn package -DskipTests=true
Note: Make sure you are in the project directory.
docker-compose up -d db
Note: If port 3306 is unavailable use the following command instead: docker-compose run -d -p [custom port]:3306 db. Change custom port to a port number.
docker-compose up -d headerbuddy
docker-compose run -d --entrypoint "java -jar headerbuddy-[version].jar --key.required = fals
e" -p 8080:8080 headerbuddy
Note: Give the database container enough time (approximately 15 seconds) to start up before running the application container.
Note: If the port is unavailable, use docker-compose run -p and after the -p add a custom port number. Example: -p 1234:8080. The application now runs on "localhost:1234". Important: Keep the port number on the right of the ":" the same as configured in the application.properties file.
mvn verify
Note: Make sure the database container is running and the application container is not running.
Xebia HeaderBuddy is open-sourced licensed under the MIT license.