dp-topic-api

command module

v0.22.0 Latest Latest Go to latest Published: Dec 20, 2023 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Enables greater flexibility in creating journeys through the website

Mongo db (can use dp-compose to stand up an instance in docker container, this requires docker)
Once you have a working mongo db instance, you will want to populate your database with topics; TODO further instructions/scripts needed
No further dependencies other than those defined in go.mod

Environment variable	Default	Description
BIND_ADDR	:25300	The host and port to bind to
GRACEFUL_SHUTDOWN_TIMEOUT	10s	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_USERNAME		MongoDB Username
MONGODB_PASSWORD		MongoDB Password
MONGODB_DATABASE	topics	The MongoDB topics database
MONGODB_COLLECTIONS	TopicsCollection:topics,ContentCollection:content	MongoDB collections
MONGODB_ENABLE_READ_CONCERN	false	Switch to use (or not) majority read concern
MONGODB_ENABLE_WRITE_CONCERN	true	Switch to use (or not) majority write concern
MONGODB_CONNECT_TIMEOUT	5s	The timeout when connecting to MongoDB (`time.Duration` format)
MONGODB_QUERY_TIMEOUT	15s	The timeout for querying MongoDB (`time.Duration` format)
MONGODB_IS_SSL	false	Switch to use (or not) TLS when connecting to mongodb
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