command
module
Version:
v1.4.0
Opens a new window with list of versions in this module.
Published: Jan 17, 2023
License: MIT
Opens a new window with license information.
Imports: 7
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
dp-image-api
Digital Publishing Image API
Getting started
Dependencies
- No further dependencies other than those defined in
go.mod
Configuration
Environment variable |
Default |
Description |
BIND_ADDR |
:24700 |
The host and port to bind to |
KAFKA_ADDR |
localhost:9092 |
The list of kafka broker hosts (publishing mode only) |
KAFKA_VERSION |
1.0.2 |
The version of (TLS-ready) Kafka |
KAFKA_MAX_BYTES |
2000000 |
Maximum number of bytes in a kafka message (publishing mode only) |
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] |
IMAGE_UPLOADED_TOPIC |
image-uploaded |
The kafka topic that will be produced by this service for image uploading events (publishing mode only) |
STATIC_FILE_PUBLISHED_TOPIC |
static-file-published |
The kafka topic that will be produced by this service for image publishing events (publishing mode only) |
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) |
IS_PUBLISHING |
true |
Determines if the instance is publishing or not |
ZEBEDEE_URL |
http://localhost:8082 |
The URL of zebedee (publishing mode only) |
MONGODB_BIND_ADDR |
localhost:27017 |
The MongoDB bind address |
MONGODB_USERNAME |
|
The MongoDB Username |
MONGODB_PASSWORD |
|
The MongoDB Password |
MONGODB_DATABASE |
images |
The MongoDB database |
MONGODB_COLLECTIONS |
ImagesCollection:images, ImagesLockCollection:images_locks |
The MongoDB collections |
MONGODB_REPLICA_SET |
|
The name of the MongoDB replica set |
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 |
Notes:
- For more info, see the kafka TLS examples documentation
Contributing
See CONTRIBUTING for details.
License
Copyright © 2021-2022, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
¶
Directories
¶
Click to show internal directories.
Click to hide internal directories.