Skip to content
This repository has been archived by the owner on Sep 26, 2021. It is now read-only.

Commit

Permalink
Merge pull request #2438 from dgageot/generic-doc
Browse files Browse the repository at this point in the history
Improve generic driver documentation
  • Loading branch information
jeanlaurent committed Nov 27, 2015
2 parents e9470d3 + 4aa3986 commit 5aff328
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/drivers/generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,16 @@ This is useful if you are using a provider that Machine does not support
directly or if you would like to import an existing host to allow Docker
Machine to manage.

The driver will perform a list of tasks on create:

- If docker is not running on the host, it will be installed automatically.
- It will generate certificates to secure the docker daemon
- The docker daemon will be restarted, thus all running containers will be stopped.

Options:

- `--generic-ip-address`: **required** IP Address of host.
- `--generic-ssh-key`: **required** Path to the SSH user private key.
- `--generic-ssh-key`: Path to the SSH user private key.
- `--generic-ssh-user`: SSH username used to connect.
- `--generic-ssh-port`: Port to use for SSH.

Expand All @@ -30,6 +36,6 @@ Environment variables and default values:
| CLI option | Environment variable | Default |
| -------------------------- | -------------------- | ------------------- |
| **`--generic-ip-address`** | `GENERIC_IP_ADDRESS` | - |
| **`--generic-ssh-key`** | `GENERIC_SSH_KEY` | `$HOME/.ssh/id_rsa` |
| `--generic-ssh-key` | `GENERIC_SSH_KEY` | `$HOME/.ssh/id_rsa` |
| `--generic-ssh-user` | `GENERIC_SSH_USER` | `root` |
| `--generic-ssh-port` | `GENERIC_SSH_PORT` | `22` |

0 comments on commit 5aff328

Please sign in to comment.