about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMichael Hoang <enzime@users.noreply.github.com>2023-07-04 20:46:42 +1000
committerMichael Hoang <enzime@users.noreply.github.com>2023-07-06 21:33:09 +1000
commitedef4868982e5a1ca3226231fb1a7eb292b4c96a (patch)
treeb71651cbc8c4dfa7ee8535d0a982bfc65f0533d8 /doc
parent34f6ce2fc2db08bf86022f47975d23e625843d2a (diff)
downloadnixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar.gz
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar.bz2
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar.lz
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar.xz
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.tar.zst
nixlib-edef4868982e5a1ca3226231fb1a7eb292b4c96a.zip
darwin.linux-builder: rename from `darwin.builder`
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/special/darwin-builder.section.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/builders/special/darwin-builder.section.md b/doc/builders/special/darwin-builder.section.md
index 7c5c38bf85ee..13d01a0e3af8 100644
--- a/doc/builders/special/darwin-builder.section.md
+++ b/doc/builders/special/darwin-builder.section.md
@@ -1,9 +1,13 @@
-# darwin.builder {#sec-darwin-builder}
+# darwin.linux-builder {#sec-darwin-builder}
 
-`darwin.builder` provides a way to bootstrap a Linux builder on a macOS machine.
+`darwin.linux-builder` provides a way to bootstrap a Linux builder on a macOS machine.
 
 This requires macOS version 12.4 or later.
 
+The builder runs on host port 31022 by default.
+You can change it by overriding `virtualisation.darwin-builder.hostPort`.
+See the [example](#sec-darwin-builder-example-flake).
+
 You will also need to be a trusted user for your Nix installation.  In other
 words, your `/etc/nix/nix.conf` should have something like:
 
@@ -14,7 +18,7 @@ extra-trusted-users = <your username goes here>
 To launch the builder, run the following flake:
 
 ```ShellSession
-$ nix run nixpkgs#darwin.builder
+$ nix run nixpkgs#darwin.linux-builder
 ```
 
 That will prompt you to enter your `sudo` password: