-
Notifications
You must be signed in to change notification settings - Fork 224
Commit
rename package, update metadata
- Loading branch information
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,20 @@ | ||
# Heroku Docker CLI plugin | ||
# Heroku Container Registry CLI plugin | ||
|
||
Heroku Toolbelt plugin to help configure, test and release apps to Heroku using Docker and Docker Compose. | ||
Heroku Toolbelt plugin to release apps to Heroku that are built on local containers. | ||
|
||
## Installation | ||
|
||
``` | ||
$ heroku plugins:install heroku-container-tools | ||
$ heroku plugins:install heroku-container-registry | ||
``` | ||
|
||
## Use | ||
|
||
See the [Dev Center Documentation](https://devcenter.heroku.com/articles/introduction-local-development-with-docker) for details of use. | ||
In a directory with a Dockerfile: | ||
|
||
``` | ||
$ heroku help container | ||
Usage: heroku container | ||
Use Docker to build and deploy Heroku apps | ||
Additional commands, type "heroku help COMMAND" for more details: | ||
container:init # create Dockerfile and docker-compose.yml | ||
container:release # create and release slug to app | ||
``` | ||
|
||
For help with a particular command: | ||
|
||
``` | ||
$ heroku help container:init | ||
Usage: heroku container:init | ||
-i, --image IMAGE # the Docker image from which to inherit | ||
-f, --force # overwrite existing Dockerfile and docker-compose.yml | ||
Creates a Dockerfile and docker-compose.yml for the app specified in app.json | ||
``` | ||
|
||
## Developing and contributing | ||
|
||
Checkout the plugin source code and tell the Heroku CLI to use your local version of the plugin (instead of the default one distributed with NPM). | ||
|
||
``` | ||
$ git clone https://github.com/heroku/heroku-container-tools.git | ||
$ cd heroku-container-tools | ||
$ npm install | ||
$ heroku plugins:link . | ||
$ heroku container:login | ||
$ heroku create | ||
$ heroku container:push | ||
$ heroku open | ||
``` | ||
|
||
### Add-ons | ||
|
||
The mapping from Heroku add-on specified in `app.json` to container configured in `docker-compose.yml` is tracked in `lib\app.json`. | ||
The mapping currently includes a limited subset of add-ons that we have tested. We welcome additions in the form of PRs. |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.