Skip to content

Commit b83c116

Browse files
author
Thilo Kogge
committed
Updated Readme
1 parent ee901fc commit b83c116

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ and provision Proxmox virtual machines.
2828

2929
## Installation
3030

31-
Download `gem` file from https://github.com/DataxPL/vagrant-proxmox/releases.
32-
3331
Install using standard Vagrant plugin method:
3432

3533
```
@@ -111,7 +109,7 @@ ENV['VAGRANT_DEFAULT_PROVIDER'] = 'proxmox'
111109
```
112110

113111
## Options
114-
112+
* `dry` Dont actually send data to the server.
115113
* `endpoint` URL of the JSON API endpoint of your Proxmox installation
116114
* `user_name` The name of the Proxmox user that Vagrant should use
117115
* `password` The password of the above user
@@ -147,6 +145,7 @@ ENV['VAGRANT_DEFAULT_PROVIDER'] = 'proxmox'
147145
* `pool` Resource pool to use.
148146
* `hostname_append_id` Appends guest ID to its' hostname. Note that this effectively sets the hostname to ID, if it was empty beforehand.
149147
* `full_clone` Creates full clone, instead of a linked one.
148+
* `lxc_ssh_public_keys` public keys to be added to the authorized keys file of the machine, one key per line.
150149

151150
## Debug RestClient Communication with Proxmox-Node
152151

@@ -158,7 +157,7 @@ $ RESTCLIENT_LOG=stdout vagrant up --provider proxmox
158157

159158
### Tips
160159

161-
* ensure your LXC-template is accessible from every proxmox node
160+
* ensure your LXC-template is accessable from every proxmox node
162161
* debug with `selected_node`-option enabled
163162

164163
## Build the plugin
@@ -171,11 +170,18 @@ $ rake build
171170

172171
For non-ruby folks. Needs `ruby` and `zlib` development headers (on Debian: `apt-get install ruby-dev zlib1g-dev`).
173172

173+
Use e.g. rvm to manage ruby versions. Do `rvm install "ruby-2.5.7"` to install the appropiate ruby version. Run `rvm use` then and check with `ruby --version` if it was properly activated. (If ruby complains about not using a login shell run `source ~/.rvm/scripts/rvm`)
174+
175+
You may then install dependencies and build with:
174176
```bash
175-
$ export GEM_HOME=~/.gem
176177
$ gem install bundler rake
177-
$ ~/.gem/bin/bundle
178+
$ bundle install
178179
$ rake build
180+
```
181+
182+
You can install the vagrant plugin then with `vagrant plugin install ./vagrant-proxmox-0.2.2.gem` (you might run into problems if you run it on a shell where you ran `rvm use` previously).
183+
184+
Optionally run the rspec tests with `rake spec`. (Make sure, that vagrant is installed in the ruby env you are using.)
179185

180186
Optionally run the rspec tests with
181187

0 commit comments

Comments
 (0)