{"id":22663709,"url":"https://github.com/yuuki/binrep","last_synced_at":"2025-04-12T07:44:07.797Z","repository":{"id":57595232,"uuid":"106684470","full_name":"yuuki/binrep","owner":"yuuki","description":"The static binary repository manager","archived":false,"fork":false,"pushed_at":"2017-12-10T15:50:26.000Z","size":8326,"stargazers_count":14,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T07:44:00.618Z","etag":null,"topics":["artifact-repository-manager","aws-s3","binary-repository-manager","go","repository"],"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/yuuki.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-12T11:34:33.000Z","updated_at":"2025-02-23T16:30:45.000Z","dependencies_parsed_at":"2022-09-26T19:52:48.255Z","dependency_job_id":null,"html_url":"https://github.com/yuuki/binrep","commit_stats":null,"previous_names":["yuuki/sbrepo"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuki%2Fbinrep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuki%2Fbinrep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuki%2Fbinrep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuki%2Fbinrep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuuki","download_url":"https://codeload.github.com/yuuki/binrep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248536978,"owners_count":21120684,"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":["artifact-repository-manager","aws-s3","binary-repository-manager","go","repository"],"created_at":"2024-12-09T12:32:46.661Z","updated_at":"2025-04-12T07:44:07.777Z","avatar_url":"https://github.com/yuuki.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Binrep\n======\n\n[![Build Status](https://travis-ci.org/yuuki/binrep.png?branch=master)][travis]\n[![Go Report Card](https://goreportcard.com/badge/github.com/yuuki/droot)][goreportcard]\n[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]\n\n[travis]: https://travis-ci.org/yuuki/binrep\n[goreportcard]: (https://goreportcard.com/report/github.com/yuuki/binrep)\n[license]: https://github.com/yuuki/binrep/blob/master/LICENSE\n\nBinrep is the static binary repository manager that uses Amazon S3 as file storage.\n\n# Overview\n\n`binrep` provides a simple way to store and deploy static binary files such as Go binaries, tarballs, images and web assets(css/javascript). `binrep` just pushes static binary files into a S3 bucket with directory layouts like `go get` does, and pulls the binaries from the bucket.\n\nThe deployment of (private) tools written by Go takes a lot more works, especially in the environment that has many servers, than that of LL scripts in a single file such as shell script, Perl, Python, Ruby). Git is an informat approach to the deployment, but git is not for binary management. The next approach is a package manager such apt or yum, but it takes a lot of trouble to make packages. The other approach is just to use a HTTP file server including S3, but it needs uniform and accessible location of binary files and the version management. There, `binrep` resolves the problems of static binary management.\n\n## Features\n\nThe following features will be supported.\n\n- Amazon S3 as storage backend\n- directory layout `\u003chost\u003e/\u003cuser\u003e/\u003cproject\u003e` like `go get` and [ghq](https://github.com/motemen/ghq) do\n- version management like [Capistrano](http://capistranorb.com/)\n- limitable network bandwidth\n\nThe following features will **not** be supported.\n\n- dependency management, that is supported by popular package managers such as Apt, Yum and Rubygems\n\n# Usage\n\n## Prepareation\n\n- Create S3 bucket for `binrep`.\n- Install `binrep` binary, see https://github.com/yuuki/binrep/releases .\n\n### Getting the latest version\n\n```sh\n$ curl -fsSL https://raw.githubusercontent.com/yuuki/binrep/master/scripts/install_latest_binary | bash /dev/stdin $GOOS $GOARCH | tar --exclude 'README.md' --exclude 'LICENSE' -xzf - -C /usr/local/bin/\n```\n\n- GOOS: 'linux' or 'darwin'\n- GOARCH: '386' or 'amd64'\n\n## Set AWS environment\n\n```sh\nexport AWS_REGION=us-east-1\nexport AWS_PROFILE=[your profile]\n```\n\nor\n\n```sh\nexport AWS_REGION=us-east-1\nexport AWS_ACCESS_KEY_ID=[your access key]\nexport AWS_SECRET_ACCESS_KEY=[your secret key]\n```\n\n## Set backend endpoint\n\n```sh\nexport BINREP_BACKEND_ENDPOINT='s3://binrep-bucket'\n```\n\nor `binrep --endpoint 's3://binrep-bucket' ...`\n\n## Commands\n\n### list\n\n```sh\n$ binrep list github.com/fujiwara/stretcher/20171013135903/\ngithub.com/fujiwara/stretcher/20171014110009/\ngithub.com/motemen/ghq/20171013140424/\ngithub.com/yuuki/droot/20171017152626/\ngithub.com/yuuki/droot/20171018125535/\ngithub.com/yuuki/droot/20171019204009/\n...\n```\n\n### show\n\n```sh\n$ binrep show github.com/yuuki/droot\nNAME                    TIMESTAMP       BINNARY1\ngithub.com/yuuki/droot  20171019204009  droot//2e6ccc3\n```\n\n### push\n\n```sh\n$ binrep push github.com/yuuki/droot ./droot\n--\u003e Uploading [./droot] to s3://binrep-bucket/github.com/yuuki/droot/20171020152356\nUploaded to s3://binrep-bucket/github.com/yuuki/droot/20171020152356\n--\u003e Cleaning up the old releases\nCleaned up 20171017152626\n```\n\n`push` supports to push multiple binary files.\n\n### pull\n\n```sh\n$ binrep pull github.com/yuuki/droot /usr/local/bin\n--\u003e Downloading s3://binrep-bucket/github.com/yuuki/binrep/20171019204009 to /usr/local/bin\n```\n\n# Directory layout on S3 bucket\n\n```\ns3://\u003cbucket\u003e/\u003chost\u003e/\u003cuser\u003e/\u003cproject\u003e/\u003ctimestamp\u003e/\n                                         -- \u003cbin\u003e\n                                         -- meta.yml\n```\n\nThe example below.\n\n```\ns3://binrep-repository/\n|-- github.com/\n    -- yuuki/\n        -- droot/\n            -- 20171013080011/\n                -- droot\n                -- meta.yml\n            -- 20171014102929/\n                -- droot\n                -- meta.yml\n    -- prometheus/\n        -- prometheus/\n            -- 20171012081234/\n                -- meta.yml\n                -- prometheus\n                -- promtool\n|-- ghe.internal/\n    -- opsteam/\n        -- tools\n            -- 20171010071022/\n                -- ec2_bootstrap\n                -- ec2_build_ami\n                -- meta.yml\n                -- mysql_create_slave_snapshot\n\n```\n\n# Terms\n\n- `release`: `\u003chost\u003e/\u003cuser\u003e/\u003cproject\u003e/\u003ctimestamp\u003e/`\n\n# How to release\n\nbinrep uses the following tools for the artifact release.\n\n- [goreleaser](https://goreleaser.com/)\n- [gobump](https://github.com/motemen/gobump)\n- [ghch](https://github.com/Songmu/ghch)\n\n```sh\nmake release\n```\n\n# License\n\n[The MIT License](./LICENSE).\n\n# Author\n\n[y_uuki](https://github.com/yuuki)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuuki%2Fbinrep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuuki%2Fbinrep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuuki%2Fbinrep/lists"}