FDNS Gateway Microservice
This is the repository with the API gateway to connect the other microservices together.
Carefully read the following instructions for information on how to build, run, and test this microservice in your local environment.
Before you start
You will need to have the following installed before getting up and running locally:
- Docker, Installation guides
- Docker Compose, Installation guides
- Windows Users: This project uses
Make, please see Cygwin for running commands in this README
First, you'll need to build the image. You can build the image by running the following command:
Once the image has been built, you can run it with the following command:
To check if the microservice is running, just open the following URL in your browser:
This microservice is designed to be used with other microservices. Please look at the docker-compose file for more information.
To run the gateway with HTTPS you can configure the following environment variables:
GATEWAY_SSL_PORT: Which port you want the HTTPS to configure to (typically 443 or 8443).
GATEWAY_SSL_CERT: This is the value for your SSL certificate, ex: should begin with
GATEWAY_SSL_KEY: This is the value for your SSL private key, ex: should begin with
-----BEGIN PRIVATE KEY-----
Here are other various configurations and their purposes:
GATEWAY_PORT: This is a configurable port the application is set to run on HTTP
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.
This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.
You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html
The source code forked from other open source projects will inherit its license.
Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.
All comments, messages, pull requests, and other submissions received through CDC including this GitHub page are subject to the Presidential Records Act and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.