{"id":19466797,"url":"https://github.com/dena/capistrano-net_storage-s3","last_synced_at":"2025-04-25T10:34:20.380Z","repository":{"id":48287346,"uuid":"88029457","full_name":"DeNA/capistrano-net_storage-s3","owner":"DeNA","description":"Capistrano::NetStorage Plugin for Deployment via Amazon S3","archived":false,"fork":false,"pushed_at":"2023-08-07T13:47:10.000Z","size":46,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-03T20:04:20.115Z","etag":null,"topics":["capistrano","deployment","s3"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/DeNA.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-04-12T08:40:24.000Z","updated_at":"2024-10-04T20:08:09.000Z","dependencies_parsed_at":"2023-08-10T08:53:10.244Z","dependency_job_id":null,"html_url":"https://github.com/DeNA/capistrano-net_storage-s3","commit_stats":null,"previous_names":["denadev/capistrano-net_storage-s3"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeNA%2Fcapistrano-net_storage-s3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeNA%2Fcapistrano-net_storage-s3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeNA%2Fcapistrano-net_storage-s3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeNA%2Fcapistrano-net_storage-s3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeNA","download_url":"https://codeload.github.com/DeNA/capistrano-net_storage-s3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250798590,"owners_count":21489100,"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":["capistrano","deployment","s3"],"created_at":"2024-11-10T18:30:16.754Z","updated_at":"2025-04-25T10:34:15.360Z","avatar_url":"https://github.com/DeNA.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Gem Version](https://badge.fury.io/rb/capistrano-net_storage-s3.svg)](https://badge.fury.io/rb/capistrano-net_storage-s3)\n[![Test](https://github.com/DeNADev/capistrano-net_storage-s3/actions/workflows/test.yml/badge.svg)](https://github.com/DeNADev/capistrano-net_storage-s3/actions/workflows/test.yml?query=branch%3Amaster)\n# Capistrano::NetStorage::S3\n\n**Capistrano::NetStorage::S3** is a transport plugin of\n[Capistrano::NetStorage](https://github.com/DeNADev/capistrano-net_storage) to deploy application\nvia [Amazon S3](https://aws.amazon.com/s3/).\nAnd Capistrano::NetStorage is a plugin of [Capistrano](http://capistranorb.com/).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'capistrano-net_storage-s3', require: false\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install capistrano-net_storage-s3\n\n## Configuration\n\nSet Capistrano variables by `set name, value`.\n\n#### General Settings\n\n Name | Default | Description\n------|---------|------------\n `:net_storage_transport` | NO DEFAULT | Set `Capistrano::NetStorage::S3::Transport`\n `:net_storage_s3_bucket` | NO DEFAULT | S3 bucket name (e.g. `\"your-bucket-name\"` )\n `:net_storage_s3_archives_directory` | `\"/\"` | Directory for application archives in S3 bucket\n\n#### Settings for AWS\n\n Name | Default | Description\n------|---------|------------\n `:net_storage_s3_aws_access_key_id` | `ENV['AWS_ACCESS_KEY_ID']` | AWS Access Key ID\n `:net_storage_s3_aws_secret_access_key` | `ENV['AWS_SECRET_ACCESS_KEY']` | AWS Secret Access Key\n `:net_storage_s3_aws_session_token` | `ENV['AWS_SESSION_TOKEN']` | AWS Session Token\n `:net_storage_s3_aws_region` | `ENV['AWS_DEFAULT_REGION']` | AWS Region\n `:net_storage_s3_aws_profile` | `ENV['AWS_DEFAULT_PROFILE']` | AWS Profile\n `:net_storage_s3_aws_config_file` | `ENV['AWS_CONFIG_FILE']` | AWS Config File\n\n#### Other Settings\n\n**NOTE: We strongly recommend the defaults for integrity and performance. Change at your own risk.**\n\n Name | Default | Description\n------|---------|------------\n `:net_storage_s3_max_retry` | `3` | Max retry to download from S3 to each servers\n\nSee also\n[the configuration section of Capistrano::NetStorage](https://github.com/DeNADev/capistrano-net_storage#configuration).\n\n## Usage\n\nEdit Capfile:\n\n```ruby\n# Load DSL and Setup Up Stages\nrequire 'capistrano/setup'\n\n# Includes default deployment tasks\nrequire 'capistrano/deploy'\n\n# Includes tasks from other gems included in your Gemfile\nrequire \"capistrano/net_storage/plugin\"\ninstall_plugin Capistrano::NetStorage::Plugin\n\n# Load transport plugin for Capistrano::NetStorage\nrequire 'capistrano/net_storage/s3'\n```\n\nEdit your `config/deploy.rb`:\n\n```ruby\nset :net_storage_transport, Capistrano::NetStorage::S3::Transport\nset :net_storage_config_files, Pathname('path/to/config').glob('*.yml')\n\n# These settings upload archives to s3://bucket-for-deployment/api/#{sha1_hash}.tar.gz\nset :net_storage_s3_bucket, 'bucket-for-deployment'\nset :net_storage_s3_archives_directory 'api'\n\nset :net_storage_s3_aws_config_file, '~/.aws/config'\n# set :net_storage_s3_aws_profile, 'some-name' # If you are using multiple profiles\n```\n\n## License\n\nAvailable as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\nCopyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdena%2Fcapistrano-net_storage-s3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdena%2Fcapistrano-net_storage-s3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdena%2Fcapistrano-net_storage-s3/lists"}