{"id":21085430,"url":"https://github.com/magec/capistrano3-consul","last_synced_at":"2025-05-16T11:31:17.863Z","repository":{"id":62554979,"uuid":"50517303","full_name":"magec/capistrano3-consul","owner":"magec","description":"Allow defining nodes using consul","archived":false,"fork":false,"pushed_at":"2020-03-27T07:31:59.000Z","size":16,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-29T00:41:34.060Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/magec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-27T15:34:50.000Z","updated_at":"2020-03-26T15:12:51.000Z","dependencies_parsed_at":"2022-11-03T05:30:29.386Z","dependency_job_id":null,"html_url":"https://github.com/magec/capistrano3-consul","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fcapistrano3-consul","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fcapistrano3-consul/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fcapistrano3-consul/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fcapistrano3-consul/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magec","download_url":"https://codeload.github.com/magec/capistrano3-consul/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254521818,"owners_count":22084983,"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":[],"created_at":"2024-11-19T20:33:13.563Z","updated_at":"2025-05-16T11:31:12.855Z","avatar_url":"https://github.com/magec.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Capistrano::Consul\n\nAllows capistrano to obtain the list of servers using a consul server\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'capistrano-consul'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install capistrano-consul\n\n## Usage\n\nIn capistrano.\n\n```ruby\nrequire 'capistrano/consul'\n```\n\nIn your code, then you can map a consul service to roles in capistrano\n```ruby\nconsul_service 'app_server', roles %w{web app}\n```\n\nAlso, you can use #consul_all_nodes to refer to every node in consul (useful for some tasks)\n\n```ruby\nconsul_all_nodes roles %w{web app}\n```\n\n## Configuration\n**consul_url** The api endpoint\n**consul_token** The Consul token needed if an ACL is specified\n**consul_ssh_gateway** You can configure an ssh gateway (i.e. a tunner that will be created before connecting to consul).\n\nExample:\n``` ruby\nset :consul_url, 'http://localhost:8500'\nset :consul_ssh_gateway, {\n      host: your.gateway.server,\n      user: ENV['USER'],\n      port: 8500, (this port will be used for tunneling)\n      options: {ssh options here}\n    }\n```\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-consul.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagec%2Fcapistrano3-consul","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagec%2Fcapistrano3-consul","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagec%2Fcapistrano3-consul/lists"}