summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Sidhion <DanielSidhion@users.noreply.github.com>2024-02-28 06:37:18 -0800
committerGitHub <noreply@github.com>2024-02-28 06:37:18 -0800
commit3ef3dbe6d5f83ae27cbfcfe87c347312fd9ee969 (patch)
tree99e395dac0fd6de1765f9baf25e83d7b06126ed0
parent267735f78557938ec607e04d966dbac83a5a19bf (diff)
parentfced1344428dc341ef8b248e5b38b771feaca07a (diff)
Merge pull request #291715 from DanielSidhion/document-private-key
doc: document publicly-known private key for darwin.linux-builder
-rw-r--r--doc/packages/darwin-builder.section.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/packages/darwin-builder.section.md b/doc/packages/darwin-builder.section.md
index 788cd6da750e..3a547de53705 100644
--- a/doc/packages/darwin-builder.section.md
+++ b/doc/packages/darwin-builder.section.md
@@ -1,5 +1,12 @@
# darwin.linux-builder {#sec-darwin-builder}
+:::{.warning}
+By default, `darwin.linux-builder` uses a publicly-known private SSH **host key** (this is different from the SSH key used by the user that connects to the builder).
+
+Given the intended use case for it (a Linux builder that runs **on the same machine**), this shouldn't be an issue.
+However, if you plan to deviate from this use case in any way (e.g. by exposing this builder to remote machines), you should understand the security implications of doing so and take any appropriate measures.
+:::
+
`darwin.linux-builder` provides a way to bootstrap a Linux remote builder on a macOS machine.
This requires macOS version 12.4 or later.