From 4b4bba53596ebcd030dd26264877edd91d4c80d9 Mon Sep 17 00:00:00 2001 From: Aneesh Agrawal Date: Mon, 11 May 2015 06:31:20 -0400 Subject: [PATCH] Update docs with info about new option. --- docs/usage.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 09e82fa..40b0b14 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -95,6 +95,20 @@ end _Please refer to the "Available Buckets" menu above to find out which buckets are supported._ +## Custom cache root + +You can configure a custom root directory for the cache other than +`$HOME/.vagrant.d/cache/some-box` in your `Vagrantfile`. +This is only supported for single machine environments for similar reasons +as above, and additionally requires that the root directory already exists. + +```ruby +Vagrant.configure("2") do |config| + config.cache.scope = :box + config.cache.root = File.join ENV['XDG_CACHE_HOME'], 'vagrant-cachier' +end +``` + ## Custom cache buckets synced folders options For fine grained control over the cache bucket synced folder options you can use