{"id":40115904,"url":"https://github.com/dlcs/dlcs-varnish","last_synced_at":"2026-01-19T12:10:07.108Z","repository":{"id":71038602,"uuid":"105263414","full_name":"dlcs/dlcs-varnish","owner":"dlcs","description":"Varnish deployment via Docker with injection of VCL file from S3.","archived":false,"fork":false,"pushed_at":"2025-11-06T11:53:09.000Z","size":42,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-11-06T13:21:32.385Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/dlcs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-09-29T11:08:33.000Z","updated_at":"2024-05-09T14:36:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"86716085-8472-4a07-9f4c-aed39361d027","html_url":"https://github.com/dlcs/dlcs-varnish","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/dlcs/dlcs-varnish","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlcs%2Fdlcs-varnish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlcs%2Fdlcs-varnish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlcs%2Fdlcs-varnish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlcs%2Fdlcs-varnish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dlcs","download_url":"https://codeload.github.com/dlcs/dlcs-varnish/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlcs%2Fdlcs-varnish/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28567863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T08:53:44.001Z","status":"ssl_error","status_checked_at":"2026-01-19T08:52:40.245Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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-19T12:10:06.698Z","updated_at":"2026-01-19T12:10:07.099Z","avatar_url":"https://github.com/dlcs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dlcs-varnish\n\nDocker image using disk-backed Varnish instance for caching.\n\nOn startup it uses the AWS CLI to copy vcl file from location specified by `S3_VCL_FILE` environment variable. \nOptionally, a local file can also be configured for development purposes\n\n## Configuration\n\nThe following environment settings are expected:\n* `S3_VCL_FILE` - The location of a vcl file to use. Expected S3Uri as it is used by [aws s3 cp](https://docs.aws.amazon.com/cli/latest/reference/s3/cp.html) command.\n* `VARNISH_CACHE_FOLDER` - Folder where disk backed cache is stored.\n* `VARNISH_CACHE_SIZE` - Size of cache.\n* `AWS_PROFILE` - Required to run locally\n\nThe following configuration is optional:\n\n* `VARNISH_CACHE_FILE` - The name of varnish [storage file](https://varnish-cache.org/docs/trunk/users-guide/storage-backends.html#file) (e.g. `varnish_cache.bin`). If specified it is appended to `VARNISH_CACHE_FOLDER` to create file (if unspecified folder only is used)\n* `INCOMING_QUEUE` - the name of the queue that the cleanup handler listens to\n* `VARNISH_ADDRESS` - The location of varnish used by the cleanup handler. Defaults to localhost\n* `AWS_REGION` - The AWS region. Defaults to eu-west-1\n* `USE_LOCAL_CONFIG` - Whether to use a local config file over S3. \n\n*NOTE:* using `USE_LOCAL_CONFIG` requires a `mount`to be added to the `docker run` containing the VCL\n## Running\n\n```bash\n# build\ndocker build -t dlcs-varnish:local .\n\n# run\ndocker run -it --rm \\\n\t--env S3_VCL_FILE='s3://my-bucket/varnish-config.vcl' \\\n\t--env VARNISH_CACHE_FOLDER='/path/to/folder' \\\n\t--env VARNISH_CACHE_SIZE='100M' \\\n\t--env-file='/path/to/env' \\\n\t{REQUIRED FOR LOCAL RUNNING}--volume $HOME\\.aws\\credentials:/root/.aws/credentials:ro \\\n\t{OPTIONAL}--volume ./etc/:/mnt/varnish/ \\\n\tdlcs-varnish:local\n```\n## varnish-cleanup\n\nAdditionally, there is a standalone docker container for the cleanup handler. \n\n### Configuration\n\nRequired:\n* `AWS_PROFILE` - Required to run locally\n\nOptional:\n* `VARNISH_ADDRESS` - The location of varnish used by the cleanup handler. Defaults to localhost\n* `AWS_REGION` - The region used by the cleanup handler. Defaults to eu-west-1\n\n```bash\n# build\ndocker build -t dlcs-varnish-cleanup:local ./varnish-cleanup\n\n# run\ndocker run -it --rm \\\n\t--env-file='/path/to/env'\n\t{REQUIRED FOR LOCAL RUNNING}--volume=$HOME\\.aws\\credentials:/root/.aws/credentials:ro\n\tdlcs-varnish:local\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlcs%2Fdlcs-varnish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdlcs%2Fdlcs-varnish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlcs%2Fdlcs-varnish/lists"}