summaryrefslogtreecommitdiff
path: root/util/vagrant/readme.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-07-16 09:20:34 +0100
committerskullydazed <skullydazed@users.noreply.github.com>2019-07-16 01:20:34 -0700
commit29e9caa82bdfe898dd7fca82fcecf0cae2374859 (patch)
treead65f691513580f926465959b5a1169365c77959 /util/vagrant/readme.md
parenta32f7e1a25a8a200d838aa8256ffe39708fbd723 (diff)
Configure Vagrant to use qmk_base_container (#6194)
* Initial conversion of vagrant to use qmkfm/base_container * Fix vagrant when using docker provider * Workaround for VirtualBox VM restarts * Generalise Vagrant docs slightly and add FAQ
Diffstat (limited to 'util/vagrant/readme.md')
-rw-r--r--util/vagrant/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/util/vagrant/readme.md b/util/vagrant/readme.md
new file mode 100644
index 0000000000..e4b870a642
--- /dev/null
+++ b/util/vagrant/readme.md
@@ -0,0 +1,12 @@
+# QMK Vagrant Utilities
+
+## Dockerfile
+Vagrant-friendly `qmkfm/base_container`.
+
+In order for the Docker provider and `vagrant ssh` to function the container has a few extra requirements.
+
+* vagrant user
+* ssh server
+ * configured with expected public key
+* sudo
+ * passwordless for vagrant user