# README

dp-interactives-api

:warning: This repository will be archived in November 2023 as it is no longer in development. :warning:

Manages all interactives state and metadata (in persistent store). Talks to dp-interactives-importer via kafka.

Start docker-compose environment here: https://github.com/ONSdigital/dp-interactives-compose: docker-compose --env-file=start-backend.env
Run make debug
curl 'http://localhost:27500/health' | jq
Should see 200 with "status: OK"

Environment variable	Default	Description
BIND_ADDR	27500	The host and port to bind to
INTERACTIVES_API_URL	http://localhost:27500	The interactives api url
AWS_REGION	eu-west-1	The AWS region
UPLOAD_BUCKET_NAME	dp-interactives-file-uploads	Name of the S3 bucket
KAFKA_ADDR	`localhost:9092`	The address of Kafka brokers (comma-separated values)
KAFKA_VERSION	`1.0.2`	The version of Kafka
KAFKA_MAX_BYTES	2000000	Maximum number of bytes in a kafka message
KAFKA_SEC_PROTO	unset	if set to `TLS`, kafka connections will use TLS [1]
KAFKA_SEC_CLIENT_KEY	unset	PEM for the client key [1]
KAFKA_SEC_CLIENT_CERT	unset	PEM for the client certificate [1]
KAFKA_SEC_CA_CERTS	unset	CA cert chain for the server cert [1]
KAFKA_SEC_SKIP_VERIFY	false	ignores server certificate issues if `true` [1]
MONGODB_BIND_ADDR	localhost:27017	The MongoDB bind address
MONGODB_COLLECTION	interactives	The MongoDB interactives database
MONGODB_DATABASE	interactives-api	MongoDB collection
MONGODB_USERNAME	test	MongoDB Username
MONGODB_PASSWORD	test	MongoDB Password
MONGODB_IS_SSL	false	is SSL enabled for mongo server
KAFKA_CONSUMER_WORKERS	1	The maximum number of parallel kafka consumers
INTERACTIVES_GROUP	dp-interactives-api	The consumer group this application uses
ZEBEDEE_URL	http://localhost:8082	The URL of zebedee