diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/vagrant/boxes%2Finfo.html | |
new repository
Diffstat (limited to 'devdocs/vagrant/boxes%2Finfo.html')
| -rw-r--r-- | devdocs/vagrant/boxes%2Finfo.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/devdocs/vagrant/boxes%2Finfo.html b/devdocs/vagrant/boxes%2Finfo.html new file mode 100644 index 00000000..2b41e052 --- /dev/null +++ b/devdocs/vagrant/boxes%2Finfo.html @@ -0,0 +1,16 @@ +<h1 id="additional-box-information"> Additional Box Information </h1> <p>When creating a Vagrant box, you can supply additional information that might be relevant to the user when running <code>vagrant box list -i</code>. For example, you could package your box to include information about the author of the box and a website for users to learn more:</p> <div class="highlight"><pre class="highlight plaintext">brian@localghost % vagrant box list -i +hashicorp/precise64 (virtualbox, 1.0.0) + - author: brian + - homepage: https://www.vagrantup.com +</pre></div> +<h2 id="box-info"> Box Info </h2> <p>To accomplish this, you simply need to include a file named <code>info.json</code> when creating a <a href="base">base box</a> which is a JSON document containing any and all relevant information that will be displayed to the user when the <code>-i</code> option is used with <code>vagrant box list</code>.</p> <div class="highlight"><pre class="highlight json" data-language="json">{ + "author": "brian", + "homepage": "https://example.com" +} +</pre></div> +<p>There are no special keys or values in <code>info.json</code>, and Vagrant will print each key and value on its own line.</p> <p>The <a href="format">Box File Format</a> provides more information about what else goes into a Vagrant box.</p><div class="_attribution"> + <p class="_attribution-p"> + © 2010–2018 Mitchell Hashimoto<br>Licensed under the MPL 2.0 License.<br> + <a href="https://www.vagrantup.com/docs/boxes/info.html" class="_attribution-link">https://www.vagrantup.com/docs/boxes/info.html</a> + </p> +</div> |
