{"id":13413180,"url":"https://github.com/gojek/darkroom","last_synced_at":"2025-04-12T15:41:55.134Z","repository":{"id":35511702,"uuid":"194650048","full_name":"gojek/darkroom","owner":"gojek","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-05T10:19:49.000Z","size":3841,"stargazers_count":226,"open_issues_count":12,"forks_count":41,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-12-05T10:36:47.410Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.gojek.io/darkroom/","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/gojek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-01T10:17:08.000Z","updated_at":"2024-10-24T16:47:40.000Z","dependencies_parsed_at":"2024-06-18T21:18:15.073Z","dependency_job_id":"7329a4dc-f26b-47dc-841f-03ce3a0b145b","html_url":"https://github.com/gojek/darkroom","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gojek%2Fdarkroom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gojek%2Fdarkroom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gojek%2Fdarkroom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gojek%2Fdarkroom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gojek","download_url":"https://codeload.github.com/gojek/darkroom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248590887,"owners_count":21129906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-07-30T20:01:34.554Z","updated_at":"2025-04-12T15:41:55.110Z","avatar_url":"https://github.com/gojek.png","language":"Go","funding_links":[],"categories":["Images","Relational Databases","Images 图像处理","图片"],"sub_categories":["Search and Analytic Databases","Advanced Console UIs","SQL 查询语句构建库","检索及分析资料库"],"readme":"# Darkroom - Yet Another Image Proxy\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"website/static/img/darkroom-logo.png\" width=\"360\"\u003e\u003c/p\u003e\n\n[![build status](https://travis-ci.com/gojek/darkroom.svg?branch=master)](https://travis-ci.com/gojek/darkroom)\n[![Coverage Status](https://coveralls.io/repos/github/gojek/darkroom/badge.svg?branch=master)](https://coveralls.io/github/gojek/darkroom?branch=master)\n[![Docs latest](https://img.shields.io/badge/Docs-latest-blue.svg)](https://gojek.github.io/darkroom/)\n[![GoDoc](https://godoc.org/github.com/gojek/darkroom?status.svg)](https://godoc.org/github.com/gojek/darkroom)\n[![Go Report Card](https://goreportcard.com/badge/github.com/gojek/darkroom)](https://goreportcard.com/report/github.com/gojek/darkroom)\n[![GolangCI](https://golangci.com/badges/github.com/gojek/darkroom.svg)](https://golangci.com)\n[![GitHub Release](https://img.shields.io/github/release/gojek/darkroom.svg?style=flat)](https://github.com/gojek/darkroom/releases)\n[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  \n\n## Introduction\n\n[Darkroom](https://gojek.github.io/darkroom/) combines the [storage backend](pkg/storage) and the [image processor](pkg/processor) and acts as an `Image Proxy` on your image source.  \nYou may [implement](https://gojek.github.io/darkroom/docs/customization#custom-storage-example) your own `Storage` and `Processor` interfaces to gain custom functionality while still keeping other Darkroom Server functionality.  \nThe native implementations focus on speed and resiliency.\n\n## Features\n\nDarkroom supports several image operations which are documented [here](https://gojek.github.io/darkroom/docs/usage/size).\n\n## Installation\n\n```bash\ngo get -u github.com/gojek/darkroom\n```\nOther ways to run can be found [here](https://gojek.github.io/darkroom/docs/getting-started#running-the-image-proxy-service).\n\n## Metrics Support\n\nDarkroom supports Prometheus and StatsD for tracking and monitoring metrics.\nYou need to specify the metrics system by adding an environment variable, `METRICS_SYSTEM=prometheus/statsd`\n### Prometheus\nThe application exposes the metrics at \"http://\u003capplication_url\u003e/metrics\" endpoint. Since it's a pull based system, Prometheus server that is set up from docker-compose scrapes metrics from the application endpoint and its configuration can be changed in prometheus.yml. \n### StatsD\nIn order to use StatsD as your metrics system, you also need to add the following env variables, \n```\nMETRICS_STATSD_STATSDADDR=hostname:port\nMETRICS_STATSD_PREFIX=client-prefix\nMETRICS_STATSD_SAMPLERATE=sample-rate\nMETRICS_STATSD_FLUSHBYTES=flushbytes\n```\nThese are used to set up the StatsD client.\n### Grafana\nDarkroom currently supports grafana provisioning for Prometheus based metrics.\n\nGrafana is preconfigured with dashboards and Prometheus as the default data source:\n\n* Name: Prometheus\n* Type: Prometheus\n* Url: http://prometheus:9090\n* Access: proxy\n\nVisualization of Darkroom metrics(prometheus) on Grafana:\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"deployments/grafana/provisioning/dashboards/dashboard_example.png\"\u003e\u003c/p\u003e\n\n### Contributing Guide\n\nRead our [contributing guide](./CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Darkroom.\n\n## License\n\nDarkroom is [MIT licensed](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgojek%2Fdarkroom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgojek%2Fdarkroom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgojek%2Fdarkroom/lists"}