NTFS: Difference between revisions

(17 intermediate revisions by 11 users not shown)

Line 1:

~~== Enable~~ NTFS ~~support ==~~

New Technology File System (NTFS) is a proprietary journaling [[Filesystems|file system]] developed by Microsoft. It is still in use by modern Windows systems, although NTFS has not evolved since the release of version 3.1 in 2001.

~~<syntaxHighlight lang=nix>~~

~~boot.supportedFilesystems =~~ [ ~~"ntfs"~~ ];

~~</syntaxHighlight>~~

~~NixOS uses~~ NTFS-~~3G for NTFS support~~.

== Mount NTFS filesystem on boot ==

Using [[nixos-generate-config]] to automatically generate Nix config is the recommended way to setup filesystems.

1. Run {{ic|lsblk}} to list device names.

sd...

└─sdX

</syntaxhighlight>

2. Mount the device using [https://man7.org/linux/man-pages/man8/mount.8.html {{ic|mount}}], where {{ic|/dev/sdX}} replaced with your device name and {{ic|/mnt/sdX}} replaced with an existing folder path to mount your drive.

$ mount /dev/sdX /mnt/sdX -t ntfs3 -o uid=$UID

</syntaxhighlight>

3. Run {{ic|nixos-generate-config --dir .}} to generate hardware configuration. This will automatically add all currently mounted devices to {{ic|hardware-configuration.nix}}.

{{file|/etc/nixos/hardware-configuration.nix|diff|3=

+ boot.supportedFilesystems = [ "ntfs" ];

+ fileSystems."/mnt/sdX" = {

+ device = "/dev/disk/by-uuid/F258FB9E58FB5FB1";

+ fsType = "ntfs3";

+ };

}}

4. Add {{ic|<nowiki>"uid=$UID"</nowiki>}} to {{nixos:option|fileSystems.*.options|fileSystems.<name>.options}} to get write access, where {{ic|<nowiki>$UID</nowiki>}} replaced with your UID:

{{file|/etc/nixos/configuration.nix|nix|3=

fileSystems =

let

ntfs-drives = [

"/mnt/sdX"

];

in

lib.genAttrs ntfs-drives (path: {

options = [

"uid=$UID" # REPLACE "$UID" WITH YOUR ACTUAL UID!

# "nofail"

];

});

}}

{{note|You may find your UID by running {{ic|echo $UID}}.}}

{{aside|It is not recommended to manually edit {{ic|hardware-configuration.nix}}.}}

5. {{evaluate}}

== Troubleshooting ==

Line 14:

Line 50:

To verify:

<~~pre~~>

journalctl -b0 | grep -i "The disk contains an unclean file system"

$ journalctl -b0 | grep -i "The disk contains an unclean file system"

</~~pre~~>

</syntaxhighlight>

It should return a similar message to what follows:

<~~pre~~>

The disk contains an unclean file system (0,0). Metadata

kept in Windows cache, refused to mount. Falling back to

Line 26:

Line 62:

state. Please resume and shutdown Windows fully (no

hibernation or fast restarting.)

</~~pre~~>

</syntaxhighlight>

If you have shutdown Windows fully, and not used hibernation, it may be caused by the fast startup or fast boot feature of Windows. It has been reported that major Windows updates may reset this setting to on.

[https://social.technet.microsoft.com/wiki/contents/articles/25908.fast-startup-how-to-disable-if-it-s-causing-problems.aspx This TechNet entry] explains how to disable fast startup. Additionally, [https://www.howtogeek.com/243901/the-pros-and-cons-of-windows-10s-fast-startup-mode/ this blog post on howtogeek.com] explains ~~what is~~ the fast startup mode, and how to disable it.

[https://social.technet.microsoft.com/wiki/contents/articles/25908.fast-startup-how-to-disable-if-it-s-causing-problems.aspx This TechNet entry] explains how to disable fast startup. Additionally, [https://www.howtogeek.com/243901/the-pros-and-cons-of-windows-10s-fast-startup-mode/ this blog post on howtogeek.com] explains how the fast startup mode works, and how to disable it.

=== Unable to mount ntfs3 with dirty volume ===

When attempting to mount an <code>NTFS</code> partition using the <code>ntfs3</code> filesystem driver via the {{nixos:package|ntfs3g}} package, the mount operation may fail:

# mount /dev/sda1 /mnt -t ntfs3

mount: /mnt: wrong fs type, bad option, bad superblock on /dev/sda1, missing codepage or helper program, or other error.

dmesg(1) may have more information after failed mount system call.

</syntaxhighlight>

With the resulting dmesg output:

# dmesg

...

[168659.819978] ntfs3: sda1: It is recommened to use chkdsk.

[168659.820833] ntfs3: sda1: volume is dirty and "force" flag is not set!

</syntaxhighlight>

This indicates that the NTFS volume has the “dirty” flag set. In this state, the <code>ntfs3</code> driver refuses to mount the filesystem.

To clear the dirty flag, run <code>ntfsfix</code> on the affected partition:

# ntfsfix --clear-dirty /dev/sda1

</syntaxhighlight>

If <code>ntfsfix</code> fails with an error <code>Windows is hibernated, refused to mount</code>, the partition can be mounted using <code>ntfs-3g</code> with the hibernation file removed:

# ntfs-3g -o remove_hiberfile /dev/sda1 /mnt

</syntaxhighlight>

[[Category:Filesystem]]

@@ Line 1: / Line 1: @@
-== Enable NTFS support ==
+New Technology File System (NTFS) is a proprietary journaling [[Filesystems|file system]] developed by Microsoft. It is still in use by modern Windows systems, although NTFS has not evolved since the release of version 3.1 in 2001.
-<syntaxHighlight lang=nix>
-boot.supportedFilesystems = [ "ntfs" ];
-</syntaxHighlight>
-NixOS uses NTFS-3G for NTFS support.
+== Mount NTFS filesystem on boot ==
+Using [[nixos-generate-config]] to automatically generate Nix config is the recommended way to setup filesystems.
+. Run {{ic|lsblk}} to list device names.
+<syntaxhighlight lang=console>
+sd...
+└─sdX
+</syntaxhighlight>
+. Mount the device using [https://man7.org/linux/man-pages/man8/mount.8.html {{ic|mount}}], where {{ic|/dev/sdX}} replaced with your device name and {{ic|/mnt/sdX}} replaced with an existing folder path to mount your drive.
+<syntaxhighlight lang=console>
+$ mount /dev/sdX /mnt/sdX -t ntfs3 -o uid=$UID
+</syntaxhighlight>
+. Run {{ic|nixos-generate-config --dir .}} to generate hardware configuration. This will <strong>automatically</strong> add all currently mounted devices to {{ic|hardware-configuration.nix}}.
+{{file|/etc/nixos/hardware-configuration.nix|diff|3=
++  boot.supportedFilesystems = [ "ntfs" ];
++  fileSystems."/mnt/sdX" = {
++    device = "/dev/disk/by-uuid/F258FB9E58FB5FB1";
++    fsType = "ntfs3";
++  };
+}}
+. Add {{ic|<nowiki>"uid=$UID"</nowiki>}} to {{nixos:option|fileSystems.*.options|fileSystems.<name>.options}} to get write access, where {{ic|<nowiki>$UID</nowiki>}} <strong>replaced with your UID</strong>:
+{{file|/etc/nixos/configuration.nix|nix|3=
+fileSystems =
+  let
+    ntfs-drives = [
+      "/mnt/sdX"
+    ];
+  in
+  lib.genAttrs ntfs-drives (path: {
+    options = [
+      "uid=$UID" # REPLACE "$UID" WITH YOUR ACTUAL UID!
+      # "nofail"
+    ];
+  });
+}}
+{{note|You may find your UID by running {{ic|echo $UID}}.}}
+{{aside|It is not recommended to manually edit {{ic|hardware-configuration.nix}}.}}
+. {{evaluate}}
 == Troubleshooting ==
@@ Line 14: / Line 50: @@
 To verify:
-<pre>
+<syntaxhighlight lang=console>
-journalctl -b0 | grep -i "The disk contains an unclean file system"
+$ journalctl -b0 | grep -i "The disk contains an unclean file system"
-</pre>
+</syntaxhighlight>
 It should return a similar message to what follows:
-<pre>
+<syntaxhighlight lang=console>
 The disk contains an unclean file system (0,0). Metadata
 kept in Windows cache, refused to mount. Falling back to
@@ Line 26: / Line 62: @@
 state. Please resume and shutdown Windows fully (no
 hibernation or fast restarting.)
-</pre>
+</syntaxhighlight>
 If you have shutdown Windows fully, and not used hibernation, it may be caused by the <em>fast startup</em> or <em>fast boot</em> feature of Windows. It has been reported that major Windows updates may reset this setting to <strong>on</strong>.
-[https://social.technet.microsoft.com/wiki/contents/articles/25908.fast-startup-how-to-disable-if-it-s-causing-problems.aspx This TechNet entry] explains how to disable fast startup. Additionally, [https://www.howtogeek.com/243901/the-pros-and-cons-of-windows-10s-fast-startup-mode/ this blog post on howtogeek.com] explains what is the fast startup mode, and how to disable it.
+[https://social.technet.microsoft.com/wiki/contents/articles/25908.fast-startup-how-to-disable-if-it-s-causing-problems.aspx This TechNet entry] explains how to disable fast startup. Additionally, [https://www.howtogeek.com/243901/the-pros-and-cons-of-windows-10s-fast-startup-mode/ this blog post on howtogeek.com] explains how the fast startup mode works, and how to disable it.
+=== Unable to mount ntfs3 with dirty volume ===
+When attempting to mount an <code>NTFS</code> partition using the <code>ntfs3</code> filesystem driver via the {{nixos:package|ntfs3g}} package, the mount operation may fail:
+<syntaxhighlight lang="console">
+# mount /dev/sda1 /mnt -t ntfs3
+mount: /mnt: wrong fs type, bad option, bad superblock on /dev/sda1, missing codepage or helper program, or other error.
+       dmesg(1) may have more information after failed mount system call.
+</syntaxhighlight>
+With the resulting dmesg output:
+<syntaxhighlight lang="console">
+# dmesg
+...
+[168659.819978] ntfs3: sda1: It is recommened to use chkdsk.
+[168659.820833] ntfs3: sda1: volume is dirty and "force" flag is not set!
+</syntaxhighlight>
+This indicates that the NTFS volume has the “dirty” flag set. In this state, the <code>ntfs3</code> driver refuses to mount the filesystem.
+To clear the dirty flag, run <code>ntfsfix</code> on the affected partition:
+<syntaxhighlight lang="console">
+# ntfsfix --clear-dirty /dev/sda1
+</syntaxhighlight>
+If <code>ntfsfix</code> fails with an error <code>Windows is hibernated, refused to mount</code>, the partition can be mounted using <code>ntfs-3g</code> with the hibernation file removed:
+<syntaxhighlight lang="console">
+# ntfs-3g -o remove_hiberfile /dev/sda1 /mnt
+</syntaxhighlight>
+[[Category:Filesystem]]