{"id":30363203,"url":"https://github.com/custhomelab/docker-screenshot","last_synced_at":"2025-08-19T18:08:44.419Z","repository":{"id":41795157,"uuid":"183181738","full_name":"CusthomeLab/docker-screenshot","owner":"CusthomeLab","description":"📸","archived":false,"fork":false,"pushed_at":"2022-12-03T06:59:11.000Z","size":481,"stargazers_count":5,"open_issues_count":10,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-04T09:45:10.163Z","etag":null,"topics":["docker","screenshot","webgl"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/magelan/docker-screenshot","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CusthomeLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-24T08:15:24.000Z","updated_at":"2022-03-11T21:20:17.000Z","dependencies_parsed_at":"2023-01-23T04:30:15.757Z","dependency_job_id":null,"html_url":"https://github.com/CusthomeLab/docker-screenshot","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/CusthomeLab/docker-screenshot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CusthomeLab%2Fdocker-screenshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CusthomeLab%2Fdocker-screenshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CusthomeLab%2Fdocker-screenshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CusthomeLab%2Fdocker-screenshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CusthomeLab","download_url":"https://codeload.github.com/CusthomeLab/docker-screenshot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CusthomeLab%2Fdocker-screenshot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271198512,"owners_count":24717127,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["docker","screenshot","webgl"],"created_at":"2025-08-19T18:08:42.330Z","updated_at":"2025-08-19T18:08:44.411Z","avatar_url":"https://github.com/CusthomeLab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-screenshot\n\nA container that expose a HTTP endpoint to take screenshot of a webpage. \nIt use a puppeteer with the maximum Web GL capabilities that is possible inside a container. \n\n## How to make a screenshot\n\nIn fact this container does not take the screenshot for you... It listen for a custom DOM event called `screenshotTaken` that contain the actual screenshot. \n\nThe opened web page have:\n1. Generate an image (a screenshot or whatever else) \n2. Encode it in [a valid data URI](https://www.npmjs.com/package/data-urls)\n3. Trigger a DOM `CustomEvent` that contain the data URI\n\n### `screenshotTaken` custom event\n\n```js\nconst screenshotDataURI = 'data:image/png;base64,...'\n\ndocument.dispatchEvent(\n  new CustomEvent('screenshotTaken', {\n    detail: {\n      dataURI: screenshotDataURI,\n    },\n  }),\n)\n```\n\n## API\n\n### `GET /screenshot`\n\nParameter:\n- `target` (string): the web page to open\n\nLoad the web page given in the `target` parameter and return the screenshot contained in the `screenshotTaken` event of the target page (see the *How to make a screenshot* section for a detailed explanation). To respect the URL format the `target` parameter should be URL encoded.\n\nEg:\n```\nGET /screenshot?target=https%3A%2F%2Fplayground.babylonjs.com%2F%23FZTP31%231\n```\n\nThe target page have 60 seconds to return the `screenshotTaken` event. The endpoint will return an error 500 after 60 seconds.\n\n### `GET /capabilities/webgl.html`\n\n*Only available in debug mode*\n\nExpose the https://alteredqualia.com/tools/webgl-features/ webgl features detection page from inside the container.\n\n### `GET /health`\n\nCheck the container status. Return a 200 HTTP status if everythings is ok.\n\n## Environment variables\n\n- `DEBUG` (boolean): Increase the log outputed by the container (`false` by default)\n- `SENTRY_DSN` (string): The [sentry.io](https://sentry.io/) error reporting DSN (optional)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcusthomelab%2Fdocker-screenshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcusthomelab%2Fdocker-screenshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcusthomelab%2Fdocker-screenshot/lists"}