VirtualBox

Changeset 75472 in vbox


Ignore:
Timestamp:
Nov 15, 2018 12:35:21 AM (6 years ago)
Author:
vboxsync
Message:

manual: shared folder automounting adjustments, ++. bugref:3544

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_GuestAdditions.xml

    r73276 r75472  
    11821182
    11831183    <para>
    1184       With the <emphasis>shared folders</emphasis> feature of
    1185       VirtualBox, you can access files of your host system from within
    1186       the guest system. This is similar how you would use network shares
    1187       in Windows networks, except that shared folders do not need
    1188       require networking, only the Guest Additions. Shared Folders are
    1189       supported with Windows 2000 or later, Linux, and Solaris guests.
    1190     </para>
    1191 
    1192     <para>
    1193       Shared folders must physically reside on the
    1194       <emphasis>host</emphasis> and are then shared with the guest,
    1195       which uses a special file system driver in the Guest Addition to
    1196       talk to the host. For Windows guests, shared folders are
    1197       implemented as a pseudo-network redirector. For Linux and Solaris
    1198       guests, the Guest Additions provide a virtual file system.
     1184      With the <emphasis>shared folders</emphasis> feature of VirtualBox, you
     1185      can access files of your host system from within the guest system. This
     1186      is similar how you would use network shares in Windows networks, except
     1187      that shared folders do not require networking, only the Guest Additions.
     1188      Shared Folders are supported with Windows 2000 or later, Linux, and
     1189      Solaris guests.  (There are also experimental support for Mac OS X and
     1190      OS/2 guests shipping with VirtualBox 6.0.)
     1191    </para>
     1192
     1193    <para>
     1194      Shared folders physically reside on the <emphasis>host</emphasis> and are
     1195      then shared with the guest, which uses a special file system driver in
     1196      the Guest Addition to talk to the host.  For Windows guests, shared
     1197      folders are implemented as a pseudo-network redirector.  For Linux and
     1198      Solaris guests, the Guest Additions provide a virtual file system.
    11991199    </para>
    12001200
    12011201    <para>
    12021202      To share a host folder with a virtual machine in VirtualBox, you
    1203       must specify the path of that folder and choose for it a
    1204       <emphasis>share nam</emphasis>e that the guest can use to access
    1205       it. Hence, first create the shared folder on the host. Then,
    1206       within the guest, you can connect to it.
     1203      must specify the path of that folder and choose a <emphasis>share name</emphasis>
     1204      for it.  This happens on the host.   In the guest you then uses the name
     1205      connect to it and access the files.
    12071206    </para>
    12081207
    12091208    <para>
    12101209      There are several ways in which shared folders can be set up for a
    1211       particular virtual machine:
     1210      virtual machine:
    12121211    </para>
    12131212
    … …  
    12261225        <para>
    12271226          If a VM is not currently running, you can configure shared
    1228           folders in each virtual machine's Settings dialog.
     1227          folders in the virtual machine's Settings dialog.
    12291228        </para>
    12301229      </listitem>
    … …  
    12531252      <listitem>
    12541253        <para>
    1255           VM shares which are only available to the VM for which they
    1256           have been defined.
     1254          Permanent shares that are saved with the VM settings.
    12571255        </para>
    12581256      </listitem>
    … …  
    12601258      <listitem>
    12611259        <para>
    1262           Transient VM shares, which can be added and removed at runtime
    1263           and do not persist after a VM has stopped. For these, add the
    1264           <computeroutput>--transient</computeroutput> option to the
    1265           above command line.
     1260          Transient shares that are added at runtime and disappear when the VM
     1261          is powered off.  There is a checkbox for this in the GUI and
     1262          VBoxManage has a <computeroutput>--transient</computeroutput> option
     1263          for it.
    12661264        </para>
    12671265      </listitem>
    … …  
    12701268
    12711269    <para>
    1272       Shared folders have read/write access to the files at the host
    1273       path by default. To restrict the guest to have read-only access,
    1274       create a read-only shared folder. This can either be achieved
    1275       using the GUI or by appending the parameter
    1276       <computeroutput>--readonly</computeroutput> when creating the
    1277       shared folder with VBoxManage.
     1270      Shared folders can either be read-write or read-only, meaning the guest
     1271      is either allowed to both read and write or just read files on the host.
     1272      There is a checkbox for read-only in the GUI, default being read-write,
     1273      and similarly a <computeroutput>--readonly</computeroutput> option for
     1274      VBoxManage.
    12781275    </para>
    12791276
    … …  
    14391436        </listitem>
    14401437
     1438        <listitem>
     1439          <para>
     1440            In an OS/2 guest, use VBoxControl to manage shared folders:
     1441          </para>
     1442
     1443<screen>VBoxControl sharedfolder use D: MyShareName
     1444VBoxControl sharedfolder unuse D:
     1445VBoxControl sharedfolder list</screen>
     1446
     1447          <para>Like for Windows guests, shared folders can also be accessed via
     1448            UNC using <computeroutput>\\VBoxSF\</computeroutput>,
     1449            <computeroutput>\\VBoxSvr\</computeroutput> or
     1450            <computeroutput>\\VBoxSrv\</computeroutput> as the server name and
     1451            the shared folder name as share.
     1452          </para>
     1453        </listitem>
     1454
    14411455      </itemizedlist>
    14421456
    … …  
    14481462
    14491463      <para>
    1450         Starting with version 4.0, VirtualBox provides the option to
    1451         mount shared folders automatically If automatic mounting is
    1452         enabled for a specific shared folder, the Guest Additions will
    1453         automatically mount that folder as soon as a user logs in to the
    1454         guest OS. The details depend on the guest OS type, as follows:
    1455       </para>
     1464        VirtualBox provides the option to mount shared folders
     1465        automatically.   When automatic mounting is enabled for a shared
     1466        folder, the guest additions service will mount it for you.  A
     1467        preferred drive letter (Windows, OS/2) or mount point directory
     1468        (Linux, Solaris) can also be specified if desired.</para>
     1469
     1470      <para>
     1471        When no drive letter or mount point is given, or should it be
     1472        in use already, an alternative location will be found
     1473
     1474        the service will search for an alternative
     1475        location depending on the guest OS:</para>
    14561476
    14571477      <itemizedlist>
    … …  
    14591479        <listitem>
    14601480          <para>
    1461             <emphasis role="bold">Windows guests.</emphasis> Any
    1462             auto-mounted shared folder will receive its own drive
    1463             letter, such as <computeroutput>E:</computeroutput>,
    1464             depending on the free drive letters remaining in the guest.
    1465           </para>
    1466 
    1467           <para>
    1468             If there are no free drive letters left, auto-mounting will
    1469             fail. As a result, the number of auto-mounted shared folders
    1470             is typically limited to 22 or less with Windows guests.
    1471           </para>
    1472         </listitem>
    1473 
    1474         <listitem>
    1475           <para>
    1476             <emphasis role="bold">Linux guests.</emphasis> Auto-mounted
    1477             shared folders are mounted into the
    1478             <computeroutput>/media</computeroutput> directory, along
    1479             with the prefix <computeroutput>sf_</computeroutput>. For
    1480             example, the shared folder
    1481             <computeroutput>myfiles</computeroutput> would be mounted to
    1482             <computeroutput>/media/sf_myfiles</computeroutput> on Linux
    1483             and <computeroutput>/mnt/sf_myfiles</computeroutput> on
    1484             Solaris.
    1485           </para>
    1486 
    1487           <para>
    1488             The guest property
     1481            <emphasis role="bold">Windows and OS/2 guests:</emphasis>
     1482            Search for a free drive letter starting at
     1483            <computeroutput>Z:</computeroutput>.  If all drive letter are
     1484            assigned, the folder will not be mounted.
     1485          </para>
     1486        </listitem>
     1487
     1488        <listitem>
     1489          <para>
     1490            <emphasis role="bold">Linux and Solaris guests:</emphasis>
     1491            Folders are mounted under the <computeroutput>/media</computeroutput>
     1492            directory on Linux and <computeroutput>/mnt</computeroutput> on
     1493            Solaris.  The folder name is normalized (no spaces, slashes,
     1494            colons) and prefixed with <computeroutput>sf_</computeroutput>.
     1495            Say you have a shared folder called <computeroutput>myfiles</computeroutput>
     1496            it will appear as <computeroutput>/media/sf_myfiles</computeroutput>
     1497            in a Linux guest and <computeroutput>/mnt/sf_myfiles</computeroutput>
     1498            in a Solaris one.
     1499          </para>
     1500
     1501          <para>
     1502            The guest properties
     1503            <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput> and
    14891504            <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput>
    1490             determines the prefix that is used. Change that guest
    1491             property to a value other than
    1492             <computeroutput>sf</computeroutput> to use another prefix.
    1493             See <xref
    1494             linkend="guestadd-guestprops" />.
    1495           </para>
    1496 
    1497           <note>
    1498             <para>
    1499               Access to auto-mounted shared folders is only granted to
    1500               the user group <computeroutput>vboxsf</computeroutput>,
    1501               which is created by the VirtualBox Guest Additions
    1502               installer. Therefore, guest users have to be member of
    1503               that group to have read/write access, or to have read-only
    1504               access if the folder is not mapped writable.
    1505             </para>
    1506           </note>
    1507 
    1508           <para>
    1509             To change the mount directory to something other than
    1510             <computeroutput>/media</computeroutput>, you can set the
    1511             guest property
    1512             <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput>.
    1513           </para>
    1514         </listitem>
    1515 
    1516         <listitem>
    1517           <para>
    1518             <emphasis role="bold">Solaris guests</emphasis> behave like
    1519             Linux guests, except that
    1520             <computeroutput>/mnt</computeroutput> is used as the default
    1521             mount directory instead of
    1522             <computeroutput>/media</computeroutput>.
    1523           </para>
    1524         </listitem>
    1525 
     1505            can be used override the automatic mount directory and prefix.
     1506            See <xref linkend="guestadd-guestprops" />.
     1507          </para>
     1508
     1509        </listitem>
    15261510      </itemizedlist>
    15271511
    15281512      <para>
    1529         To have any changes to auto-mounted shared folders applied while
    1530         a VM is running, the guest OS needs to be rebooted. This applies
    1531         only to auto-mounted shared folders, not the ones which are
    1532         mounted manually.
     1513        Access to an automatically mounted shared folder is granted to everyone
     1514        in a Windows guest, that includes the Guest user.  For Linux and Solaris
     1515        guests the access is restricted to members of the group
     1516        <computeroutput>vboxsf</computeroutput> and <computeroutput>root</computeroutput>.
    15331517      </para>
    15341518
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette