33Mount CephFS on Windows
44=======================
55
6- ``ceph-dokan `` is used to mount CephFS filesystems on Windows. It leverages
7- Dokany, a Windows driver that allows implementing filesystems in userspace in a
8- manner similar to FUSE.
6+ ``ceph-dokan `` is used to mount CephFS file systems on Windows. It leverages
7+ Dokany, a Windows driver that allows implementing file systems in userspace in
8+ a manner similar to FUSE.
99
1010See the `installation guide `_ to get started.
1111
@@ -16,21 +16,21 @@ See the `installation guide`_ to get started.
1616Usage
1717=====
1818
19- Mounting filesystems
20- --------------------
19+ Mounting file systems
20+ ---------------------
2121
22- Run the following command to mount a Ceph filesystem ::
22+ Run the following command to mount a Ceph file system ::
2323
2424 ceph-dokan.exe -c c:\ceph.conf -l x
2525
26- This command mounts the default Ceph filesystem using the drive letter ``x ``.
26+ This command mounts the default Ceph file system using the drive letter ``x ``.
2727If ``ceph.conf `` is present in the default location
2828(``%ProgramData%\ceph\ceph.conf ``, then this argument is optional.
2929
3030The ``-l `` argument allows the use of an empty folder as the mount point
3131instead of a drive letter.
3232
33- The uid and gid used for mounting the filesystem default to ``0 `` and can be
33+ The uid and gid used for mounting the file system default to ``0 `` and can be
3434changed using the following ``ceph.conf `` options::
3535
3636 [client]
@@ -64,35 +64,35 @@ Run ``ceph-dokan --help`` for a full list of arguments.
6464Credentials
6565-----------
6666
67- The ``--id `` option passes the name of the CephX user whose keyring
68- is used when mounting CephFS. The following commands are equivalent::
67+ The ``--id `` option passes the name of the CephX user whose keyring is used
68+ when mounting a CephFS file system . The following commands are equivalent::
6969
7070 ceph-dokan --id foo -l x
7171 ceph-dokan --name client.foo -l x
7272
73- Unmounting filesystems
74- ----------------------
73+ Unmounting file systems
74+ -----------------= -----
7575
7676The mount can be removed by either issuing ctrl-c or using the unmap command,
7777like so::
7878
7979 ceph-dokan.exe unmap -l x
8080
81- .. note :: When unmapping Ceph filesystems , you must specify the mount point
81+ .. note :: When unmapping CephFS file systems , you must specify the mount point
8282 argument that was used at the time of the creation of the mapping.
8383
8484Limitations
8585-----------
8686
8787Windows ACLs are ignored. Posix ACLs are supported but cannot be modified using
88- the current CLI. In the future, we may add some command actions that change
89- file ownership or permissions.
88+ the current CLI. In the future, we may add command actions that change file
89+ ownership or permissions.
9090
9191CephFS doesn't support mandatory file locks, which Windows relies heavily upon.
92- Ceph relies upon Dokan to handle file locks, which are only enforced locally.
92+ Ceph relies upon Dokan to handle file locks, which are enforced only locally.
9393
94- Unlike ``rbd-wnbd ``, ``ceph-dokan `` doesn't provide a ``service `` command. To
95- make a CephFS mount survive host reboots, use ``NSSM ``.
94+ Unlike ``rbd-wnbd ``, ``ceph-dokan `` doesn't provide a ``service `` command. To
95+ ensure that a CephFS mount survives reboots of its host , use ``NSSM ``.
9696
9797Troubleshooting
9898===============
0 commit comments