README.md in aptly_cli-0.2.9 vs README.md in aptly_cli-0.3.0
- old
+ new
@@ -2,40 +2,52 @@
[](https://travis-ci.org/sepulworld/aptly_cli)
[](http://badge.fury.io/rb/aptly_cli)
[](https://coveralls.io/github/sepulworld/aptly_cli?branch=master)
-A command line interace to execute [Aptly](http://aptly.info) commands againts remote Aptly API servers. Aptly-cli will allow you to interact with the file, repo, snapshot, publish, packages, graph and version API endpoints of your Aptly server.
+A command line interface to execute [Aptly](http://aptly.info) commands againts remote Aptly API servers. Aptly-cli will allow you to interact with the file, repo, snapshot, publish, packages, graph and version API endpoints of your Aptly server.
## Installation
-Add this line to your application's Gemfile:
+### Install Gem:
- $ ruby gem 'aptly_cli'
+ $ gem install aptly_cli
+
+or...
+
+### Install and run aptly-cli from Docker:
-And then execute:
+ # Optional: If you don't pull explicitly, `docker run` will do it for you
+ $ docker pull sepulworld/aptly-cli
- $ bundle
+ $ alias aptly-cli='\
+ docker run \
+ -v /etc/aptly-cli.conf:/etc/aptly-cli.conf \
+ -it --rm --name=aptly-cli \
+ sepulworld/aptly-cli'
-Or install it yourself as:
+(Depending on how your system is set up, you might have to add `sudo` in front of the above `docker` commands or add your user to the `docker` group).
- $ gem install aptly_cli
-
+If you don't do the `docker pull`, the first time you run `aptly-cli`, the `docker run` command will automatically pull [the `sepulworld/aptly-cli` image on the Docker Hub](https://hub.docker.com/r/sepulworld/aptly-cli/). Subsequent runs will use a locally cached copy of the image and will not have to download anything.
-Create a configuration file with aptly server and port, /etc/aptly-cli.conf (YAML syntax):
+Create a configuration file with aptly server and port, `/etc/aptly-cli.conf` (YAML syntax):
- ---
- :proto: http
- :server: 127.0.0.1
- :port: 8082
- :debug: false
+```yaml
+---
+:proto: http
+:server: 127.0.0.1
+:port: 8082
+:debug: false
+```
If you use Basic Authentication to protect your API, add username and password:
- :username: api-user
- :password: api-password
+```yaml
+:username: api-user
+:password: api-password
+```
Also make sure that your config file isn't world readable (```chmod o-rw /etc/aptly-cli.conf```)
If a configuration file is not found the defaults in the example configuration file above will be used
@@ -77,10 +89,10 @@
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-Ruby Minitest are impleneted using Docker container for functional tests
+Ruby Minitest are implemented using a Docker container for functional tests.
Rake tasks available:
```bash
rake build # Build aptly_cli-<version>.gem into the pkg directory