https://github.com/bazilio91/docker-distribution-api
Yet another Ruby client for docker-distribution
https://github.com/bazilio91/docker-distribution-api
api-client docker docker-distribution docker-registry ruby
Last synced: 3 months ago
JSON representation
Yet another Ruby client for docker-distribution
- Host: GitHub
- URL: https://github.com/bazilio91/docker-distribution-api
- Owner: bazilio91
- Created: 2017-03-14T09:39:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-15T07:52:48.000Z (about 9 years ago)
- Last Synced: 2025-10-07T16:12:02.434Z (9 months ago)
- Topics: api-client, docker, docker-distribution, docker-registry, ruby
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker::Distribution::Api
Simple swipley/docker-api like API client for docker-distribution with limited support of endpoints
[](https://travis-ci.org/bazilio91/docker-distribution-api)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'docker-distribution-api'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install docker-distribution-api
## Usage
API:
```ruby
Docker::Distribution::Api.logger # to set your logger
Docker::Distribution::Api.url= # set registry url
Docker::Distribution::Api.options= # set registry connection options
Docker::Distribution::Api.version # get registry version
Docker::Distribution::Api.tags('test') # get tags for repository 'test'
```
Manifest:
```ruby
Docker::Distribution::Api.url='http://localhost:5000'
Docker::Distribution::Api.options={:user => 'username', :password => 'password'} # basic auth
manifest = Docker::Distribution::Api::Manifest.find_by_tag('repository', 'tag') # get manifest
manifest.delete # delete manifest
```
## Development
After 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.
To 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bazilio91/docker-distribution-api.