{"id":39076239,"url":"https://github.com/cloud-gov/s3-broker","last_synced_at":"2026-01-17T18:26:52.681Z","repository":{"id":9806613,"uuid":"63402793","full_name":"cloud-gov/s3-broker","owner":"cloud-gov","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-18T18:04:26.000Z","size":15563,"stargazers_count":4,"open_issues_count":5,"forks_count":11,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-07-18T23:11:25.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloud-gov.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":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-07-15T07:53:00.000Z","updated_at":"2025-07-18T18:04:28.000Z","dependencies_parsed_at":"2024-01-17T01:17:31.630Z","dependency_job_id":"1dbe6a8e-547f-4a7a-8b0d-55f38335abf4","html_url":"https://github.com/cloud-gov/s3-broker","commit_stats":null,"previous_names":["cloudfoundry-community/s3-broker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cloud-gov/s3-broker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fs3-broker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fs3-broker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fs3-broker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fs3-broker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloud-gov","download_url":"https://codeload.github.com/cloud-gov/s3-broker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-gov%2Fs3-broker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28515475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T17:57:59.192Z","status":"ssl_error","status_checked_at":"2026-01-17T17:57:52.527Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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-17T18:26:52.569Z","updated_at":"2026-01-17T18:26:52.666Z","avatar_url":"https://github.com/cloud-gov.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS S3 Service Broker\n\nThis is a [Cloud Foundry Service Broker](https://docs.cloudfoundry.org/services/overview.html) for [Amazon S3](https://aws.amazon.com/s3/).\n\n## Installation\n\n### Local Development\n\nTo run the latest version of the broker without cloning the repository, install using `go install` (you must have [Go](https://golang.org/) already installed in your local machine):\n\n```\n$ go install github.com/cloud-gov/s3-broker\n$ s3-broker -port=3000 -config=\u003cpath-to-your-config-file\u003e\n```\n\nTo develop the broker, clone the repository and run it with `go run`:\n\n```\ngit clone git@github.com:cloud-gov/s3-broker.git \u0026\u0026 cd s3-broker\ngo run . -port=3000 -config=\u003cpath-to-your-config-file\u003e\n```\n\n### Cloud Foundry\n\nThe broker can be deployed to an already existing [Cloud Foundry](https://www.cloudfoundry.org/) installation:\n\n```\n$ git clone https://github.com/cloud-gov/s3-broker.git\n$ cd s3-broker\n```\n\nModify the [included manifest file](https://github.com/cloud-gov/s3-broker/blob/main/manifest.yml) to include your AWS credentials and optionally the [sample configuration file](https://github.com/cloud-gov/s3-broker/blob/main/config-sample.yml). Then you can push the broker to your [Cloud Foundry](https://www.cloudfoundry.org/) environment:\n\n```\n$ cp config-sample.yml config.yml\n$ cf push s3-broker\n```\n\n## Configuration\n\nRefer to the [Configuration](https://github.com/cloud-gov/s3-broker/blob/main/CONFIGURATION.md) instructions for details about configuring this broker.\n\nThis broker gets the AWS credentials from the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. It requires a user with some [IAM](https://aws.amazon.com/iam/) \u0026 [S3](https://aws.amazon.com/s3/) permissions. Refer to the [iam_policy.json](https://github.com/cloud-gov/s3-broker/blob/main/iam_policy.json) file to check what actions the user must be allowed to perform.\n\n## Usage\n\n### Managing Service Broker\n\nConfigure and deploy the broker using one of the above methods. Then:\n\n1. Check that your Cloud Foundry installation supports [Service Broker API Version v2.6 or greater](https://docs.cloudfoundry.org/services/api.html#changelog)\n1. [Register the broker](https://docs.cloudfoundry.org/services/managing-service-brokers.html#register-broker) within your Cloud Foundry installation;\n1. [Make Services and Plans public](https://docs.cloudfoundry.org/services/access-control.html#enable-access);\n1. Depending on your Cloud Foundry settings, you might also need to create/bind an [Application Security Group](https://docs.cloudfoundry.org/adminguide/app-sec-groups.html) to allow access to the different cluster caches.\n\n### Integrating Service Instances with Applications\n\nApplication Developers can start to consume the services using the standard [CF CLI commands](https://docs.cloudfoundry.org/devguide/services/managing-services.html).\n\n#### Binding to multiple instances\n\nIf the operator provides credentials for a Cloud Foundry user or client with the `cloud_controller.admin_read_only` scope, users can create application bindings and service keys that grant access to additional service instances in the same Cloud Foundry space. This can be useful for copying files between buckets.\n\n```sh\ncf bind-service my-app my-s3-instance -c '{\"additional_instances\": [\"my-additional-s3-instance\"]}'\n```\n\n## Contributing\n\nIn the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.\n\nHere are some ways _you_ can contribute:\n\n- by using alpha, beta, and prerelease versions\n- by reporting bugs\n- by suggesting new features\n- by writing or editing documentation\n- by writing specifications\n- by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)\n- by refactoring code\n- by closing [issues](https://github.com/cloud-gov/s3-broker/issues)\n- by reviewing patches\n\n### Submitting an Issue\n\nWe use the [GitHub issue tracker](https://github.com/cloud-gov/s3-broker/issues) to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any details that may be necessary to reproduce the bug, including your Golang version and operating system. Ideally, a bug report should include a pull request with failing specs.\n\n### Submitting a Pull Request\n\n1. Fork the project.\n1. Create a topic branch.\n1. Implement your feature or bug fix.\n1. Commit and push your changes.\n1. Submit a pull request.\n\n## Copyright\n\nCopyright (c) 2016 ape factory GmbH. See [LICENSE](https://github.com/cloud-gov/s3-broker/blob/main/LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-gov%2Fs3-broker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloud-gov%2Fs3-broker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-gov%2Fs3-broker/lists"}