dp-identity-api-archived

command module
v0.0.0-...-2f581d8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2018 License: MIT Imports: 20 Imported by: 0

README

dp-identity-api

Getting started
MongoDB
  • Run brew install mongodb
  • Run brew services start mongodb
kafka
  • Run brew install kafka
  • Run brew services start zookeeper
  • Run brew services start kafka
Usage

make debug to run locally

API Tests

To run the dp-api-tests against the dp-identity-api run make acceptance. This will run the API against a different (test) Mongo database which will be torn down after the tests.

Configuration
Environment variable Default Description
BIND_ADDR localhost:23800 The host and port to bind to
MONGODB_BIND_ADDR localhost:27017 The MongoDB bind address
MONGODB_DATABASE identities The MongoDB dataset database
MONGODB_COLLECTION identities MongoDB collection
HEALTHCHECK_INTERVAL 30s Time between self-healthchecks (time.Duration format)
HEALTHCHECK_TIMEOUT 2s The timeout that the healthcheck allows for checked subsystems
GRACEFUL_SHUTDOWN_TIMEOUT 5s The graceful shutdown timeout in seconds
Contributing

See CONTRIBUTING for details.

License

Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
Package provides HTTP Handlers/HandlerFunc's for creating, updating and deleting user identities
Package provides HTTP Handlers/HandlerFunc's for creating, updating and deleting user identities

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL