Docker

Docker is the easiest way to run the hub on a single machine, and can also be used for development.

docker run -p 80:80 flightstats/hub:latest

To simplify deployment, this version of the hub does not use AWS services, and is not intended for long term storage.

Docker Settings

To change configurable hub settings:

  1. Copy hub.properties
  2. Modify the desired settings locally
  3. Run docker with
docker run -v /full/path/to/hub.properties:/etc/hub/hub.properties -p 80:80 flightstats/hub:latest
  1. Verify your properties in the running hub

Local Docker with AWS

  1. Use aws_hub.properties as shown above.
  2. Create an S3 bucket
  3. Create an IAM role
  4. Modify the docker command to use aws_hub.properties and your credentials. Your credentials need to match ‘aws.credentials’ in the aws_hub.properties file.
  5. (Optional) increase the JVM’s memory settings by appending min and max values ‘1g 2g’
docker run -v /full/path/to/aws_hub.properties:/etc/hub/hub.properties -v /full/path/to/hub_test_credentials.properties:/etc/hub/hub_test_credentials.properties -p 80:80 flightstats/hub:latest 1g 2g

Development

You can also use Docker to do development with the hub on you local machine.

bash localDocker.sh
  Successfully built 608be75e8038
  Now run the following command using the image id above:
docker run -p 80:80 608be75e8038

More detailed instructions for active development

These instructions will allow you to run the hub without Docker.

For OSX users:

  • install java 8
  • install homebrew
  • download the code git clone https://github.com/flightstats/hub.git
  • build ./gradlew build

Using IntelliJ:

  • Download and install IntelliJ
  • Start IntelliJ
  • Checkout from version control - https://github.com/flightstats/hub
  • Import gradle project using gradle 1.8 using /usr/local/Cellar/gradle18/1.8/libexec
  • Install the lombok plugin
  • Enable annotation processing
  • Run SingleHubMain with VM Options : 
    -Xmx2g -Xms2g -Dapp.url=http://localhost:8080/
  • install node - http://nodejs.org/download/
  • cd src/test/integration/
  • run install.sh
  • create integration_config_local.js with 
    hubDomain='localhost:9080';
integrationTestPath =  '';
  • jasmine-node –captureExceptions –forceexit .

Using DynamoDB Local

  • Download
  • Install it somewhere
  • run java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -inMemory
  • create src/main/resources/default_local.properties with dynamo.endpoint=localhost:8000

Gradle

To run gradle tests locally, run this command from the hub root directory

gradle --debug clean test

You will need to have AWS credentials installed:

  • create src/main/resources/default_local.properties with aws.credentials=/path/to/hub_test_credentials.properties
Tags: