aboutsummaryrefslogtreecommitdiff
path: root/examples/darwin/README.md
diff options
context:
space:
mode:
authorRoman Melnikov2023-05-11 11:58:02 +0800
committerRoman Melnikov2023-05-11 16:02:01 +0800
commitf4062956807a0a9703de166ac4a160a7aca1133c (patch)
tree43b5f3b6fa3889475c38769fc4186add2efa92ec /examples/darwin/README.md
parent64160276cd6569694131ed8864d4d35470a84ec3 (diff)
[#210] Add activation script for darwin system and provide a usage example
Problem: It's possible to use 'deploy-rs' for deploying 'darwinSystem' configuration from 'nix-darwin' to a darwin system. However, there is no dedicated activatiot script for darwin and thus one has to come up with 'custom' activation script. Solution: 1) Add 'darwin' attribute to 'lib.activate' that provides a script that should be used to activate 'darwinSystem' config with 'deploy-rs'. 2) Add a new 'examples/darwin' example that provides simple flake for deploying configuration to a darwin target.
Diffstat (limited to 'examples/darwin/README.md')
-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