{"id":37225326,"url":"https://github.com/onsdigital/dp-image-api","last_synced_at":"2026-01-15T01:46:40.072Z","repository":{"id":40404772,"uuid":"263852393","full_name":"ONSdigital/dp-image-api","owner":"ONSdigital","description":"Digital Publishing image management API","archived":false,"fork":false,"pushed_at":"2025-10-09T11:57:19.000Z","size":603,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":14,"default_branch":"develop","last_synced_at":"2025-11-22T13:07:20.128Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ONSdigital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-14T08:01:00.000Z","updated_at":"2025-09-25T16:29:43.000Z","dependencies_parsed_at":"2025-04-10T08:24:45.113Z","dependency_job_id":"d5b2e524-bce0-4e17-ba77-f428ea50d728","html_url":"https://github.com/ONSdigital/dp-image-api","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/ONSdigital/dp-image-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ONSdigital%2Fdp-image-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ONSdigital%2Fdp-image-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ONSdigital%2Fdp-image-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ONSdigital%2Fdp-image-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ONSdigital","download_url":"https://codeload.github.com/ONSdigital/dp-image-api/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ONSdigital%2Fdp-image-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28441031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"ssl_error","status_checked_at":"2026-01-15T00:55:20.945Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-15T01:46:39.531Z","updated_at":"2026-01-15T01:46:40.058Z","avatar_url":"https://github.com/ONSdigital.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dp-image-api\n\nDigital Publishing Image API\n\n## Getting started\n\n* Run `make debug`\n\n### Dependencies\n\n* No further dependencies other than those defined in `go.mod`\n\n### Tools\n\nTo run some of our tests you will need additional tooling:\n\n#### Audit\n\nWe use `dis-vulncheck` to do auditing, which you will [need to install](https://github.com/ONSdigital/dis-vulncheck).\n\n#### Linting\n\nWe use v2 of golangci-lint, which you will [need to install](https://golangci-lint.run/docs/welcome/install).\n\n### Configuration\n\n| Environment variable         | Default                                                    | Description                                                                                                        |\n| ---------------------------- |------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|\n| BIND_ADDR                    | :24700                                                     | The host and port to bind to                                                                                       |\n| KAFKA_ADDR                   | localhost:9092                                             | The list of kafka broker hosts (publishing mode only)                                                              |\n| KAFKA_VERSION                | `1.0.2`                                                    | The version of (TLS-ready) Kafka                                                                                   |\n| KAFKA_MAX_BYTES              | 2000000                                                    | Maximum number of bytes in a kafka message (publishing mode only)                                                  |\n| KAFKA_SEC_PROTO              | _unset_                                                    | if set to `TLS`, kafka connections will use TLS [1]                                                                |\n| KAFKA_SEC_CLIENT_KEY         | _unset_                                                    | PEM for the client key [1]                                                                                         |\n| KAFKA_SEC_CLIENT_CERT        | _unset_                                                    | PEM for the client certificate [1]                                                                                 |\n| KAFKA_SEC_CA_CERTS           | _unset_                                                    | CA cert chain for the server cert [1]                                                                              |\n| KAFKA_SEC_SKIP_VERIFY        | false                                                      | ignores server certificate issues if `true` [1]                                                                    |\n| IMAGE_UPLOADED_TOPIC         | image-uploaded                                             | The kafka topic that will be produced by this service for image uploading events (publishing mode only)            |\n| STATIC_FILE_PUBLISHED_TOPIC  | static-file-published                                      | The kafka topic that will be produced by this service for image publishing events (publishing mode only)           |\n| GRACEFUL_SHUTDOWN_TIMEOUT    | 5s                                                         | The graceful shutdown timeout in seconds (`time.Duration` format)                                                  |\n| HEALTHCHECK_INTERVAL         | 30s                                                        | Time between self-healthchecks (`time.Duration` format)                                                            |\n| HEALTHCHECK_CRITICAL_TIMEOUT | 90s                                                        | Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (`time.Duration` format) |\n| IS_PUBLISHING                | true                                                       | Determines if the instance is publishing or not                                                                    |\n| ZEBEDEE_URL                  | \u003chttp://localhost:8082\u003e                                      | The URL of zebedee (publishing mode only)                                                                          |\n| MONGODB_BIND_ADDR            | localhost:27017                                            | The MongoDB bind address                                                                                           |\n| MONGODB_USERNAME             |                                                            | The MongoDB Username                                                                                               |\n| MONGODB_PASSWORD             |                                                            | The MongoDB Password                                                                                               |\n| MONGODB_DATABASE             | images                                                     | The MongoDB database                                                                                               |\n| MONGODB_COLLECTIONS          | ImagesCollection:images, ImagesLockCollection:images_locks | The MongoDB collections                                                                                            |\n| MONGODB_REPLICA_SET          |                                                            | The name of the MongoDB replica set                                                                                |\n| MONGODB_ENABLE_READ_CONCERN  | false                                                      | Switch to use (or not) majority read concern                                                                       |\n| MONGODB_ENABLE_WRITE_CONCERN | true                                                       | Switch to use (or not) majority write concern                                                                      |\n| MONGODB_CONNECT_TIMEOUT      | 5s                                                         | The timeout when connecting to MongoDB (`time.Duration` format)                                                    |\n| MONGODB_QUERY_TIMEOUT        | 15s                                                        | The timeout for querying MongoDB (`time.Duration` format)                                                          |\n| MONGODB_IS_SSL               | false                                                      | Switch to use (or not) TLS when connecting to mongodb                                                              |\n\n**Notes:**\n\n1. For more info, see the [kafka TLS examples documentation](https://github.com/ONSdigital//tree/main/examples#tls)\n\n### Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n### License\n\nCopyright © 2021-2022, Office for National Statistics (\u003chttps://www.ons.gov.uk\u003e)\n\nReleased under MIT license, see [LICENSE](LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonsdigital%2Fdp-image-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonsdigital%2Fdp-image-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonsdigital%2Fdp-image-api/lists"}