summary refs log tree commit diff
path: root/doc/functions/prefer-remote-fetch.section.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/prefer-remote-fetch.section.md')
-rw-r--r--doc/functions/prefer-remote-fetch.section.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/functions/prefer-remote-fetch.section.md b/doc/functions/prefer-remote-fetch.section.md
new file mode 100644
index 00000000000..8760c100224
--- /dev/null
+++ b/doc/functions/prefer-remote-fetch.section.md
@@ -0,0 +1,17 @@
+# prefer-remote-fetch overlay {#sec-prefer-remote-fetch}
+
+`prefer-remote-fetch` is an overlay that download sources on remote builder. This is useful when the evaluating machine has a slow upload while the builder can fetch faster directly from the source. To use it, put the following snippet as a new overlay:
+
+```nix
+self: super:
+  (super.prefer-remote-fetch self super)
+```
+
+A full configuration example for that sets the overlay up for your own account, could look like this
+
+```ShellSession
+$ mkdir ~/.config/nixpkgs/overlays/
+$ cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF
+  self: super: super.prefer-remote-fetch self super
+EOF
+```