dp-topic-api

README

dp-topic-api

Enables greater flexibility in creating journeys through the website

Getting started

• Run make debug

Dependencies

• No further dependencies other than those defined in go.mod

Configuration

Environment variable	Default	Description
BIND_ADDR	:25300	The host and port to bind to
GRACEFUL_SHUTDOWN_TIMEOUT	5s	The graceful shutdown timeout in seconds (time.Duration format)
HEALTHCHECK_INTERVAL	30s	Time between self-healthchecks (time.Duration format)
HEALTHCHECK_CRITICAL_TIMEOUT	90s	Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format)
MONGODB_BIND_ADDR	localhost:27017	The MongoDB bind address
MONGODB_TOPICS_DATABASE	topics	The MongoDB topics database
MONGODB_TOPICS_COLLECTION	topics	MongoDB topics collection
MONGODB_CONTENT_COLLECTION	content	MongoDB content collection
MONGODB_USERNAME		MongoDB Username
MONGODB_PASSWORD		MongoDB Password
MONGODB_IS_SSL	false	is SSL is enabled for mongo server
ZEBEDEE_URL	http://localhost:8082	The URL to Zebedee (for authentication)
ENABLE_PRIVATE_ENDPOINTS	false	Enable private endpoints for the API
ENABLE_PERMISSIONS_AUTHZ	false	Enable/disable user/service permissions checking for private endpoints

Contributing

See CONTRIBUTING for details.

License

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

Released under MIT license, see LICENSE for details.