aboutsummaryrefslogtreecommitdiff
path: root/examples/darwin/README.md
diff options
context:
space:
mode:
authorRoman Melnikov2023-06-05 14:59:10 +0800
committerGitHub2023-06-05 14:59:10 +0800
commit65211db63ba1199f09b4c9f27e5eba5ec50d76ac (patch)
tree0c1b42ffc901315b8ef1671a27d48309e4ec5448 /examples/darwin/README.md
parentc80189917086e43d49eece2bd86f56813500a0eb (diff)
parent8ef5b948e308d809cb7882036007e0ef9743acc8 (diff)
Merge pull request #213 from serokell/rvem/darwin-activation
[#210] Add activation script for darwin system and provide a usage example
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