| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE topic
|
|---|
| 3 | PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 4 | <topic xml:lang="en-us" id="sharedfolders">
|
|---|
| 5 | <title>Shared Folders</title>
|
|---|
| 6 |
|
|---|
| 7 | <body>
|
|---|
| 8 | <p>
|
|---|
| 9 | With the <i>shared folders</i> feature of
|
|---|
| 10 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you can access files of your host system from
|
|---|
| 11 | within the guest system. This is similar to how you would use
|
|---|
| 12 | network shares in Windows networks, except that shared folders do
|
|---|
| 13 | not require networking, only the Guest Additions. Shared folders
|
|---|
| 14 | are supported with Windows 2000 or later, Linux, and Oracle
|
|---|
| 15 | Solaris guests. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes experimental support for
|
|---|
| 16 | Mac OS X and OS/2 guests.
|
|---|
| 17 | </p>
|
|---|
| 18 | <p>
|
|---|
| 19 | Shared folders physically reside on the <i>host</i>
|
|---|
| 20 | and are then shared with the guest, which uses a special file
|
|---|
| 21 | system driver in the Guest Additions to talk to the host. For
|
|---|
| 22 | Windows guests, shared folders are implemented as a pseudo-network
|
|---|
| 23 | redirector. For Linux and Oracle Solaris guests, the Guest
|
|---|
| 24 | Additions provide a virtual file system.
|
|---|
| 25 | </p>
|
|---|
| 26 | <p>
|
|---|
| 27 | To share a host folder with a virtual machine in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>,
|
|---|
| 28 | you must specify the path of the folder and choose a
|
|---|
| 29 | <i>share name</i> that the guest can use to access
|
|---|
| 30 | the shared folder. This happens on the host. In the guest you can
|
|---|
| 31 | then use the share name to connect to it and access files.
|
|---|
| 32 | </p>
|
|---|
| 33 | <p>
|
|---|
| 34 | There are several ways in which shared folders can be set up for a
|
|---|
| 35 | virtual machine:
|
|---|
| 36 | </p>
|
|---|
| 37 | <ul>
|
|---|
| 38 | <li>
|
|---|
| 39 | <p> In the window of a running VM, you select <b outputclass="bold">Shared
|
|---|
| 40 | Folders</b> from the <b outputclass="bold">Devices</b> menu, or click the folder icon on
|
|---|
| 41 | the status bar in the bottom right corner. </p>
|
|---|
| 42 | </li>
|
|---|
| 43 | <li>
|
|---|
| 44 | <p>
|
|---|
| 45 | If a VM is not currently running, you can configure shared
|
|---|
| 46 | folders in the virtual machine's
|
|---|
| 47 | <b outputclass="bold">Settings</b> window.
|
|---|
| 48 | </p>
|
|---|
| 49 | </li>
|
|---|
| 50 | <li>
|
|---|
| 51 | <p>
|
|---|
| 52 | From the command line, you can create shared folders using
|
|---|
| 53 | <userinput>VBoxManage</userinput>, as follows:
|
|---|
| 54 | </p>
|
|---|
| 55 | <pre xml:space="preserve">VBoxManage sharedfolder add "VM name" --name "sharename" --hostpath "C:\test"</pre>
|
|---|
| 56 | <p> See <xref href="vboxmanage-sharedfolder.dita"/>. </p>
|
|---|
| 57 | </li>
|
|---|
| 58 | </ul>
|
|---|
| 59 | <p>
|
|---|
| 60 | There are two types of shares:
|
|---|
| 61 | </p>
|
|---|
| 62 | <ul>
|
|---|
| 63 | <li>
|
|---|
| 64 | <p>
|
|---|
| 65 | Permanent shares, that are saved with the VM settings.
|
|---|
| 66 | </p>
|
|---|
| 67 | </li>
|
|---|
| 68 | <li>
|
|---|
| 69 | <p>
|
|---|
| 70 | Transient shares, that are added at runtime and disappear when
|
|---|
| 71 | the VM is powered off. These can be created using a check box
|
|---|
| 72 | in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or by using the <codeph>--transient</codeph>
|
|---|
| 73 | option of the <userinput>VBoxManage sharedfolder add</userinput>
|
|---|
| 74 | command.
|
|---|
| 75 | </p>
|
|---|
| 76 | </li>
|
|---|
| 77 | </ul>
|
|---|
| 78 | <p>
|
|---|
| 79 | Shared folders can either be read-write or read-only. This means
|
|---|
| 80 | that the guest is either allowed to both read and write, or just
|
|---|
| 81 | read files on the host. By default, shared folders are read-write.
|
|---|
| 82 | Read-only folders can be created using a check box in the
|
|---|
| 83 | <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or with the <codeph>--readonly option</codeph> of the
|
|---|
| 84 | <userinput>VBoxManage sharedfolder add</userinput> command.
|
|---|
| 85 | </p>
|
|---|
| 86 | <p>
|
|---|
| 87 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/> shared folders also support symbolic links, also
|
|---|
| 88 | called <i>symlinks</i>, under the following
|
|---|
| 89 | conditions:
|
|---|
| 90 | </p>
|
|---|
| 91 | <ul>
|
|---|
| 92 | <li>
|
|---|
| 93 | <p>
|
|---|
| 94 | The host operating system must support symlinks. For example,
|
|---|
| 95 | a macOS, Linux, or Oracle Solaris host is required.
|
|---|
| 96 | </p>
|
|---|
| 97 | </li>
|
|---|
| 98 | <li>
|
|---|
| 99 | <p>
|
|---|
| 100 | The guest VM must have a version of the Guest Additions
|
|---|
| 101 | installed which supports symlinks. Currently only the Linux and
|
|---|
| 102 | Oracle Solaris Guest Additions support symlinks.
|
|---|
| 103 | </p>
|
|---|
| 104 | </li>
|
|---|
| 105 | <li>
|
|---|
| 106 | <p>
|
|---|
| 107 | For security reasons the guest OS is not allowed to create
|
|---|
| 108 | symlinks by default. If you trust the guest OS to not abuse
|
|---|
| 109 | this functionality, you can enable the creation of symlinks for
|
|---|
| 110 | a shared folder as follows:
|
|---|
| 111 | </p>
|
|---|
| 112 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/SharedFoldersEnableSymlinksCreate/<varname>sharename</varname> 1</pre>
|
|---|
| 113 | </li>
|
|---|
| 114 | </ul>
|
|---|
| 115 | <p>
|
|---|
| 116 | If a symbolic link is created inside a shared folder on the host
|
|---|
| 117 | and the installed Guest Additions do not support symbolic links
|
|---|
| 118 | then the guest will see the target of the symlink as a file
|
|---|
| 119 | inside the shared folder. For example, if a symlink is created
|
|---|
| 120 | to a file on a Linux host:
|
|---|
| 121 | </p>
|
|---|
| 122 | <p>
|
|---|
| 123 | <pre xml:space="preserve">$ cd /SharedFolder && ln -s filename symlink-to-filename</pre>
|
|---|
| 124 | </p>
|
|---|
| 125 | <p>
|
|---|
| 126 | When the shared folder is viewed on a Windows guest there
|
|---|
| 127 | will be two identical files listed, <userinput>filename</userinput>
|
|---|
| 128 | and <userinput>symlink-to-filename</userinput>.
|
|---|
| 129 | </p>
|
|---|
| 130 | </body>
|
|---|
| 131 |
|
|---|
| 132 |
|
|---|
| 133 | </topic>
|
|---|
