aboutsummaryrefslogtreecommitdiff
path: root/examples/darwin/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--examples/darwin/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/darwin/README.md b/examples/darwin/README.md
new file mode 100644
index 0000000..b377ce8
--- /dev/null
+++ b/examples/darwin/README.md
@@ -0,0 +1,19 @@
+<!--
+SPDX-FileCopyrightText: 2023 Serokell <https://serokell.io/>
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
+# Example nix-darwin system deployment
+
+## Prerequisites
+
+1) Install `nix` and `nix-darwin` (the latter creates `/run` sets up `/etc/nix/nix.conf` symlink and so on)
+ on the target machine.
+2) Enable remote login on the mac to allow ssh access.
+3) `deploy-rs` doesn't support password provisioning for `sudo`, so the `sshUser` should
+ have passwordless `sudo` access.
+
+## Deploying
+
+Run `nix run github:serokell/deploy-rs -- --ssh-user <user>`. \ No newline at end of file