aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornotgne22020-10-10 10:42:14 -0700
committernotgne22020-10-10 10:42:14 -0700
commit867438bfc011e63b633b9d6fa2b0edb3367ea253 (patch)
tree75398914214e129a05d19b256289984e0fa085f8
parent4a2b677e892845b121d353864d54aec92a411e48 (diff)
Document `profilePath` option
-rw-r--r--README.md3
-rw-r--r--interface/README.md1
2 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2710183..cbc312d 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,9 @@ This is the core of how `deploy-rs` was designed, any number of these can run on
# For ease of use, `deploy-rs` provides a function to easy all this required activation script to any derivation
path = deploy-rs.lib.x86_64-linux.setActivate pkgs.hello "./bin/hello";
+ # An optional path to where your profile should be installed to, this is useful if you want to use a common profile name across multiple users, but would have conflicts in your node's profile list.
+ profilePath = "/nix/var/nix/profiles/per-user/someuser/someprofile";
+
# ...generic options... (see lower section)
}
```
diff --git a/interface/README.md b/interface/README.md
index bfca01e..99afeb2 100644
--- a/interface/README.md
+++ b/interface/README.md
@@ -12,6 +12,7 @@ deploy
│   ├── <PROFILE>
│   │   ├── <generic args>
│   │   ├── bootstrap
+ │   │   ├── profilePath
│   │   └── path
│   └── <PROFILE>...
└── <NODE>...